igniteui docfx

Ignite UI Docfx Site Builder

Este proyecto utiliza Node.js y Gulp como una herramienta de compilación para acelerar el desarrollo del sitio de muestras de Ignite UI DOCFX para Ignite UI para Angular.

Requisitos previos

1. Docfx
2. Nodo.js
3. Net SDK 6.0 o superior

Empezando

Instalación de DOCFX

Para instalar DOCFX, restaurarlo como una herramienta Dotnet: instala las herramientas locales de .NET que están en alcance para el directorio actual:

dotnet tool restore

Nota : El desempeño de npm install también restaura las dependencias de la herramienta Dotnet como un paso postinstall .

Instalación de las dependencias node.js:

Si está usando NPM, ejecute:

npm install

Si está usando hilo, ejecute:

yarn install

Iniciar el servidor de desarrollo

El proceso de compilación depende de la variable de entorno NODE_ENV para poder establecer la URL correcta para las muestras angulares. Asigne development , staging o production a NODE_ENV .

Puede crear un archivo .env debajo de la raíz del proyecto y establecer NODE_ENV , por ejemplo, asignando entorno.

 NODE_ENV=development

Para iniciar el servidor, ejecute:

Para inglés:

npm start -- --lang en

para japonesa:

npm start -- --lang jp

para coreano:

npm start -- --lang kr

El comando toma un argumento accesional - -lang [en | JP | Kr] para servir a la versión inglesa, japonesa o coreana.

Construyendo el sitio estático

Para inglés:

npm run build -- --lang en

Para japonés:

npm run build -- --lang jp

Para coreano:

npm run build -- --lang kr

El script de compilación produce una carpeta llamada _site en la raíz del proyecto respectivo. Por ejemplo, para el inglés, el sitio estático vive bajo en/_site ;

Edificio para la puesta en escena y la producción

El comando de compilación es muy similar al paso mencionado anteriormente. Para construir el sitio para la puesta en escena, ejecute:

npm run build-staging --lang en

El comando de compilación para la puesta en escena es:

npm run build-production --lang jp

Uso del editor explícito para muestras de edición en vivo

El atributo de editor explícito para los elementos de visión de código está permitiendo establecer explícitamente el editor en vivo para una muestra especificada y admite "CSB" y "Stackblitz" como valores.

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

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

Incluir etiquetas de top top

Abierto '[es | JP | kr] componentes toc.yml 'archivo para la versión de idioma específico. Cada tema de TOC incluye parámetros para Name y HREF, junto con un parámetro de etiqueta opcional. A partir de la versión 3.5.1 de la plantilla Igniteui-Docfx, las etiquetas compatibles incluyen 'Nuevo', 'actualizado', 'Vista previa' y 'beta'. Para agregar una etiqueta deseada, simplemente especifique su nombre y establezca su valor en verdadero.

Ejemplo:

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

Fragmentos de código plegables

Para generar y mostrar fragmentos de código plegables en los sitios web de documentación, siga estos pasos:

1. Cree una sección <Div> con la clase "Det-Details".

2. Agregue un elemento <summary> a la sección <iv> creada.

3. Agregue el texto resumido que representa el encabezado del fragmento de código al elemento <summary>.

4. Agregue un elemento <code> a la sección <div> creada.

5. Agregue el fragmento de código al elemento <código>.

6. Ejemplo:

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