Documentation site based on Nextra docs (based on next.js)

to run the project

npm i npm run dev

prerequisits

It's recommended to use volta

"node": ">=20.9.0"
"npm": ">=10"

to build the project

1. npm run build

Create a page

In order to get a new page create an .md or .mdx file in the pages folder. Then you can control the page details (title, sidebar, pagination, etc) from the _meta.json. We need it there in order to disable the footer.

pages -> new-page.md

_meta.en-US.json

"new-page": {
    "title": "The new Page",
    "theme": {
        "breadcrumb": true,
        "footer": false,
        "sidebar": true,
        "toc": true,
        "pagination": true
    }
},

More details.

Editing

Markdown

Template Configuration

i18n

At the moment the i18n is done manually by the nextra guide - https://nextra.site/docs/guide/i18n

We'll explore the option to use Crowdin instead.