Skip to content

guidelines syntaxes

GitHub Action edited this page Aug 28, 2026 · 3 revisions

Writing Syntaxes

Markdown

Most of the documents here are hardly-rich formatted Markdown Text. so sadly it will be very hard to read without proper third party extensions

We currenlty use static site generator, and it is Quartz. Quartz are based on Obsidian markdown, so go learning some obsidian scripts.

  • Obsidian, Chronicler (Not Yet), Github flavoured markdown, but

  • Avoid long line and making textwrap, by at least Putting every sentence of a paragraph in new line.

  • We use ABSOLUTE link resolution, therefore, the root of all link of content/ directory is content/. (eg. content/ is the first / in a link.)

  • It is best to keep the YAML frontmatter as your single source for the page title and start all body content sections at ## Heading 2 and below (### Heading 3)

  • Detailed and Complicated tabular information should be saved into html

Navigate from here!

You want to submit or contribute to the project? follow these steps

  1. Read our statements and agreements in Contributing
  2. Start authoring your articles!
  3. Tidy up your typings

And be sure to check out other document as well!

Our Legal Documents

WIP

About the World

Guidelines

Articles about Worldbuilding

WIP

Clone this wiki locally