Skip to main content

Contributing to This Website

Quickstart​

You can click the Edit this page butto at the bottom of any page to start editing it on GitHub or you can go to ProjectNyxian/nyxian.app.

General tip

You can find more documentation at docusaurus.io.

Writing Documentation​

All folders must contain an index.mdx. These and all .mdx files directly in /docs should also contain a value for sidebar_position in the metadata.

example-doc.mdx
---
sidebar_position: 2
---

# Example Documentation

...
info

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

tip

There is a Todo list in the README

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, like the index 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.

info

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

warning

Changes to /static/bootstrap and /docs/credits.mdx will always be rejected!