Installation
Set up the Mullgate documentation site and prepare a local working environment.
This page covers the practical prerequisites for working with the Mullgate docs and the surrounding project materials.
What is in this repository?
The documentation sources that matter most for Mullgate are:
usage.mdpublishing.mdmulti-exit-architecture-spec.mdmullgate-docs/
The mullgate-docs directory is the FumaDocs application used to publish the site.
Prerequisites
To work on the documentation site locally, have the following installed:
- Git
- Node.js
- a package manager such as
pnpmornpm
If you plan to validate the runtime behavior described in the docs, use a Linux environment for the full end-to-end workflow.
Open the docs app
From the repository root:
cd docs/mullgate-docsInstall dependencies
If you use pnpm:
pnpm installIf you use npm:
npm installRun the docs site
pnpm devOr:
npm run devThen open the local URL shown in the terminal.
Production build
pnpm buildOr:
npm run buildWhat this installs
The documentation app uses:
- Next.js
fumadocs-corefumadocs-mdxfumadocs-ui
These packages provide the routing, MDX rendering, and navigation experience for the docs site.
Next step
Continue with Quickstart.