Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osmosis-labs/docs
Official Documentation for Osmosis.
https://github.com/osmosis-labs/docs
blockchain docs osmosis
Last synced: 4 days ago
JSON representation
Official Documentation for Osmosis.
- Host: GitHub
- URL: https://github.com/osmosis-labs/docs
- Owner: osmosis-labs
- License: apache-2.0
- Created: 2022-02-01T18:32:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T20:22:53.000Z (7 months ago)
- Last Synced: 2024-04-14T04:05:44.275Z (7 months ago)
- Topics: blockchain, docs, osmosis
- Language: JavaScript
- Homepage: https://docs.osmosis.zone
- Size: 87.2 MB
- Stars: 28
- Watchers: 14
- Forks: 99
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ccamel - osmosis-labs/docs - Official Documentation for Osmosis. (JavaScript)
README
Osmosis Docs
Osmosis' documentation portal, built with Docusaurus and inspired by Dyte's configuration and template.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
- [About the Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Version History](#version-history)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)
- [About](#about)
## About The Project
[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
### Built With
- [Docusaurus](https://docusaurus.io/)
- [React](https://reactjs.org/)
- [Tailwind](https://tailwindcss.com/)
## Getting Started
This section describes how you can get our documentation portal up and running on your machine.
### Prerequisites
- [node](https://nodejs.org/en/)
- [npm](https://www.npmjs.com/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/osmosis-labs/docs.git
```
2. Install NPM packages
```sh
npm install
```
3. Run the app
```sh
npm start
```
## Usage
### Writing Documentation
To 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.
To 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.
After your changes are done, to create a version, run the following command:
```sh
npm run docusaurus docs:version:flutter 1.2.3
```
This will create a new version `1.2.3` for flutter.
Reference: https://docusaurus.io/docs/versioning
### To add new sections
Create a new section in docusaurus by adding a new plugin entry in [docusaurus.config.js](./docusaurus.config.js).
If you're adding a new section, just add new section to `SECTIONS[]` array with the `defineSection()` utility easily.
Now, run `npm start` and you can access your Go docs at http://localhost:3000/go/introduction
Then, you can create versions and edit older versions as mentioned above.
### Adding new docs to the Context Switcher
To add a newly created section to the Sections Menu, edit [./src/sections.js](src/sections.js).
For example, for a section go, you will add:
```jsx
import { GoIcon } from '../assets/icons';
const SECTIONS = [
// ...
{
id: 'go',
name: 'Go',
icon: GoIcon,
section: false, // if it shouldn't have a sections menu
},
]
```
You'll need to create a GoIcon component too.
That is it!
## Contributing
Contributions 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)!
## Support
Contributions, issues, and feature requests are welcome!
Give a ⭐️ if you like this project!
## License
Distributed under the Apache License, Version 2.0. See [`LICENSE`](./LICENSE) for more information.