README.md

Wiki

This is the source code for the FOME Wiki - wiki.fome.tech.

Development

FOME Wiki is built using Docusaurus 2.

Installation

Required Node.js is defined in .nvmrc. If you use nvm, run nvm use to switch to the correct version.

To install dependencies, run:

npm install

Local Development

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Docusaurus guides: https://docusaurus.io/docs/category/guides

Lint code

npm run lint

npm run lint:fix

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Redirection

Some addresses have client-side redirection set up here: docusaurus.config.js (section redirects: [...]).

Those addresses come from the INI files (TS & HT). This gives more flexibility when wiki pages are moved or renamed.

Example:

https://wiki.fome.tech/r/fuel -> https://wiki.fome.tech/category/fuel/

Generate PDF

Required Prince XML.

Build and serve docs locally before generating PDF:

npm run build
npm run serve

In another terminal, run this to generate PDF:

npm run pdf