cortexjs.io
1.0.0
Este repo contém os arquivos de origem para o site "Cortexjs.io".
git submodule init
git submodule update
# Setup, make a dev build and start a server
npm start # Pick-up changes in the dependent modules
npm run update
# Generate .md files for API and launch local server
npm startnpm run stage
# Make a clean production build.
# Output goes inside submodules/cortex-js.github.io
npm run restart
# Validate that everything works well in the browser then...
npm run deploy
# submodules/cortex-js.github.io (a git submodule) gets pushed to cortex-js.github.ioO site é publicado usando páginas do GitHub. O principal benefício do uso de páginas GH é a integração do fluxo de trabalho (Pubshing to GH desencadeia uma atualização automática do site que está sendo servido)
O conteúdo dos sites é de autoria principalmente como arquivos de marcação, processados com eleventy para transformá -los em HTML/CSS.
A configuração principal eleventy está no arquivo config/eleventy.js , incluindo a definição do Markdown para usar.
O mecanismo de marcação é markdown-it que implementa a Commonmark.
O plug-in de mardown-it-attrs permite o estilo de parágrafos, por exemplo
Este é um aviso. {.Notice-Info}
O plug-in de markdown-it-deflist suporta listas de definição de estilo PANDC:
Term 1
: Definition 1
: Second definition
A saída está no diretório submodules/cortex-js.github.io . Esse diretório é um submódulo Git que está vinculado ao repo cortex-js.github.io . Que o repositório é o publicado pelo GH Pages (para organização, apenas um repositório inteiro pode ser publicado, para projetos, o conteúdo pode ser contido no diretório A /docs ).
Veja também submódulos.
O repositório cortex-js.github.io também deve incluir dois arquivos adicionais:
.nojekyll , que indica ao Github que não deve processar o conteúdo deste repositório com Jekyll (já que essa já é a saída de Jekyll)CNAME com um conteúdo de cortexjs.io Esses arquivos são criados ao executar npm run stage .
Use a guia Configurações no repo cortex-js.github.io para indicar o uso de um domínio personalizado.
Além disso, as entradas do DNS para cortexjs.io devem incluir o seguinte:
www.cortex-js.io para cortex-js.io O comando npm run build gera a documentação para as APIs a partir do arquivo TypeScript .d.ts no diretório build/ .
O processo de compilação usa a ferramenta typedoc para analisar os arquivos de cabeçalho da API e produzir arquivos json no diretório build/ .
Nota: Para depurar o conversor, use o depurador do VSCODE. Selecione Debug> Comece a depurar para iniciar uma sessão de depuração correta no VSCode.
O script build-guides converte o arquivo json em Markdown no diretório ./src/build , que pode ser processado por elevação com npm run build ou npm start .
As informações de estilo CSS são definidas no src/_sass/ .
A documentação da API deve seguir o Guia de Estilo de Documentação do Google (https://developers.google.com/style/api-reference-comments) e https://developers.google.com/style
Além disso, o código TypeScript deve seguir o Guia do Estilo do Google: https://google.github.io/styleguide/jsguide.html#naming
O projeto segue o padrão do GitHub para scripts do projeto de nomeação.
Para fazer uma construção local:
npm startPara fazer uma construção pronta para ser encenada:
npm run stageO "teste" do site gerado consiste em verificação de links e que o HTML gerado é válido.
