Advanced guides
Advanced docStatic guides.
Advanced docStatic guides.
トピックからアセット(docx ファイルや画像など)に直接リンクしたい場合があります。docStatic では static/ フォルダを通じてこれを管理します。
ブログ機能を使用すると、タイムスタンプ付きの記事を作成できます。
docStatic では、「トピック」と呼ばれるファイルに Markdown でコンテンツを記述します。通常は各トピックを自分で作成しますが、特定の種類のドキュメントでは自動生成されるトピックもあります。
ダイアグラムは、コードブロック内で Mermaid を使用してレンダリングできます。
ドキュメント機能は、Markdown ファイルを階層形式で整理する方法を提供します。
Figures コンポーネントを使用すると、キャプション付きの画像をトピックに追加できます。ユーザーが図をクリックすると、ライトボックス内で最大倍率で表示されます。
docStatic guides.
Wiki sidebar generation and category index document conventions.
数式はKaTeXを使用してレンダリングできます。
Valeは、設定可能なスタイルルールに照らしてドキュメントをチェックするコマンドラインの文章リンターです。MarkdownおよびMDXファイルとの統合性が高く、docStaticプロジェクトに自然に適合します。
スタティックアセットとは、ビルド出力に直接コピーされるコード以外のファイルです。画像、スタイルシート、ファビコン、フォントなどが含まれます。
ウィキページは、コラボレーションのために設計されたウェブ/ドキュメントページです。数分で作成・編集でき、チーム内部のナレッジ共有や公開向けヘルプコンテンツによく使用されます。