docsifyオンライン説明ドキュメントを作成する軽量級神器
5332 ワード
ネット上でhtmlを使ってmdファイルをロードする処理を発見し、極めて簡単にきれいなオンライン説明ドキュメント--神器docsifyを作ることができます.
GIThubアドレス:https://github.com/QingWei-Li/docsify/
中国語ドキュメントアドレス(demo):https://docsify.js.org/#/zh-cn/
これはvue 2に基づく.0の、最も簡単で最も速い使い方を以下に記録します.
1、以下のコードをルートディレクトリindexにコピーして貼り付ける.html
2、作成したmdファイルをディレクトリに入れる
ルートディレクトリにREADMEを入れます.MD(indexページ相当),sidebar.md(サイドバー),coverpage.md(表紙、これが要らない場合はindex.htmlでcoverpage:trueの設定を外します).
3、1、2のファイルを静的サイトに置くと、閲覧できます.
もちろんこれは最も簡単な方法で、docsifyはCLIツールを提供して、強大な機能を持っています.
皆さんの参考にするためにtestドキュメントを置きます』』のリンク
転載先:https://www.cnblogs.com/jsben/p/8434724.html
GIThubアドレス:https://github.com/QingWei-Li/docsify/
中国語ドキュメントアドレス(demo):https://docsify.js.org/#/zh-cn/
これはvue 2に基づく.0の、最も簡単で最も速い使い方を以下に記録します.
1、以下のコードをルートディレクトリindexにコピーして貼り付ける.html
DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta charset="UTF-8">
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
head>
<body>
<nav>
<a href="#/">ENa>
<a href="#/zh-cn/"> a>
nav>
<div data-app id="main"> div>
<script>
window.$docsify = {
el: '#main', //
loadSidebar: true, // sidebar
subMaxLevel: 2, //
coverpage: true， //
}
script>
<script src="//unpkg.com/docsify/lib/docsify.min.js">script>
body>
html>
html>2、作成したmdファイルをディレクトリに入れる
ルートディレクトリにREADMEを入れます.MD(indexページ相当),sidebar.md(サイドバー),coverpage.md(表紙、これが要らない場合はindex.htmlでcoverpage:trueの設定を外します).
3、1、2のファイルを静的サイトに置くと、閲覧できます.
もちろんこれは最も簡単な方法で、docsifyはCLIツールを提供して、強大な機能を持っています.
皆さんの参考にするためにtestドキュメントを置きます』』のリンク
転載先:https://www.cnblogs.com/jsben/p/8434724.html