yarnを使用してdocusaurusベースのオンラインドキュメントを構築
1620 ワード
Docusaurusは、フェイスブックのオープンソースプロジェクトであるmarkdownフォーマットに基づいてドキュメントの内容を記述する良いオンラインドキュメントレンダリングツールです.似たような他のツールを比較すると、これがいいと思います.
Docusaurus V 2公式サイトRancherDocs(それに基づいて実装されたサイトで、ソースコードを表示)
一、環境の準備 Yarn Node.js
構成ステップは省略します.
二、プロジェクトの作成
例えば、作業ディレクトリ
三、ローカル起動
作成が完了すると、コマンドラインはこのshanhy-blogのフォルダに入り、以下のようにします.インストール初期化
ローカル起動
構築のみの場合は、コマンドを使用します.
実行に成功すると、自動的にブラウザが開き、
その他
1、yarn installの速度が遅い場合は、淘宝Registryを構成してみてください.コマンド:
現在のRegistryを表示するコマンドは次のとおりです(デフォルトは
2、目次の説明
(END)
Docusaurus V 2公式サイトRancherDocs(それに基づいて実装されたサイトで、ソースコードを表示)
一、環境の準備
構成ステップは省略します.
二、プロジェクトの作成
例えば、作業ディレクトリ
E:\Docusaurus
を作成し、コマンドラインを使用してこのディレクトリに入った後、次のコマンドnpx
に従って操作します. :npx @docusaurus/init@next init [name] [template]
name , template , classic, 。
:
npx @docusaurus/init@next init shanhy-blog classic
三、ローカル起動
作成が完了すると、コマンドラインはこのshanhy-blogのフォルダに入り、以下のようにします.インストール初期化
yarn install
ローカル起動
yarn start
構築のみの場合は、コマンドを使用します.
yarn build
実行に成功すると、自動的にブラウザが開き、
http://localhost:3000
にアクセスし、インタフェースが表示されます.その他
1、yarn installの速度が遅い場合は、淘宝Registryを構成してみてください.コマンド:
yarn config set registry ttps://registry.npm.taobao.org -g
現在のRegistryを表示するコマンドは次のとおりです(デフォルトは
https://registry.yarnpkg.com
).yarn config get registry
2、目次の説明
/blog/ - , markdown 。
/docs/ - , markdown 。
/src/ - , css , custom.css css 。
/src/pages - , react 。
/static/ - , , , img 。
/docusaurus.config.js - 。
/package.json - node.js 。
/sidebar.js - , , 。
, theme , 。
(END)