Go to file

Piotr Rogowski 329deff67b Allow indexing (#65 )		2023-05-05 10:59:24 +02:00
.github	Add TypeScript	2023-03-02 12:05:47 +01:00
.vscode	Format and spelling	2023-05-04 11:53:50 +02:00
docs	Move docs to root; add icons; add PDF link to top bar	2023-05-05 10:39:48 +02:00
pdf	Update PDF	2023-05-05 10:41:41 +02:00
src	Move docs to root; add icons; add PDF link to top bar	2023-05-05 10:39:48 +02:00
static	Allow indexing (#65 )	2023-05-05 10:59:24 +02:00
.gitignore	Initial commit	2022-12-29 21:13:02 +01:00
.nvmrc	Initial commit	2022-12-29 21:13:02 +01:00
README.md	Update README	2023-04-28 10:50:52 +02:00
babel.config.js	Initial commit	2022-12-29 21:13:02 +01:00
docusaurus.config.js	Allow indexing (#65 )	2023-05-05 10:59:24 +02:00
package-lock.json	Update dependencies	2023-04-28 10:31:21 +02:00
package.json	PDF link in footer	2023-05-05 10:53:27 +02:00
sidebars.js	Rename sidebar	2023-03-02 12:01:33 +01:00
tsconfig.json	Add TypeScript	2023-03-02 12:05:47 +01:00

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 build

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

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