Pular para o conteúdo
~/noir-cli

Guia

Primeiros passos

Três lugares para editar antes que esta ferramenta fictícia vire a sua.

  1. 01 / Identidade

    Nome e domínio

    Defina o nome, a URL e o repositório em src/config/site.ts.

  2. 02 / Catálogo

    Integrações de exemplo

    Troque os registros em par em src/data/integrations.json.

  3. 03 / Comandos

    Abas de instalação

    Altere site.install. Os comandos aparecem como texto.

noir buildfictional demo
$ noir build✓ example editor✓ example terminalfictional demo output

Início rápido

Instalação

Estes comandos são exemplos. Eles aparecem como texto e não são executados.

npm example
npm install example-package

Guia

Documentação local

Este guia é um exemplo. Troque o nome do produto, o domínio, os registros de integração e o comando de demonstração antes de publicar.

Nome e domínio

Edite src/config/site.ts. Defina name, url, repository e o texto do hero em cada idioma.

Integrações

Edite src/data/integrations.json. Mantenha um registro em en e outro em pt-br para cada slug. Use links https:// e, se quiser, capturas em public/images/.

Comando de demonstração

As abas de instalação leem site.install. Troque os comandos de exemplo pelos que a sua ferramenta documenta de verdade. Eles aparecem como texto e não são executados.