Forumify Documentation

This repository contains the documentation website for forumify as well as first party plugins.

Running locally

Ensure you have Node.js >= 22.0 installed.

Use npm to install the required dependencies:

npm install

Then start the development server:

npm run dev

Open http://localhost:3000 with your browser and you can see your changes live.

Managing pages

The documentation website uses file based routing, or as NextJS calls it, App Router. You can find all pages in the src/app/ directory.

A page located at src/app/user-manual/calendar/page.mdx would be available at /user-manual/calendar.

Pages are written in MDX, which is Markdown + React. This allows for very easy management of pages, while still being able to leverage React with complex components sprinkled in.

Contributing

Anyone is free to contribute to the documentation website. If you are documenting a new feature for which a pull request is still open in the main forumify-platform repository, please mention it in your PR.