DiSky DiSky v5.0.0-b1

How to contribute

guide

Everything you need to write and improve DiSky Atlas documentation.

Welcome! This section explains how the hand-written documentation works: how the files are laid out, how to write a page, and every rich component you can use.

  • Setup: cloning the project and the contribution rules.
  • Writing pages: file layout, frontmatter and slugs.
  • Components: every rich markdown construct, demonstrated.
  • Linking: referencing syntaxes, entities, events and other pages.
  • Style guide: how a topic page is structured, worded and referenced.
Everything is markdown

Pages are plain .md files in the en/ folder of this repository. If you can write markdown, you can contribute; the rich components are a bonus, not a requirement.

Was this page helpful?
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.