docsifyを使用してドキュメントを構築する

一、構築#

docsify は、vuepress や gitbook などの静的ドキュメントプログラムに似ていますが、個人的には docsify のスタイルとソースコードが好きです。余分な機能は必要ありませんが、記事の作成と目次の機能があれば十分です。

デモを見るには、ここをクリックしてください。

ターミナルを開き、次のコマンドを入力してローカル環境をセットアップします：

npm install docsify-cli -g

ドキュメントを初期化します：

docsify init ./docs

ローカルで実行します：

docs serve

その後、ブラウザで localhost:3000 を開いて表示できます。

二、ページ#

私が考える基本的なページは 3 つです

_navbar.md

ナビゲーションバー

* [について](/)

次に、index.html で呼び出します。

window.$docsify = {
    ...
    loadNavbar: true,
    ...
}

画像：

_sidebar.md

サイドバー

* [docsifyを使用してドキュメントを構築する](基于docsify搭建一个文档.md)

index.html で呼び出します。

window.$docsify = {
    ...
    loadSidebar: true,
    ...
}

画像：

README.md

ホームページ

## about

ブログのアドレス：[https://imhan.cn](https://imhan.cn)

著者：shuxhan

日付：2021.04.20

このドキュメントはブログの記事のバックアップとして使用されます。記事に関する他のコメントがある場合は、リンクをクリックして元のアドレスに移動できます。

画像：