Writing Docs for AIsBreaker.org

Introduction

The docs includes the full documentation, from an introduction of the AIsBreaker project to in-depth technical docs and references.

We use VitePress to generate the static website.

If you want to contribute, please checkout the Contact page for more details.

Changing the Docs

Source code (markdown files) of this docs: github.com/aisbreaker/aisbreaker.org/

To locally run a web server to check the rendered results in real-time before committing:

cd aisbreaker.org/
./startVitepressDevserver.sh

To locally check for dead link and other errors (before committing):

cd aisbreaker.org/
./buildDocs.sh

Formatting Hints

Markdown formatting hints:

• Markdown Examples
  • Check out the documentation for the full list of markdown extensions.
    • Import Code Snippets
    • Code Groups
• API Markdown Examples

Examples

Some examples of static tech docs - maybe a source of inspiration:

• https://github.com/vuejs/vitepress/tree/main/docs/
• https://github.com/expressjs/expressjs.com/tree/gh-pages/en/

Diagrams with Mermaid

We use Mermaid to generate diagrams. It is a diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams.

It's integrated into VitePress with the vitepress-plugin-mermaid.

Example:

```mermaid
graph TD
  A[Enter Chart Definition] --> B(Preview)
  B --> C{decide}
  C --> D[Keep]
  C --> E[Edit Definition]
  E --> B
  D --> F[Save Image and Code]
  F --> B
```

Example result:

null