Docsify themeable – A delightfully simple theme system for docsify. Js jhildenbiddle. Making. IO/docsify – the…

Quick Start

Installation

  1. Create a docsify site by following the instructions on the docsify.js website.

  2. Select a theme from the Themes section and replace the <link> in your index.html.

    <! -- Theme: Simple (latest v0.x.x) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
Copy the code

  3. Add the docsify-themeable plugin to your index.html after docsify:

    <! -- docsify-themeable (latest v0.x.x) -->
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
Copy the code

  4. Review the Options section and configure as needed. For example:

    <script>
  window.$docsify = {
      // ...
      themeable: {
          readyTransition : true.// default
          responsiveTables: true  // default}}</script>
Copy the code

  5. Review the Customization section and set theme properties as needed. For example:

    <style>
  :root {
    /* Reduce the font size */
    --base-font-size: 14px;

    /* Change the theme color hue */
    --theme-hue: 325;

    /* Change the sidebar bullets */
    --sidebar-nav-link-before-content: '😀';
  }
</style>
Copy the code

Local Preview

Previewing your site locally requires serving your files from a web server.

The docsify Quick Start guide recommends docsify-cli for creating and previewing your site:

# Install docsify-cli globally
npm install -g docsify-cli

# Serve current directory
docsify serve

# Serve ./docs directory
docsify serve docs
Copy the code

A simple Python web server can also be used:

# Change to site directory
cd /path/to/site/files

# Show Python version
python --version

# Launch web server (Python 2.x)
python -m SimpleHTTPServer

# Launch web server (Python 3.x)
python -m http.server
Copy the code

Hosting

Sites powered by docsify.js can be hosted on any web server. The docsify website provides a helpful deployment guide with tips for hosting your site on following platforms:

  • GitHub Pages
  • GitLab Pages
  • Firebase Hosting
  • Virtual Private Server (VPS)

Subject to recommend

Docsify-share uses the theme coroo.github. IO/Docsify-sha…

<! -- docsify-themeable styles--> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css" title="light"> <link rel="stylesheet" href="assets/css/main-custom.css"> <link rel="stylesheet" href="assets/css/button-custom.css"> <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>Copy the code