Skip to main content

Contributing to this Website

Select in what environment you want to work:

Quickstart​

You can click the Edit this page button at the bottom of any page to start editing it on GitHub or you can go to emexlab/emexlab.github.io.

Github Pages​

You can find an automatic build of the newest state at https://emexlab.github.io/

tip

There is a Todo list in the README.
This is a good starting point for first time contributors.

Writing Documentation​

You should always use .mdx instead of .md.
All folders directly in a docs folder must contain an index.mdx. These and all .mdx files directly in a docs folder should also contain a value for sidebar_position in the metadata.

exampleDoc.mdx
---
sidebar_position: 2
---

# Example Documentation

...
note

Please follow the best pratices from markdownguide.org/basic-syntax

tip

You can find more documentation at docusaurus.io.
The websites github is also a good reference point: docusaurus/website

React​

You can also contribute to the website in various other ways:

  • Improving components
  • Creating new components (your component must be used in atleast on page)
  • Helping on pages, for example this page

But please restraint from using swizzling to change the website (except if it's the offical way). Always look if what you're trying to do can be achieved using classes and CSS.

note

When writing react code please follow the best pratices from react.dev

warning

Changes to /static/bootstrap and /src/pages/imprint.mdx will always be rejected!