このプロジェクトについて
Ciderpressは、モノレポ向けに設計されたドキュメントフレームワークで、最小限の設定でmarkdownファイルを完全なドキュメントサイトに変換します。
主な機能:
- 構造の適合性: 厳格な構造を押し付けるのではなく、既存のリポジトリレイアウトに適応します。
- 統一設定: サイドバー、ナビゲーション、フッター、編集リンク、バージョン表示、お知らせ、テーマ設定を単一の設定ファイルから制御します。
- 組み込みテーマ: honeycrisp、grannysmith、midnight、arcadeの4つのテーマを同梱し、それぞれ完全なダークモードをサポートします。カスタムテーマもサポートされています。
- モノレポサポート: ワークスペースカード、OpenAPI統合、Liquidテンプレートサポートを含み、内部開発者向けドキュメントを対象としています。
使用するには、npmでインストールし、title、path、markdownのincludeパターンを持つセクションを宣言する設定ファイル(ciderpress.config.ts)を定義する必要があります。このツールは3つのコマンドを提供します: `npx ciderpress dev`でホットリロード付きの開発サーバーを起動、`npx ciderpress build`で本番ビルドを生成、`npx ciderpress serve`でビルド済みサイトをローカルでプレビューします。
MITライセンスの下で提供されています。
Comments
0 people shared their preference · Deer Point appears after 10 participants
Sign in to join the discussion.