Go to file

Nathan Schulte fb7421073c test github deploy		2024-02-27 02:38:22 -06:00
.devcontainer	…
.github	Bump peter-evans/create-or-update-comment from 3 to 4 (#228 )	2024-02-19 21:20:20 +01:00
.vscode	Add DBC view (#180 )	2023-11-01 20:23:41 +01:00
docs	test github deploy	2024-02-27 02:38:22 -06:00
scripts	…
src	More concise DBC table, bump deps	2024-01-16 11:34:53 +01:00
static	…
.gitignore	…
.markdownlint.jsonc	Bump dependencies	2024-02-19 21:16:42 +01:00
.npmrc	Bump deps	2023-11-09 15:46:11 +01:00
.nvmrc	…
LICENSE	…
README.md	…
babel.config.js	…
biome.json	More concise DBC table, bump deps	2024-01-16 11:34:53 +01:00
docusaurus.config.ts	document Lua interface	2024-02-24 01:27:39 -06:00
global.d.ts	Add DBC view (#180 )	2023-11-01 20:23:41 +01:00
package-lock.json	Bump dependencies	2024-02-19 21:16:42 +01:00
package.json	Bump dependencies	2024-02-19 21:16:42 +01:00
sidebars.ts	…
tsconfig.json	…

Wiki

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

Development

FOME Wiki is built using Docusaurus 2.

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

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.

npm run lint

npm run lint:fix

npm run build

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

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/

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