Facebook Docusaurus中国語ドキュメント作成サイト
1757 ワード
このシリーズの適用例はGitHub:docusaurus-docs-Zh_に公開されています.CN.Forkは改善やスターの更新に注目することができます.スターを歓迎します.
Webサイトの作成
Docusaurusの創造は、オープンソースプロジェクトのためにウェブサイトとドキュメントを簡単に作成することを望んでいます.
インストールと準備の後、ドキュメントの基本的なWebサイトを作成する多くの作業が完了しました.
Webサイトの構成
あなたのサイトの構造は次のように見えます.
ここでは、初期化スクリプトとともにインストールされているものを削除したとします.
すべてのドキュメントファイルは
ブログ投稿のフォーマットはyyyy-mm-dd-your-file-name.mdでなければなりません
基本的なWebサイトの作成
機能的なWebサイトを作成するには、次の手順に従います.ドキュメントを 0 0または複数のドキュメントを
ドキュメントを追加しない場合
カスタムページおよび/またはカスタム は、画像などのウェブサイトリソースを Webサイトを実行して、変更の結果を表示します.
このシリーズの適用例はGitHub:docusaurus-docs-Zh_に公開されています.CN.Forkは改善やスターの更新に注目することができます.スターを歓迎します.
Webサイトの作成
Docusaurusの創造は、オープンソースプロジェクトのためにウェブサイトとドキュメントを簡単に作成することを望んでいます.
インストールと準備の後、ドキュメントの基本的なWebサイトを作成する多くの作業が完了しました.
Webサイトの構成
あなたのサイトの構造は次のように見えます.
root-of-repo
├── docs
└── website
│ └── blog
│ └── core
│ └── Footer.js
│ └── node_modules
│ └── package.json
│ └── pages
│ └── sidebars.json
│ └── siteConfig.js
│ └── static
ここでは、初期化スクリプトとともにインストールされているものを削除したとします.
.md
サンプルファイル.すべてのドキュメントファイルは
.md
ファイルとしてdocs
フォルダに配置する必要があります.どのブログ記事もblog
フォルダにあるはずです.ブログ投稿のフォーマットはyyyy-mm-dd-your-file-name.mdでなければなりません
基本的なWebサイトの作成
機能的なWebサイトを作成するには、次の手順に従います.
.md
ファイルとして/docs
フォルダに追加し、各ファイルに正しいヘッダーがあることを確認します.最も簡単なタイトルは、id
がリンク名(例えばdocs/intro.html
)であり、title
はもちろんブラウザページのタイトルである.---
id: intro
title:
---
* * ...
sidebars.json
ファイルに追加して、ドキュメントをサイドバーに表示したい場合は、ドキュメントを表示します.ドキュメントを追加しない場合
sidebars.json
ファイルでは、ドキュメントはレンダリングされますが、他のドキュメントからのみリンクされ、既知のURLでアクセスできます.website/siteConfig.js
ファイルを修正してウェブサイトを構成し、website/siteConfig.js
のドキュメントガイドに従います.website/core/Footer.js
ファイルを作成して、Webサイトにフッターを提供します.website/static/
フォルダに格納する.cd website
yarn run start # `npm run start`
# http://localhost:3000
このシリーズの適用例はGitHub:docusaurus-docs-Zh_に公開されています.CN.Forkは改善やスターの更新に注目することができます.スターを歓迎します.