Docsifyの便利なところ
Docsifyというドキュメンテーションツールの便利なところをご紹介します。
https://gyazo.com/b71d24bc039f65af5150d5589bda9a9f
完全な静的サイト
index.htmlが各MarkdownをFetchして表示する仕組み。
サーバーを持たず、ビルドも不要なのでデプロイが簡単。
デプロイについて:Deploy - docsify
おしゃれ
結構見た目がおしゃれ(田村)
プラグインが使える
プラグインをindex.htmlに登録すれば、機能を拡張できる。
おすすめのプラグイン
Full text search
LocalStorageにすべてのページのテキストを保持させ、そこから全体検索チックなことをしている模様。
サーバーレスでこれだけ動けば十分かな、というレベルには使える。
https://docsify.js.org/#/plugins?id=full-text-search
Edit on GitHub
ページに直接GitHubの編集ページへのリンクを追加するプラグイン
ちょっとしたタイポの修正などに便利
njleonzhang/docsify-edit-on-github
Copy Code
Code BlockにCopy Codeボタンを追加するプラグイン
jperasmus/docsify-copy-code: A docsify plugin that copies Markdown code block to your clipboard
Syntax Highlightの追加が簡単
DocsifyがPrismを使っているため、Prismの言語ファイルを読み込めば言語対応ができる。
対応可能な言語:prism/components at master · PrismJS/prism
サイドバーに階層がつけられる
GitHub Wikiで結構なストレスだった、サイドバーメニューもマークダウン形式で設定可能。
また、サイドバーメニューに階層をつけたり、ページの目次を表示することもできるので便利。
Mermaidを簡単に導入できる
作図ライブラリのMermaidを簡単に導入でき、手軽にシーケンス図や状態遷移図、フローチャートといった図を編集可能な状態で追加できる。
https://docsify.js.org/#/markdown?id=supports-mermaid
docsify-themeable
Docsifyに拡張テーマを提供するツール(?)。
テーマの追加もさることながら、拡張マークダウンがちょいちょい使い所があって助かる。
Notices
https://gyazo.com/ac1be0222c539d2d9c2634c07e4bdbff
code:md
!> **Important** notice with inline code and additional placeholder text used
to force the content to wrap and span multiple lines.
?> **Tip** notice with inline code and additional placeholder text used to
force the content to wrap and span multiple lines.
Tabs
https://gyazo.com/70d59071b28fa9ab479b5be3af943838
code:md
<!-- tabs:start -->
#### **English**
Hello!
#### **French**
Bonjour!
#### **Italian**
Ciao!
<!-- tabs:end -->
Keyboard
(マークダウンではない)
https://gyazo.com/da1ad17bdb38a95fede4347050971e16
code:md
<kbd>&uarr;</kbd> Arrow Up
<kbd>&darr;</kbd> Arrow Down
<kbd>&larr;</kbd> Arrow Left
<kbd>&rarr;</kbd> Arrow Right
<kbd>&#8682;</kbd> Caps Lock
<kbd>&#8984;</kbd> Command
<kbd>&#8963;</kbd> Control
おわりに
GitHub Wikiで消耗している方は管理コストはGitHub Wikiと同等で使用感が圧倒的に上がるDocsifyを是非。
#docsify
Created By tamuraryoya