Cadasta FAQ

Development

Writing

FAQ entries should be written in an index.md file within a unique directory located in the src directory. The directory names are used to generate the URL for each ticket, so be concious of how it reads. As per this bug ticket, the Lunr search used by this FAQ does not like emojis. For this reason, all emojis should be added via their text representations.

Helpful Links

• Markdown Cheatsheet
• Available Emojis

Node.js

If your machine has Node.js installed, this is the recommended method of running the application.

Install/Build

npm install
npm run docs:prepare
npm start

Run development server

npm start

Docker

If you would like to avoid install Node.js on your system, this project can be run via Docker.

Install/Build

docker build -t cadasta-faq .

Run development server

Using bash (e.g. MacOS, Unix, Linux):

docker run -it -p 4000:4000 --mount source=$(pwd)/src,target=/app/src,type=bind cadasta-faq

Using Windows:

docker run -it -p 4000:4000 --mount source=%CD%/src,target=/app/src,type=bind cadasta-faq