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.

33 lines
1.2 KiB

4 years ago
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/blockstack/docs)
# Stacks documentation
![A screenshot of docs.blockstack.org](/public/images/docs-homepage.png)
## 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](https://docs.blockstack.org/ecosystem/contributing).
## Generated documentation
### Blockstack CLI reference
The `src/_data/cli-reference.json` file is generated from the `blockstack-cli` subcommand `docs`.
4 years ago
1. Install the latest version of the cli according to the instructions at: https://github.com/blockstack/stacks.js/tree/master/packages/cli
2. Generate the json for the cli in the `docs.blockstack` repo.
```
$ blockstack-cli 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.
### FAQs
All of the FAQs found at `/reference/faqs` are pulled dynamically from the zendesk api and rendered in this project.