Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.68 KB

mittwald Developer Portal -- Contribution guide

Contributing docs

The main documentation files are written in Markdown or MDX (also have a look at the Docusaurus-specific Markdown features). You can find the documentation files in the following folders:

When making documentation changes, please remember to update both the English and German versions (when applicable) in the same pull request. If you are not comfortable authoring in one of these languages, feel free to still open a partial pull request and ask for help with translation.

Also, have a look at the official Docusaurus documentation on internationalization for more information.

Building locally

To build this project locally, you will need to have Node.js installed. Compatible versions are declared in the engines section in the package.json file.

You can use the following commands to build this project locally:

  • npm install to install dependencies.
  • npm start to start a development server.
  • npm run build to build a production release (this may be necessary to work with multi-lingual content).
  • npm run serve to serve a production release locally.