amazingang / huff-docs

Extensive Huff Language Documentation, Tutorials, and Resources built with Vuepress and deployed at https://docs.huff.sh

huff-docs •

Huff Language Documentation built with Vuepress and deployed at docs.huff.sh.

Usage

Install dependencies by running yarn install.

Build the vuepress site by running yarn build.

To run the site locally, execute yarn dev.

In src/README.md, the home page of the site is defined. Each subdirectory in src represents a page of the site.

New Pages

To add a new page, the page contents must be written in an src subdirectory. This will host the page at https://docs.huff.sh/<page-name> but will not create an item in the navbar. In order to add the new page to the navbar, an entry must be added to the Vuepress config file located in src/.vuepress/config.js.

Page and comprehensive site styles can be defined in src/.vuepress/styles/.