igniteui docfx

Ignite UI DOCFX Site Builder

Este projeto usa o Node.js e o Gulp como uma ferramenta de construção para acelerar o desenvolvimento do local de amostras IGNITE UI DOCFX para IGNITE UI para o Angular.

Pré -requisitos

1. Docfx
2. Node.js
3. Líquido sdk 6.0 ou superior

Começando

Instalando o docfx

Para instalar o DOCFX, restaurá -lo como uma ferramenta dotnet - instala as ferramentas locais .NET que estão em escopo para o diretório atual:

dotnet tool restore

Nota : Executar npm install também restaura as dependências da ferramenta DOTNET como uma etapa postinstall .

Instalando as dependências Node.js:

Se você estiver usando o NPM, execute:

npm install

Se você estiver usando fios, execute:

yarn install

Iniciando o servidor de desenvolvimento

O processo de construção depende da variável de ambiente NODE_ENV para poder definir o URL correto para as amostras angulares. Atribua development , staging ou production a NODE_ENV .

Você pode criar um arquivo .env sob a raiz do projeto e definir NODE_ENV , por exemplo, atribuindo o ambiente.

 NODE_ENV=development

Para iniciar o servidor, execute:

para inglês:

npm start -- --lang en

Para Japanese:

npm start -- --lang jp

para coreano:

npm start -- --lang kr

O comando leva um argumento aditcional -lang [en | jp | KR] para servir a versão em inglês, japonês ou coreano.

Construindo o local 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

O script de construção produz uma pasta chamada _site na raiz do respectivo projeto. Por exemplo, para o inglês, o site estático vive em en/_site ;

Construindo para estadiamento e produção

O comando Build é muito semelhante à etapa mencionada. Para construir o site para encenação, execute:

npm run build-staging --lang en

O comando de construção para encenação é:

npm run build-production --lang jp

Usando editor explícito para amostras de edição ao vivo

O atributo explícito de editor para elementos de visão de código está permitindo definir o editor ao vivo explicitamente para amostra especificada e suporta "CSB" e "Stackblitz" como valores.

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

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

Inclua rótulos de tópicos do TOC

Abra '[en | jp | KR] Components Toc.yml 'Arquivo para a versão específica do idioma. Cada tópico do TOC inclui parâmetros para nome e href, juntamente com um parâmetro de etiqueta opcional. A partir da versão 3.5.1 do chapado Igniteui-Docfx, os rótulos suportados incluem 'Novo' '' Atualizado ',' Preview 'e' Beta '. Para adicionar um rótulo desejado, basta especificar seu nome e definir seu valor como true.

Exemplo:

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

Trechos de código dobráveis

Para gerar e exibir trechos de código dobráveis nos sites de documentação, siga estas etapas:

1. Crie uma seção <div> com a classe "Fancy-Details".

2. Adicione um elemento <summary> à seção Criada <div>.

3. Adicione o texto resumido representando o cabeçalho do snippet de código ao elemento <summary>.

4. Adicione um elemento <Code> à seção Criada <div>.

5. Adicione o snippet de código ao elemento <Code>.

6. Exemplo:

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