OSS正在使用的文档工具清单。

首先，我只写了常见的地方（将根据需要随时更新）。

雨果

• https://kubernetes.io/

 

• https://istio.io/

 

• https://etcd.io/

 

• https://prometheus-operator.dev/

 

• https://www.kubeflow.org/

 

• https://skaffold.dev/

 

• https://github.com/kiali/kiali.io

 

• https://thanos.io/

 

• https://keda.sh/

 

• https://vitess.io/

 

https://tekton.dev/

MkDocs的材料

• https://kserve.github.io/

 

• https://knative.dev/docs/

 

• https://argo-cd.readthedocs.io/

 

• https://riverml.xyz/latest/

 

• https://doc.traefik.io/traefik/

 

• https://external-secrets.io/

 

https://www.conftest.dev/

Gitbook (中文名称：GitBook)

• https://quii.gitbook.io/learn-go-with-tests/

 

https://docs.feast.dev/

mdbook 是一种用于创建电子书的工具。

• https://book.kubebuilder.io/

 

https://metacontroller.github.io/metacontroller/

话语

• Static Site Generator (SSG)

データやテンプレートから静的HTMLウェブサイトを生成するツール。
毎回同じものを返すものに使われ、prebuildしたものを使うことで、ロードが早い。

JAMstack

JAMstack (JAM: “JavaScript, APIs, Markup”)は、効率的に軽くて、早いウェブアプリケーションを作成する方法。SSGもこれに入る。

Content Management Systems (CMS)

SSGに対応するCMSは、サーバー側で、リクエストに対応するデータとテンプレートからHTMLを生成するタイプ。毎回のリクエストによって表示する内容を変える必要があるウェブサービスはこちらを用いる。毎回サーバー側での処理（例. データベースにアクセス）が必要なので、毎回生成してフロントへ返して上げる必要あり。

对比和个人见解

1. 如果简单地做的话，mkdocs看起来更容易

 

mdBook的预处理器似乎很方便（例如：suite_test.go -> 编写控制器测试）

请引用以上内容

• https://www.cloudflare.com/learning/performance/static-site-generator/

 

• https://jamstack.org/

 

• https://gohugo.io/

 

• https://rust-lang.github.io/mdBook/

 

• https://www.mkdocs.org/

 

• https://squidfunk.github.io/mkdocs-material/

 

https://www.gitbook.com/