Documentation

Documentation for grammY. Contributions are welcome!

The logos/ directory only contains the logos of grammY, all website-related things are in site/.

Contribution Guide »

Building the Website Locally

Setup (once): cd into site/ and run npm install.

You can now run

npm run docs:dev

to view the documentation in your browser.

Checking Correct Formatting of Docs

In addition to the VSCode extension that lints the Markdown, Deno formatting is used to check the formatting of markdown files and the TypeScript and JavaScript code contained in them. You can use the following two commands the site/ directory.

# Checks if all files are fomatted correctly
deno fmt --config deno.json --check

# Automatically formats all files directly
deno fmt --config deno.json

You can also run

npm run docs:fmt

to perform the formatting. Note that you still need to have Deno installed.