{"id":13565678,"url":"https://github.com/osmosis-labs/docs","last_synced_at":"2025-04-04T21:10:55.877Z","repository":{"id":37084737,"uuid":"454505230","full_name":"osmosis-labs/docs","owner":"osmosis-labs","description":"Official Documentation for Osmosis. ","archived":false,"fork":false,"pushed_at":"2025-04-02T17:32:14.000Z","size":96806,"stargazers_count":28,"open_issues_count":17,"forks_count":105,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-04-03T13:57:52.159Z","etag":null,"topics":["blockchain","cosmos","docs","osmosis"],"latest_commit_sha":null,"homepage":"https://docs.osmosis.zone","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osmosis-labs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-01T18:32:49.000Z","updated_at":"2025-04-02T17:29:48.000Z","dependencies_parsed_at":"2023-10-25T09:52:05.591Z","dependency_job_id":"e2c3387b-c5d2-4200-8a49-11b7fa9c7420","html_url":"https://github.com/osmosis-labs/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmosis-labs%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmosis-labs%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmosis-labs%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osmosis-labs%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osmosis-labs","download_url":"https://codeload.github.com/osmosis-labs/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249532,"owners_count":20908212,"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":["blockchain","cosmos","docs","osmosis"],"created_at":"2024-08-01T13:01:52.811Z","updated_at":"2025-04-04T21:10:54.834Z","avatar_url":"https://github.com/osmosis-labs.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://osmosis.zone\"\u003e\n    \u003cimg src=\"static/img/osmosis-docs-card.png\" alt=\"Logo\" width=\"120\"\u003e\n  \u003c/a\u003e\n\n  \u003ch2 align=\"center\"\u003eOsmosis Docs\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Osmosis' documentation portal, built with Docusaurus and inspired by \u003ca href=\"https://github.com/dyte-in/docs\"\u003eDyte's \u003c/a\u003e configuration and template.\n    \u003cbr /\u003e\n    \u003ca href=\"https://docs.osmosis.zone\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://docs.osmosis.zone\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/osmosis-labs/docs/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/osmosis-labs/docs/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n## Table of Contents\n\n- [About the Project](#about-the-project)\n  - [Built With](#built-with)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Usage](#usage)\n- [Version History](#version-history)\n- [Roadmap](#roadmap)\n- [Contributing](#contributing)\n- [Support](#support)\n- [License](#license)\n- [About](#about)\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n[Docusaurus](https://docusaurus.io/) is a static site generator that helps you ship beautiful, accessible docs. For building our [documentation](https://docs.osmosis.zone) portal, we have made certain modifications over the template generated by [Docusaurus](https://docusaurus.io) to be able to properly showcase Osmosis-core, Cosmwasm and Javascript SDKs\n\n### Built With\n\n- [Docusaurus](https://docusaurus.io/)\n- [React](https://reactjs.org/)\n- [Tailwind](https://tailwindcss.com/)\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nThis section describes how you can get our documentation portal up and running on your machine.\n\n### Prerequisites\n\n- [node](https://nodejs.org/en/)\n- [npm](https://www.npmjs.com/)\n\n### Installation\n\n1. Clone the repo\n\n```sh\ngit clone https://github.com/osmosis-labs/docs.git\n```\n\n2. Install NPM packages\n\n```sh\nnpm install\n```\n\n3. Run the app\n\n```sh\nnpm start\n```\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n## Usage\n\n\u003c!-- In usage, mention how to edit the docs, how to update versions, etc. --\u003e\n\n### Writing Documentation\n\nTo just edit older documentation, go to the specified versioned folder for a section, for example, you want to edit documentation for React SDK v0.25.x, open up [react_versioned_docs/version-0.25.x](./react_versioned_docs/version-0.25.x) and edit the required files there.\n\nTo create a new version inside a section, for example, flutter. Make your changes in [docs/flutter](./docs/flutter). The `./docs` folder consists of the `next` version, which is unpublished, and is where you add your newer or _next_ version of documentation.\n\nAfter your changes are done, to create a version, run the following command:\n\n```sh\nnpm run docusaurus docs:version:flutter 1.2.3\n```\n\nThis will create a new version `1.2.3` for flutter.\n\nReference: https://docusaurus.io/docs/versioning\n\n### To add new sections\n\nCreate a new section in docusaurus by adding a new plugin entry in [docusaurus.config.js](./docusaurus.config.js).\n\nIf you're adding a new section, just add new section to `SECTIONS[]` array with the `defineSection()` utility easily.\n\nNow, run `npm start` and you can access your Go docs at http://localhost:3000/go/introduction\n\nThen, you can create versions and edit older versions as mentioned above.\n\n### Adding new docs to the Context Switcher\n\nTo add a newly created section to the Sections Menu, edit [./src/sections.js](src/sections.js).\n\nFor example, for a section go, you will add:\n\n```jsx\nimport { GoIcon } from '../assets/icons';\n\nconst SECTIONS = [\n  // ...\n  {\n    id: 'go',\n    name: 'Go',\n    icon: GoIcon,\n    section: false, // if it shouldn't have a sections menu\n  },\n]\n```\n\nYou'll need to create a GoIcon component too.\n\nThat is it!\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Sincere thanks to all our contributors. Thank you, [contributors](https://github.com/osmosis-labs/docs/graphs/contributors)!\n\n## Support\n\nContributions, issues, and feature requests are welcome!\nGive a ⭐️ if you like this project!\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the Apache License, Version 2.0. See [`LICENSE`](./LICENSE) for more information.\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosmosis-labs%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosmosis-labs%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosmosis-labs%2Fdocs/lists"}