mirror of https://github.com/lukechilds/docs.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alejandro Criado-Pérez
9a296f8d84
|
3 years ago | |
|---|---|---|
| .github | 3 years ago | |
| .vale/styles | 3 years ago | |
| lib | 3 years ago | |
| public | 3 years ago | |
| src | 3 years ago | |
| types | 4 years ago | |
| .eslintrc.js | 3 years ago | |
| .gitignore | 4 years ago | |
| .gitpod.yml | 4 years ago | |
| .prettierrc | 4 years ago | |
| .vale.ini | 3 years ago | |
| .vercelignore | 4 years ago | |
| README.md | 3 years ago | |
| babel.config.js | 4 years ago | |
| mlc_config.json | 3 years ago | |
| next-env.d.ts | 3 years ago | |
| next.config.js | 3 years ago | |
| package.json | 3 years ago | |
| tsconfig.json | 4 years ago | |
| yarn.lock | 3 years ago | |
README.md
Stacks documentation
Running and building the site locally
If you are interested in contributing to the site and making changes, please refer to our contributing guide here.
Generated documentation
Style checks
This repository uses vale to run style checks. Make sure to install the tool and run the following command before creating a PR in order to check for styling issues:
yarn check:style
Stacks CLI reference
The src/_data/cli-reference.json file is generated from the stx subcommand docs.
-
Install the latest version of the cli according to the instructions at: https://github.com/hirosystems/stacks.js/tree/master/packages/cli
-
Generate the json for the cli in the
docs.stacksrepo.stx docs > src/_data/cli-reference.json
Clarity Reference
There is a json file that is generated via the stacks-blockchain repo, which automatically brings it over to this repo
via a github action.