[拡張推奨]LaRecipe:あなたのLaravelプロジェクトにMarkdownドキュメント機能を追加
記事は専門のLaravel開発者コミュニティから転送され、元のリンク:https://learnku.com/laravel/t...
LaRecipeはSaleem Hadadによって作成された拡張パッケージで、Laravelアプリケーション内でMarkdown構文を使用して製品またはアプリケーションの美しいドキュメントを作成する簡単な方法を提供します.
使用を開始するには、composerを使用してインストールコマンドをインストールし、実行して必要なファイルと構成をパブリッシュする必要があります.
開梱すると、LaRecipeはあなたのドキュメントを
上記の例では、
ドキュメントのデフォルトおよびリリースバージョンを設定および制御するには、次のようにします.
コンフィギュレーションドキュメントとPHPコンフィギュレーションファイルからもLaRecipeコンフィギュレーション項目がわかります.
LaRecipeはあなたのmarkdownドキュメントをHTMLに変換し、オプションのVueコンポーネントもサポートします.Vueサポートコンポーネントのドキュメントから詳しく説明します.また、カード、ボタン、バッジ、進捗バーなど、開梱用のVueコンポーネントも含む.
LaRecipeドキュメントを読むことでLaRecipeを開始できます.GitHubソース倉庫はここです
LaRecipeはSaleem Hadadによって作成された拡張パッケージで、Laravelアプリケーション内でMarkdown構文を使用して製品またはアプリケーションの美しいドキュメントを作成する簡単な方法を提供します.
使用を開始するには、composerを使用してインストールコマンドをインストールし、実行して必要なファイルと構成をパブリッシュする必要があります.
php artisan larecipe:install
開梱すると、LaRecipeはあなたのドキュメントを
/docs
URLの下に配置し、アプリケーションのそばでドキュメントのバージョン管理を行うことができます.一般的なインストールディレクトリ構造は次のとおりです.├─ config
│ └─ larecipe.php
└─ resources
└─ docs
│─ 1.0
│ │─ index.md
│ └─ overview.md
└─ 2.0
│─ index.md
└─ overview.md
上記の例では、
/docs/1.0
〜/docs/2.0
の経路を有する.ベース・ルーティング、ドキュメント・ファイルの場所、ログイン・ページをカスタマイズできます.たとえば、landing
のコンフィギュレーション・アイテムをoverview
に設定すると、ログイン・ページがoverview.md
に表示されます.ドキュメントのデフォルトおよびリリースバージョンを設定および制御するには、次のようにします.
return [
'versions' => [
'default' => '1.0',
'published' => [
'1.0'
]
]
];
コンフィギュレーションドキュメントとPHPコンフィギュレーションファイルからもLaRecipeコンフィギュレーション項目がわかります.
LaRecipeはあなたのmarkdownドキュメントをHTMLに変換し、オプションのVueコンポーネントもサポートします.Vueサポートコンポーネントのドキュメントから詳しく説明します.また、カード、ボタン、バッジ、進捗バーなど、開梱用のVueコンポーネントも含む.
LaRecipeドキュメントを読むことでLaRecipeを開始できます.GitHubソース倉庫はここです