wiki/README.md

47 lines
874 B
Markdown
Raw Normal View History

2022-12-29 12:10:14 -08:00
# Wiki
FOME Wiki built using [Docusaurus 2](https://docusaurus.io/).
## Installation
Required [Node.js](https://nodejs.dev/) version: 16 or higher.
```bash
npm install
```
## Local Development
```bash
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.
2022-12-29 13:53:33 -08:00
Docusaurus guides: [https://docusaurus.io/docs/category/guides](https://docusaurus.io/docs/category/guides)
2022-12-29 12:10:14 -08:00
## Build
```bash
npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Generate PDF
2022-12-29 13:39:25 -08:00
Required [Prince XML](https://www.princexml.com/).
2022-12-29 12:10:14 -08:00
Build and serve docs locally before generating PDF:
```bash
npm run build
npm run serve
```
In another terminal run this to generate PDF:
```bash
npm run pdf
```