Osmosis Docs

Osmosis' documentation portal, built with Docusaurus.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• Support
• License

About The Project

Docusaurus is a static site generator that helps you ship beautiful, accessible docs. For building our documentation portal, we have made certain modifications over the template generated by Docusaurus to be able to properly showcase Osmosis-core, Cosmwasm and Javascript SDKs

Built With

• Docusaurus
• React
• Tailwind

Getting Started

This section describes how you can get our documentation portal up and running on your machine.

Prerequisites

• node
• npm

Installation

1. Clone the repo

git clone https://github.com/osmosis-labs/docs.git

2. Install NPM packages

npm install

3. Run the app

npm start

Usage

Writing Documentation

All documentation lives under docs/, organized into the top-level sections learn, integrate, build, validate, and community (shared images live under docs/assets/). The site uses a single Docusaurus docs instance rooted at docs/ and served at the site root, with one ordered sidebar; there is no per-section versioning. To edit a page, edit its Markdown/MDX file directly under the relevant section and run npm start to preview.

To add a new page or section

Add the Markdown/MDX file under the appropriate docs/<section>/ folder. New pages are picked up by the autogenerated sidebar in sidebars-default.js; ordering within a section is controlled by sidebar_position frontmatter and _category_.json files. To surface a new top-level section in the navbar, add an entry to the navbar.items array in docusaurus.config.js.

Adding a section to the Context Switcher

The in-sidebar section switcher is driven by the SECTIONS array in src/sections.js. To add an entry, import an icon from src/icons and add an object to the array:

import { MyIcon } from './icons';

const SECTIONS = [
  // ...
  {
    id: 'mysection',
    name: 'My Section',
    icon: MyIcon,
    section: false, // set true if it should show its own sections menu
  },
]

If you need a new icon, add it under src/icons.

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!

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 for more information.