Skip to content
~/noir-cli

Guide

Getting started

Three places to edit before this fictional tool becomes yours.

  1. 01 / Identity

    Name and domain

    Set the product name, URL and repository in src/config/site.ts.

  2. 02 / Catalogue

    Example integrations

    Replace the paired records in src/data/integrations.json.

  3. 03 / Commands

    Demo install tabs

    Change site.install. The commands are displayed as text.

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

Quickstart

Installation

These commands are examples. They are shown as text and are not executed.

npm example
npm install example-package

Guide

Local documentation

This guide is an example. Replace the product name, domain, integration records and demo command before you publish.

Name and domain

Edit src/config/site.ts. Set name, url, repository and the hero copy for each locale.

Integrations

Edit src/data/integrations.json. Keep one record for en and one for pt-br for every slug. Use https:// links and optional screenshots under public/images/.

Demo command

The install tabs read site.install. Change the example commands to the ones your tool actually documents. They are displayed as text and are not executed.