docsify-ドキュメントを迅速に生成するWebサイトを構築する必要はありません

5072 ワード

javascript httml 5 html github

docsify
ドキュメントの迅速な生成ページを構築する必要はありません
Webサイト:https://github.com/qingwei-li...ドキュメント:https://docsify.js.org/zh-cn
とくせい

構築する必要はなく、markdownを書き終わったら

を直接公開します.

は、カスタムトピック

をサポートします.

使いやすく軽量

クイックハンド
プロジェクトの作成
空のプロジェクトを新規作成し、docsディレクトリを作成しdocsディレクトリの下に進みます.

mkdir my-project && cd my-project
mkdir docs && cd docs

エントリファイルの作成404.htmlファイルを作成します.

README.mdファイルをホームページとして

# Title

## balabala

!
プロジェクトpushをGitHub にいた、ページにいてGitHub Pages をき、docs/オプションをする
コマンドラインツール
ドキュメントディレクトリのなをにし、プロジェクトのpackage.jsonのオプションをdocsifyのとしてみり、ローカルプレビューをサポートします.
インストール

npm i docsify-cli -g

の
デフォルトのはのディレクトリにあり、docsディレクトリのにドキュメントをすることをします.

docsify init docs

ローカルサービスの
サーバをしてプレビューをにし、くhttp://localhost:3000

docsify serve docs

はdocsify-cliを
テーマ
vueがされています.cssとbuble.css、404.htmlのcdnアドレスをすればいいです

そのの
ページREADME.mdはホームページとして、のページがであれば、する*.mdファイルをドキュメントディレクトリのにし、えばguide.mdをすると、するルーティングは/guideである.
ツールバーの
ナビゲーションは404.htmlファイルにでくがあります. はをしてください.

En

パラメータ
repo
のにあるGitHubアイコンをに、くは404.htmlのscriptを

max-level
ディレクトリのレベル( は6)

el
ノードをきえます.デフォルトは#appです.

sidebar-toggle
Sidebarスイッチボタン

sidebar
TOC はできなくなり、くのドキュメントをナビゲートするのにしており、data-sidebarはグローバルをします.


  window.sidebar = [
    { slug: '/', title: 'Home' },
    {
      slug: '/pageA',
      title: 'page A',
      children: [
        { slug: '/pageA/childrenB', title: 'children B' }
      ]
    },
    { slug: '/PageC', title: 'Page C' }
  ]

load-sidebar
サイドバープロファイルをみみます. されている、のディレクトリの_sidebar.mdがデフォルトでロードされます.ファイルがしないは、TOCがサイドバーとしてされます.2 ディレクトリがあるは、プロファイルもするがあります.

サイドバーファイルをできます

_sidebar.mdのは、このようなものであってもよい

- [Home](/)
- [Installation](/installation)
- Essentials
  - [Getting Started](/getting-started)
  - [Dynamic Route Matching](/dynamic-matching)
  - [Nested Routes](/nested-routes)
  - [Programmatic Navigation](/navigation)
  - [Named Routes](/named-routes)
  - [Named Views](/named-views)
  - [Redirect and Alias](/redirect-and-alias)
  - [HTML5 History Mode](/history-mode)

load-navbar
ナビゲーションプロファイルをみみます. されているは、のディレクトリの_navbar.mdがデフォルトでロードされます.ファイルがしないはhtmlでされたナビゲーションバーがされます.

ナビゲーションバーのファイルをできます

_navbar.mdのは、このようにすることができる.

- [en](/)
- [  ](/zh-cn)

もちろん2 リストもサポートされており、ドロップダウンリストがされます

- [download](/download)
- language
  - [en](/)
  - [  ](/zh-cn)

FAQ
なぜ404.htmlでindex.htmlをわないのか
docsifyがしたいのは、もなでコンテンツをにレンダリングすることです.
えば、README.mdとguide.mdの2つのドキュメントがあります.index.htmlをファイルとしてすると、README.mdはトップページファイルとしてされているため、しくレンダリングできます.しかし、my-domain.com/guideがたいがguide.mdのコンテンツにアクセスすると、しません.ディレクトリのにguide.htmlのファイルがしないためです.
しかしGitHub Pagesサーバはリソースがつからず、404.htmlファイルをロールバックしてレンダリングします.
Webサイト:https://github.com/qingwei-li...ドキュメント:https://docsify.js.org/zh-cn