このプロジェクトでは、node.jsとgulpをビルドツールとして使用して、AngularのIgnite UIのIgnite UI Docfxサンプルサイトの開発を加速します。
docfxをインストールするには、dotnetツールとして復元します - 現在のディレクトリの範囲にある.netローカルツールをインストールします。
dotnet tool restore注: npm install実行は、 postinstallステップとしてdotnetツール依存関係も復元します。
NPMを使用している場合は、実行してください。
npm install糸を使用している場合は、実行してください。
yarn installビルドプロセスは、環境変数NODE_ENVに依存して、角度サンプルの正しいURLを設定できます。 development 、 staging 、またはproductionいずれかをNODE_ENVに割り当てます。
たとえば、環境を割り当てることにより、プロジェクトのルートの下に.envファイルを作成し、 NODE_ENV設定できます。
NODE_ENV=development
サーバーを起動するには、実行してください。
英語の場合:
npm start -- --lang enジャパンゼスの場合:
npm start -- --lang jp韓国語:
npm start -- --lang krコマンドは、断熱的な議論を取ります-lang [en | jp | Kr]英語、日本、韓国語のバージョンを提供する。
英語の場合:
npm run build -- --lang en日本語:
npm run build -- --lang jp韓国語:
npm run build -- --lang krビルドスクリプトは、それぞれのプロジェクトのルートに_siteというフォルダーを生成します。たとえば、英語の場合、静的サイトはen/_siteの下にあります。
ビルドコマンドは、前述のステップに非常に似ています。ステージングのためにサイトを構築するには、実行してください。
npm run build-staging --lang enステージングのビルドコマンドは次のとおりです。
npm run build-production --lang jpCode-View要素の明示的な編集属性は、指定されたサンプルに明示的にライブエディターを設定し、「CSB」と「Stackblitz」を値としてサポートすることができます。
< code-view explicit-editor =" csb " ... > </ code-view > < code-view explicit-editor =" stackblitz " ... > </ code-view > [en |]を開きますjp | kr] components toc.yml '特定の言語バージョンのファイル。各TOCトピックには、オプションのラベルパラメーターとともに、名前とHREFのパラメーターが含まれています。 IGNITEUI-DOCFX-TEMPLATEのバージョン3.5.1から始まると、サポートされているラベルには「新しい」、更新、「プレビュー」、「ベータ」が含まれます。目的のラベルを追加するには、その名前を指定して、その値をtrueに設定するだけです。
例:
- name: Update guide
href: general/update-guide.md
updated: true
ドキュメントWebサイトに折りたたみ可能なコードスニペットを生成および表示するには、次の手順に従ってください。
クラス「Fancy-Details」で<div>セクションを作成します。
作成された<div>セクションに<summary>要素を追加します。
コードスニペットヘッダーを表す概要テキストを<summary>要素に追加します。
作成された<div>セクションに<code>要素を追加します。
コードスニペットを<code>要素に追加します。
例:
< div class =" fancy-details " >
< summary > Example of a successful response body: </ summary >
< code >
{
"id": "{123456}_repo",
"modified": "2023-02-03T14:07:34.0000000",
"created": "2023-02-03T14:07:34.0000000",
"name": "Marketing",
"user": {
"id": "{123456}_u ",
"name": "Teddy Mitkova"
},
"dashboardSections": [
{
"id": "{123456}_f",
"name": "May"
}
]
}
</ code >
</ div >