Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/polkadot-developers/substrate-docs
Substrate Developer Hub. Substrate is powered by best in class cryptographic research and comes with peer to peer networking, consensus mechanisms, and much more.
https://github.com/polkadot-developers/substrate-docs
blockchain documentation gatsby gatsbyjs lunrjs substrate tailwindcss
Last synced: about 1 month ago
JSON representation
Substrate Developer Hub. Substrate is powered by best in class cryptographic research and comes with peer to peer networking, consensus mechanisms, and much more.
- Host: GitHub
- URL: https://github.com/polkadot-developers/substrate-docs
- Owner: polkadot-developers
- License: 0bsd
- Created: 2021-07-27T09:04:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T06:14:09.000Z (about 2 months ago)
- Last Synced: 2024-09-29T14:24:18.821Z (about 1 month ago)
- Topics: blockchain, documentation, gatsby, gatsbyjs, lunrjs, substrate, tailwindcss
- Language: JavaScript
- Homepage: https://docs.substrate.io
- Size: 244 MB
- Stars: 129
- Watchers: 9
- Forks: 271
- Open Issues: 279
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Substrate Docs
https://docs.substrate.io
## Contributing
Thank you for your interest in contributing to documentation for Substrate!
As a member of the community, you are invited and encouraged to contribute by submitting issues, offering suggestions for improvements to existing content in the form of a pull request, adding review comments to existing pull requests and issues, proposing new content, or creating new pull requests to fix issues or provide new content.
### Working with `/docs` content
#### URL paths
All `.md` files added to `./content/md/en/docs/` folder will output an URL path without the `/docs` prefix, eg.:
- `index.md` for a category page : `./content/md/en/docs/reference/index.md` → `/reference/`
- `.md` for an article in its parent category `./content/md/en/docs/reference/glossary.md` → `/reference/glossary/`
You can use any structure nesting needed, there is no limit of depth.
#### Media / Images
- use `./content/media/images/docs/` folder for images to be included in `/docs/*/*.md` files
- source images in `.md`: `/media/images/docs/path/to/your/image/.ext`
#### Navigation config
- update `./content/config/nav.yaml` to add or amend items and linking to your content
- an exception being `./content/md/en/docs/reference/how-to-guides/...` files that should _only_ be listed on the main how-to guide page in the index page for these pages: `./content/md/en/docs/reference/how-to-guides/index.md`, not to be included in the sidebar.
This config file is used to generate sidebar menu where:
- menu is populated from the `menu` sequence (respecting order)
- menu supports three level hierarchy
- menu accepts external links, eg.: `https://substrate.io`
## Local Development
### Install
Navigate into your cloned local repo directory and install all dependencies.
```shell
# https://github.com/nvm-sh/nvm is suggested, so that you
# switch to the correct version of node set in the .nvmrc file
nvm i
# Install dependencies
yarn
```
**gatsby-plugin-substrate submodule**
This website uses a submodule for shared components. To set it up please refer to the [gatsby-plugin-substrate repository](https://github.com/paritytech/gatsby-plugin-substrate#troubleshooting).
```shell
git submodule update --init --recursive
```
To update the submodule to the latest main branch, run:
```shell
git submodule update --remote
```
**Configure environment variables**
Copy `example.env.development` into a new `.env.development` file.
```shell
cp example.env.development .env.development
```
Config URL variables based on your preferable local setup.
URL will be used for links generation between Substrate websites.
Default localhost port configuration:
```env
GATSBY_WEBSITE_URL=http://localhost:8100
GATSBY_DOCS_URL=http://localhost:8200
```
**Start development server**
Navigate into your new site’s directory and use the following command to start the development server locally.
```shell
yarn develop
```
**Troubleshooting**
It is sometimes the case that gastby's cache gets corrupted when making changes.
If you run into issues in local development, try to clean this and restart:
```shell
yarn clean
yarn develop
```
## Security
Please report _security_ bugs as stated in the [`static/security.txt` file](static/security.txt) in
this repository.
## License
TBD, please open an issue to request any use outside of the official host https://docs.substrate.io/ at this time.