-
Notifications
You must be signed in to change notification settings - Fork 0
guidelines syntaxes
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 iscontent/. (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
You want to submit or contribute to the project? follow these steps
- Read our statements and agreements in Contributing
- Start authoring your articles!
- Tidy up your typings
And be sure to check out other document as well!
LICENSEs CONTRIBUTINGs CODE_OF_CONDUCTs
These legal documents are work in progress and does not represent the final license governing this project.
Do not rely on these documents as a grant of rights or permissions. The authoritative terms are those stated in the root LICENSE file.
- Definitions which will be mentioned often in this documentation
- License
- Contributing
- Rules or Code of Conduct
- Security
- FAQ about our legal documents
authoring are the guide about "what you write".
List of what you should fill in to your article/entry.
guidelines, especially content are the guide about "how you write / submit"
WIP
Documents how and why decision are made. go here