zishu's blog

zishu's blog

一个热爱生活的博主。https://zishu.me

docsifyを基にしたドキュメントを構築する

一、構築#

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

デモをクリックして確認してください。

ターミナルを開いてコマンドを入力し、ローカル環境を構築します:

npm install docsify-cli -g

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

docsify init ./docs

ローカルで実行します:

docs serve

その後、ブラウザで localhost:3000 を開くと確認できます。

二、ページ#

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

  1. _navbar.md

ナビゲーションバー

* [について](/)

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

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

図のように:

image

  1. _sidebar.md

サイドバー

* [docsifyを基にしたドキュメントの構築](基于docsify搭建一个文档.md)

index.html で呼び出します。

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

図のように:

image

  1. README.md

ホームページ

## about

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

著者:shuxhan

日時:2021.04.20

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

図のように:

image

読み込み中...
文章は、創作者によって署名され、ブロックチェーンに安全に保存されています。