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

Make sure you have Deno installed.

Setup (once): cd into site/ and run deno task setup.

You can now run

deno task dev

to view the documentation in your browser.

Checking Correct Formatting of Docs

In addition to the VS Code 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 in the site/ directory.

cd site/

# Checks if all files are formatted correctly
deno fmt --check

# Automatically formats all files directly
deno fmt