{"id":22799961,"url":"https://github.com/tangle-network/webb-docs","last_synced_at":"2025-04-19T16:50:32.327Z","repository":{"id":37075189,"uuid":"455302309","full_name":"tangle-network/webb-docs","owner":"tangle-network","description":"Official documentation of Webb ecosystem","archived":false,"fork":false,"pushed_at":"2024-03-19T09:30:30.000Z","size":178959,"stargazers_count":4,"open_issues_count":15,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T10:24:52.999Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.webb.tools/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tangle-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-03T19:36:03.000Z","updated_at":"2024-01-12T06:45:17.000Z","dependencies_parsed_at":"2024-03-19T10:54:28.404Z","dependency_job_id":null,"html_url":"https://github.com/tangle-network/webb-docs","commit_stats":null,"previous_names":["tangle-network/webb-docs"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangle-network%2Fwebb-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangle-network%2Fwebb-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangle-network%2Fwebb-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangle-network%2Fwebb-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tangle-network","download_url":"https://codeload.github.com/tangle-network/webb-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249742034,"owners_count":21318830,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-12T07:10:35.642Z","updated_at":"2025-04-19T16:50:32.308Z","avatar_url":"https://github.com/tangle-network.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://www.webb.tools/\"\u003e\n    \n![Webb Logo](.github/assets/webb_banner_light.png#gh-light-mode-only)\n![Webb Logo](.github/assets/webb_banner_dark.png#gh-dark-mode-only)\n  \u003c/a\u003e\n  \u003c/div\u003e\n\u003cp align=\"left\"\u003e\n    \u003cstrong\u003e🚀 Official Documentation of the Webb Ecosystem 🚀 \u003c/strong\u003e\n\u003c/p\u003e\n\n\u003c!-- Badges --\u003e\n\n\u003c!-- Description --\u003e\n\n❗ **Note:** This is a fork of [Vercel Docs](https://github.com/vercel/turbo/tree/main/docs).\n\nThis 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)\n\n### Directory structure\n\n| Folder     | Description                                                                                |\n| ---------- | ------------------------------------------------------------------------------------------ |\n| components | Dedicated directory for documentation related ui-components to be imported into mdx pages. |\n| images     | Dedicated directory for documentation related assets.                                      |\n| pages      | Dedicated directory for documentation content.                                             |\n\n### Updating or Adding Content\n\nFor updating or adding content to the docs site, builders simply need to follow the below instructions. Please note,\nif image assets are added to a given section you must provide both a dark and light version of the image.\n\n**Updating existing content**\n\n1. Navigate to the desired page to update (e.g. `/pages/docs/anchor-system/overview.mdx`)\n2. Make applicable changes\n3. Test those changes locally `yarn install \u0026\u0026 yarn dev`\n\n**Adding content for existing section**\n\n1. Navigate to the desired documentation section (e.g. `/pages/docs/anchor-system/`)\n2. Create a new mdx file that represents new page for desired section (e.g. `advanced.mdx`)\n3. Write desired content for the new mdx file\n4. Update the `_meta.json` file within the section directory to include your new page into the navigation\n5. Test those changes locally `yarn install \u0026\u0026 yarn dev`\n\n**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\nnavigation.\n\n## 🚀 Quick start\n\n1.  **Clone the repo**\n\n    ```bash\n    # create a new folder to get going\n    git clone https://github.com/webb-tools/webb-docs.git\n    ```\n\n2.  **Install dependencies**\n\n    Navigate into your new site’s directory and install all dependencies.\n\n    ```bash\n    cd webb-docs/\n    yarn install\n    ```\n\n3.  **Fire the engine**\n\n    Navigate into your new site’s directory and use the following command to start the development server locally.\n\n    ```bash\n    yarn dev # alias for `yarn start` and `yarn develop`\n    ```\n\n4.  **Open the code and start customizing!**\n\n    Your site is now running at `http://localhost:3000/docs`.\n\n    Edit to see your site update in real-time on save.\n\n5.  **Learn more about Nextra, Next, and nextra-theme-docs**\n\n    - [Documentation](https://nextra.site/docs)\n    - [Themes](https://nextra.site/docs/docs-theme)\n    - [Guides](https://nextra.site/docs/guide)\n\n\u003ch2 id=\"contribute\"\u003e Contributing \u003c/h2\u003e\n\nInterested in contributing to the Webb Documentation? Thank you so much for your interest! We are always appreciative for contributions from the open-source community!\n\nIf 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!\n\n\u003ch2 id=\"license\"\u003e License \u003c/h2\u003e\n\nLicensed under \u003ca href=\"LICENSE\"\u003eMPL-2.0\u003c/a\u003e.\n\nUnless 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.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftangle-network%2Fwebb-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftangle-network%2Fwebb-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftangle-network%2Fwebb-docs/lists"}