igniteui docfx

Ignite UI Docfx Site Builder

Ce projet utilise Node.js et Gulp comme un outil de construction pour accélérer le développement du site d'échantillons Ignite UI DOCFX pour Ignite UI pour Angular.

Condition préalable

1. Docfx
2. Node.js
3. SDK net 6.0 ou plus

Commencer

Installation de docfx

Pour installer DOCFX, restaurez-le comme un outil Dotnet - installe les outils locaux .NET qui sont dans la portée du répertoire actuel:

dotnet tool restore

Remarque : la réalisation npm install restaure également les dépendances d'outils DOTNET en tant qu'étape postinstall .

Installation des dépendances Node.js:

Si vous utilisez NPM, exécutez:

npm install

Si vous utilisez du fil, exécutez:

yarn install

Démarrage du serveur de développement

Le processus de construction dépend de la variable d'environnement NODE_ENV pour pouvoir définir l'URL correcte pour les échantillons angulaires. Attribuez un development , staging ou production à NODE_ENV .

Vous pouvez créer un fichier .env sous la racine du projet et définir NODE_ENV , par exemple, en attribuant un environnement.

 NODE_ENV=development

Pour démarrer le serveur, exécutez:

pour l'anglais:

npm start -- --lang en

pour japanais:

npm start -- --lang jp

pour coréen:

npm start -- --lang kr

La commande prend un argument aditation --Lang [en | JP | kr] pour servir l'anglais, le japonais ou la version coréenne.

Construire le site statique

Pour l'anglais:

npm run build -- --lang en

Pour le japonais:

npm run build -- --lang jp

Pour coréen:

npm run build -- --lang kr

Le script de construction produit un dossier appelé _Site à la racine du projet respectif. Par exemple, pour l'anglais, le site statique vit sous en/_site ;

Bâtiment pour la mise en scène et la production

La commande de construction est très similaire à l'étape susmentionnée. Pour construire le site pour la mise en scène, exécutez:

npm run build-staging --lang en

La commande de construction pour la mise en scène est:

npm run build-production --lang jp

Utilisation de l'éditeur explicite pour des échantillons d'édition en direct

L'attribut éditeur explicite pour les éléments de vue de code permet de définir un éditeur en direct explicitement en direct pour un échantillon spécifié et prend en charge "CSB" et "Stackblitz" comme valeurs.

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

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

Inclure les étiquettes des sujets TOC

Ouvrir '[en | JP | KR] Components toc.yml 'Fichier pour la version linguistique spécifique. Chaque sujet TOC comprend des paramètres de nom et HREF, ainsi qu'un paramètre d'étiquette facultatif. À partir de la version 3.5.1 du Template IgniteUi-Docfx, les étiquettes prises en charge incluent «New», «mise à jour», «prévisualisation» et «bêta». Pour ajouter une étiquette souhaitée, spécifiez simplement son nom et définissez sa valeur sur true.

Exemple:

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

Extraits de code pliable

Pour générer et afficher des extraits de code pliables sur les sites Web de documentation, suivez ces étapes:

1. Créez une section <div> avec la classe "Details de fantaisie".

2. Ajoutez un élément <summary> à la section <v> créée.

3. Ajoutez le texte de résumé représentant l'en-tête de l'extrait de code à l'élément <summary>.

4. Ajoutez un élément <code> à la section <v> créée.

5. Ajoutez l'extrait de code à l'élément <code>.

6. Exemple:

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