https://github.com/tangle-network/webb-docs
Official documentation of Webb ecosystem
https://github.com/tangle-network/webb-docs
Last synced: about 1 year ago
JSON representation
Official documentation of Webb ecosystem
- Host: GitHub
- URL: https://github.com/tangle-network/webb-docs
- Owner: tangle-network
- License: mpl-2.0
- Created: 2022-02-03T19:36:03.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T09:30:30.000Z (about 2 years ago)
- Last Synced: 2025-03-29T10:24:52.999Z (about 1 year ago)
- Language: TypeScript
- Homepage: http://docs.webb.tools/
- Size: 171 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
🚀 Official Documentation of the Webb Ecosystem 🚀
❗ **Note:** This is a fork of [Vercel Docs](https://github.com/vercel/turbo/tree/main/docs).
This repository serves as the **documentation** for the **[Webb](https://www.webb.tools/)** ecosystem. The docs are written in [MDX](https://mdxjs.com/) format an extension of [markdown](https://www.markdownguide.org/), processed by [Nextra](https://github.com/shuding/nextra/tree/main), and published to Webb Docs. For support on using Nextra see [https://nextra.site/docs].(https://nextra.site/docs)
### Directory structure
| Folder | Description |
| ---------- | ------------------------------------------------------------------------------------------ |
| components | Dedicated directory for documentation related ui-components to be imported into mdx pages. |
| images | Dedicated directory for documentation related assets. |
| pages | Dedicated directory for documentation content. |
### Updating or Adding Content
For updating or adding content to the docs site, builders simply need to follow the below instructions. Please note,
if image assets are added to a given section you must provide both a dark and light version of the image.
**Updating existing content**
1. Navigate to the desired page to update (e.g. `/pages/docs/anchor-system/overview.mdx`)
2. Make applicable changes
3. Test those changes locally `yarn install && yarn dev`
**Adding content for existing section**
1. Navigate to the desired documentation section (e.g. `/pages/docs/anchor-system/`)
2. Create a new mdx file that represents new page for desired section (e.g. `advanced.mdx`)
3. Write desired content for the new mdx file
4. Update the `_meta.json` file within the section directory to include your new page into the navigation
5. Test those changes locally `yarn install && yarn dev`
**Note:** To create a section with dropdown navigation, simply create a folder and specify the new navigation in `_meta.json`, create new your new files in the new directory along with its own `_meta.json` to outline the desired
navigation.
## 🚀 Quick start
1. **Clone the repo**
```bash
# create a new folder to get going
git clone https://github.com/webb-tools/webb-docs.git
```
2. **Install dependencies**
Navigate into your new site’s directory and install all dependencies.
```bash
cd webb-docs/
yarn install
```
3. **Fire the engine**
Navigate into your new site’s directory and use the following command to start the development server locally.
```bash
yarn dev # alias for `yarn start` and `yarn develop`
```
4. **Open the code and start customizing!**
Your site is now running at `http://localhost:3000/docs`.
Edit to see your site update in real-time on save.
5. **Learn more about Nextra, Next, and nextra-theme-docs**
- [Documentation](https://nextra.site/docs)
- [Themes](https://nextra.site/docs/docs-theme)
- [Guides](https://nextra.site/docs/guide)
Contributing
Interested in contributing to the Webb Documentation? Thank you so much for your interest! We are always appreciative for contributions from the open-source community!
If you have a contribution in mind, please check out our [Contribution Guide](./.github/CONTRIBUTING.md) for information on how to do so. We are excited for your first contribution! If you have any further questions, please do not hesitate to reach out on our [Webb Discord channel](https://discord.com/invite/cv8EfJu3Tn)! We would love to get to know you and your work!
License
Licensed under MPL-2.0.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the MPL-2.0 license, shall be licensed as above, without any additional terms or conditions.