Skip to content

anantakrishna/website-1

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation

Documentation for grammY. Contributions are welcome!

The logos/ directory only contains the logos of grammY and notifier/ contains translation tooling—all website-related things are in site/.

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 in the site/ directory.

cd site/

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

# Automatically formats all files directly
deno fmt

You can also run

npm run docs:fmt

in the site/ directory to perform the formatting if you don't have Deno installed.

About

Documentation for grammY.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.1%
  • SCSS 1.9%