This is the repository for the documentation of the WFP's new HungerMap. Check out the application here and the main repository here.
This website is built using Docusaurus, a modern open-source static website generator.
This software is dual-licensed:
- Open-Source License: Distributed under the terms of the Server Side Public License (SSPL). See the
LICENSE
file for details. - Commercial License: Available for businesses requiring proprietary use. Contact the Center for Software Engineering Excellence at partners@csee.tech for more information. Failure to comply with either license will constitute a violation of intellectual property rights.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
- Add each page as a markdown file under the
/docs/docs/{category}
directory, where category is the topic this document belongs to (Frontend, Chatbot, How to, etc.). - Add the title of the page to the start of the file as a Heading 1 (with
#
) - Use the same title as the file name, but in snake_case (How to add new Event ->
how_to_add_new_event
) - Add your name to the top of the file (under the title) like this:
Author: {full name}
- Start your commit message with
docs:
(orfeat:
orfix:
if a new feature or bug fix was implemented) to pass the commitlint hook
$ yarn
$ yarn 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.
$ yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.