nito-docs

NITO's documentation site.

Features

TBD

Screenshots

TBD

Get Started

After git clone, run the following command

$ make bs

What is being processed by bootstrap is shown below.

• Configuring git commit message templates
• Installation of various tools by mise
• Installation of dependencies by bun
• Installation of husky by bun

Add template

You can generate code from a template using plop by executing the following command.

$ bun plop

Development Environment

TBD

Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

Architecture

• Astro
• Starlight

Build

TBD

Testing

TBD

Performance

TBD

Contributors

Thanks to our wonderful contributors!

Repo Activity

License

nito-docs is distributed under the terms of the MIT License. See the license for more information.