Giter VIP home page Giter VIP logo

website's Introduction

Documentation

Documentation for grammY. Contributions are welcome!

The logos/ directory only contains the logos of grammY, 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

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

website's People

Contributors

knorpelsenf avatar winglim avatar roj1512 avatar linbuxiao avatar puffmeow avatar taotie111 avatar slavafomin avatar calsibotdev avatar satont avatar heeroml avatar edjopato avatar quadratz avatar habemuscode avatar backmeupplz avatar andrrms avatar knightniwrem avatar code-withashish avatar kidonng avatar dcdunkan avatar amir-zouerami avatar chimit avatar emidio21 avatar dzek69 avatar ochui avatar xmlhexagram avatar deptyped avatar abdollahzadehali avatar waptik avatar pavelpolyakov avatar fatalmerlin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.