v0.8.0 利用可能になりました

Markdownを本番用ドキュメントに。
コマンド1つ。設定不要。

SEOに強い静的HTML。SPAのような高速ナビゲーション。デフォルトでAI対応。
React不要。フレームワークへの依存なし。学習コストゼロ。

始める Get Started
20kb以下のJS Lighthouse 100 設定不要 オフライン検索
docs.docmd.io
はじめに

設定ゼロで開始。必要な時にフルコントロール。

コマンドを1つ実行するだけで、本番用のドキュメントサイトが完成します。後からシンプルな設定ファイルでカスタマイズ可能です。

  • npx @docmd/core init によるワンコマンドセットアップ
  • フルカスタマイズのためのオプションの docmd.config.js
  • 既存のMarkdown構造でそのまま動作
インストールガイド →
Terminal
$ npx @docmd/core dev
 Found 12 markdown files
 Built in 340ms
 Search index ready
  → http://localhost:3000
コンテンツ

HTMLなしで豊かなレイアウトを。

Markdownネイティブのコンテナ構文を使用して、コールアウト、タブ、カードなどを記述できます。

  • コールアウト、警告、情報ボックス
  • 構文ハイライト付きのタブコンテンツ
  • カードグリッドとレイアウトコンテナ
  • すべてのコンテナタイプでアイコンをサポート
コンテナドキュメント →
⚠️ Warning

Be careful with this setting. It affects all deployments.

ℹ️ Note

This feature requires docmd v0.7.0 or later.

JavaScript
Python
Go
npm install @docmd/core
Quick Start
Get running in under 2 minutes
Configuration
Customize every aspect
検索

インスタント検索。APIキー不要。100%オフライン。

すべてのサイトに全文あいまい検索が組み込まれています。クラウド依存なし、APIコストなし。

  • すべてのコンテンツにわたるあいまい一致
  • ⌘K ショートカットで検索を開く
  • i18nのための言語別検索インデックス
検索プラグインドキュメント →
本番対応

i18n、テーマ、バージョニング、ワンコマンドデプロイ。

本番環境に必要なすべて:多言語サポート、ライト&ダークテーマ、バージョン切り替え、デプロイ設定。

  • 言語優先URLによるネイティブi18n
  • カスタムCSSによるライト&ダークテーマ
  • マルチバージョン・ドキュメントのサポート
  • docmd deploy による本番用設定の生成
設定ドキュメント →
Light
Dark
Terminal
$ docmd deploy --docker
 Generated Dockerfile
 Generated nginx.conf
  → docker build -t docs .

あらゆるドキュメントのニーズに対応。

オープンソースのREADMEから企業のナレッジベースまで。

開発者ドキュメント

オープンソースプロジェクトや製品のAPIリファレンス、ガイド、チュートリアル。

ナレッジベース

検索とバージョニングを備えた社内Wiki、チームドキュメント、オンボーディングガイド。

APIリファレンス

ネイティブOpenAPIサポート、コード例を含む構造化されたエンドポイントドキュメント。

テクニカルガイド

コールアウト、警告、多言語コード例を含むステップバイステップのチュートリアル。

多言語サイト

言語優先URLとローカライズされた検索を備えた、あらゆる言語のドキュメント。

変更履歴

バージョン履歴と構造化されたリリースノートを含む美しいリリース・タイムライン。

すべて同梱。

コアプラグインはデフォルトで同梱されています。必要に応じてオプションを追加してください。

よくある質問

docmdに関する一般的な質問への回答。

docmdとは何ですか?
docmdは、Markdownファイルを本番対応のドキュメントサイトに変換する、オープンソースの設定不要なドキュメントエンジンです。クイックスタートガイドを読む →
DocusaurusやVitePressとの違いは何ですか?
docmdは設定ゼロで動作します。ReactやVue、フレームワークの知識は不要です。完全な比較を見る →
Reactやフレームワークは必要ですか?
いいえ。docmdはフレームワークに依存しません。Markdownを書き、コマンドを1つ実行するだけで本番サイトが完成します。
AI対応機能はどのように動作しますか?
docmdは、AIモデルに構造化されたコンテキストを提供する llms.txt ファイルを自動生成します。LLMsプラグインについて詳しく →
docmdは無料ですか?
はい。MITライセンスのもと、完全に無料でオープンソースです。GitHubで表示 →
既存のMarkdownファイルで使用できますか?
はい。Markdownファイルのあるディレクトリをdocmdで指定するだけです。Markdown構文リファレンス →
docmdは多言語をサポートしていますか?
はい。言語優先URLと言語別検索インデックスによるネイティブi18nをサポートしています。i18n設定 →

まだ迷っていますか?

お気に入りのAIにdocmdについて尋ねるか、ドキュメントを読んでみてください。

より良いドキュメントを書く準備はできましたか?

docmdで高速かつ美しいドキュメントを構築している開発者の仲間入りをしましょう。

コミュニティスポンサー