私の質問:次の操作を簡単にする、すぐに使用できる ( https://github.com/facebook/docusaurus/pull/764を超える) docusaurus 機能はありますか? (彼らの github の質問テンプレートは、そのタイプの問題は閉鎖され、代わりにここで質問するように指示しているため、ここで質問しました)。
私の会社には、マークダウンのドキュメントと、さまざまなコーディング言語のソース コード ドキュメントから生成されたマークダウンを含む、いくつかの異なるリポジトリがあります。
docusaurus を使用して中央サイトを定義することを検討したいのですが、さまざまなリポジトリからドキュメントを取得します。
私はそれをしたい：
- 一元化された検索インデックスを取得するには
- 見つけやすくする
- 一元的に所有される一貫したテーマ/UX を取得する
- 技術者以外のユーザーがコンテンツを見つけて閲覧できるように、それが会社の使用ポリシーになった場合に confluence に公開します ( :( )
- docs-close-to-code のすべての利点を保持するため
これは docusaurus が期待する構造です:
docs/ # all documentation should be placed here
website/
blog/
build/ # on yarn run build
core/
Footer.js
package.json
pages/
sidebars.json
siteConfig.js
static/
そして、これは私が最終的に望んでいる公開されたウェブサイトの構造です:
/v1/products/{product}/{version}/{language}/{content as from docs/}
# e.g.
/v1/products/spanner/{version}/en-GB/readme.html
/v1/internal/{gh-org}/{gh-repo}/{language}/{content as from docs/}
#e.g.
/v1/my-org/my-repo/{version}/en-GB/readme.html
/v1/my-org/my-repo/{version}/en-GB/proto-generated.html
(v1私は何かを忘れると予測しているのでそこにいます。それをヘッジして、後で重大な変更のリダイレクトを容易にすることができます)
したがって、これは、物事を集約するために必要な中間構造であると思います。
docs/
product/
language/
prose|generated-lang
gh-org/
repo/
language/
prose|generated-lang
website/
blog/
product/
language/
prose|generated-lang
gh-org/
repo/
language/
prose|generated-lang
core/
Footer.js
package.json
pages/
product/
language/
prose|generated-lang
gh-org/
repo/
language/
prose|generated-lang
sidebars.json
siteConfig.js
static/
product/
language/
prose|generated-lang
gh-org/
repo/
language/
prose|generated-lang
...それは一緒ですか？
これを手配するために、bashまたはサブモジュールを介してgit cloneを非常に簡単に行うことができます。それは特に問題ではありません。それを行う必要を回避できるものが既に存在するかどうかを知りたいです-たとえば、ドキュメントサイトツールのネイティブ機能、bazel ルールなど。