igniteui docfx

Ignite UI Docfx Situs Builder

Proyek ini menggunakan Node.js dan Gulp sebagai alat build untuk mempercepat pengembangan situs sampel Docfx UI Ignite untuk Ignite UI untuk Angular.

Prasyarat

1. Docfx
2. Node.js
3. Net SDK 6.0 atau lebih tinggi

Memulai

Menginstal DOCFX

Untuk menginstal DOCFX, kembalikan sebagai alat dotnet - menginstal alat lokal .net yang berada dalam ruang lingkup untuk direktori saat ini:

dotnet tool restore

Catatan : Melakukan npm install juga mengembalikan dependensi alat dotnet sebagai langkah postinstall .

Menginstal dependensi Node.js:

Jika Anda menggunakan NPM, jalankan:

npm install

Jika Anda menggunakan benang, jalankan:

yarn install

Memulai server pengembangan

Proses build tergantung pada variabel lingkungan NODE_ENV untuk dapat mengatur URL yang benar untuk sampel sudut. Tetapkan baik development , staging , atau production ke NODE_ENV .

Anda dapat membuat file .env di bawah root proyek dan mengatur NODE_ENV , misalnya, dengan menetapkan lingkungan.

 NODE_ENV=development

Untuk memulai server, jalankan:

untuk bahasa Inggris:

npm start -- --lang en

untuk orang Jepang:

npm start -- --lang jp

Untuk Korea:

npm start -- --lang kr

Perintah tersebut mengambil argumen adittional -lang [en | jp | KR] untuk melayani versi bahasa Inggris, Jepang atau Korea.

Membangun Situs Statis

Untuk bahasa Inggris:

npm run build -- --lang en

Untuk bahasa Jepang:

npm run build -- --lang jp

Untuk Korea:

npm run build -- --lang kr

Build Script menghasilkan folder yang disebut _site pada akar proyek masing -masing. Misalnya, untuk bahasa Inggris, situs statis hidup di bawah en/_site ;

Membangun pementasan dan produksi

Perintah build sangat mirip dengan langkah yang disebutkan di atas. Untuk membangun situs untuk pementasan, jalankan:

npm run build-staging --lang en

Perintah build untuk pementasan adalah:

npm run build-production --lang jp

Menggunakan editor eksplisit untuk sampel pengeditan langsung

Atribut eksplisit-editor untuk elemen-elemen view kode memungkinkan untuk mengatur editor langsung secara eksplisit untuk sampel tertentu dan mendukung "CSB" dan "StackBlitz" sebagai nilai.

 < code-view explicit-editor =" csb " ... > </ code-view > 

 < code-view explicit-editor =" stackblitz " ... > </ code-view > 

Sertakan label topik TOC

Buka '[en | jp | Kr] Components Tocc.yml 'File untuk versi bahasa tertentu. Setiap topik TOC mencakup parameter untuk nama dan HREF, bersama dengan parameter label opsional. Mulai dari versi 3.5.1 dari IgniteUi-Docfx-template, label yang didukung termasuk 'baru,' 'diperbarui,' 'pratinjau,' dan 'beta.' Untuk menambahkan label yang diinginkan, cukup tentukan namanya dan atur nilainya ke True.

Contoh:

 - name: Update guide
  href: general/update-guide.md
  updated: true

Cuplikan kode yang dapat dilipat

Untuk menghasilkan dan menampilkan cuplikan kode yang dapat dilipat di situs web dokumentasi, ikuti langkah -langkah ini:

1. Buat bagian <verv> dengan kelas "Fancy-Details".

2. Tambahkan elemen <summary> ke bagian <SEV> yang dibuat.

3. Tambahkan teks ringkasan yang mewakili header snippet kode ke elemen <summary>.

4. Tambahkan elemen <code> ke bagian <div> yang dibuat.

5. Tambahkan cuplikan kode ke elemen <code>.

6. Contoh:

 < 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 >