Quickstart

Before you begin, make sure that you have Node 20+ installed. Lower versions are not supported.

1. Configuration file

#

The first thing to do is to create a Magidoc configuration file. Here is a minimal magidoc.mjs example.

For the full reference, see the dedicated Magidoc Configuration page.

2. Generate

#

For more details on how to use the generate command, see the related documentation.

3. That's it!

#

The built static website outputs in the ./docs folder by default. To preview the website locally, run the following command.