Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 2.7 KB

more-pages.md

File metadata and controls

95 lines (66 loc) · 2.7 KB

More pages

If you need more pages, you can simply create more markdown files in your docsify directory. If you create a file named guide.md, then it is accessible via /#/guide.

For example, the directory structure is as follows:

.
└── docs
    ├── README.md
    ├── guide.md
    └── zh-cn
        ├── README.md
        └── guide.md

Matching routes

docs/README.md        => http://domain.com
docs/guide.md         => http://domain.com/guide
docs/zh-cn/README.md  => http://domain.com/zh-cn/
docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide

Sidebar

In order to have sidebar, then you can create your own _sidebar.md (see this documentation's sidebar for an example):

First, you need to set loadSidebar to true. Details are available in the configuration paragraph.

<!-- index.html -->

<script>
  window.$docsify = {
    loadSidebar: true
  }
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

Create the _sidebar.md:

<!-- docs/_sidebar.md -->

- [Home](/)
- [Guide](guide.md)

You need to create a .nojekyll in ./docs to prevent GitHub Pages from ignoring files that begin with an underscore.

_sidebar.md is loaded from each level directory. If the current directory doesn't have _sidebar.md, it will fall back to the parent directory. If, for example, the current path is /guide/quick-start, the _sidebar.md will be loaded from /guide/_sidebar.md.

Table of Contents

Once you've created _sidebar.md, the sidebar content is automatically generated based on the headers in the markdown files.

A custom sidebar can also automatically generate a table of contents by setting a subMaxLevel, compare sub-max-level configuration.

<!-- index.html -->

<script>
  window.$docsify = {
    loadSidebar: true,
    subMaxLevel: 2
  }
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

Ignoring Subheaders

When subMaxLevel is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add {docsify-ignore} to it.

# Getting Started

## Header {docsify-ignore}
This header won't appear in the sidebar table of contents.

To ignore all headers on a specific page, you can use {docsify-ignore-all} on the first header of the page.

# Getting Started {docsify-ignore-all}

## Header
This header won't appear in the sidebar table of contents.

Both {docsify-ignore} and {docsify-ignore-all} will not be rendered on the page when used.