Dyte Docs
Dyte's documentation portal, built with Docusaurus.
Explore the docs »
View Demo · Report Bug · Request Feature
Table of Contents
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 all our SDKs with their respective versions.
We are delighted to see our documentation featured on Docusaurus Site Showcase, and hope you like it!
Built With
Getting Started
This section describes how you can get our documentation portal up and running on your machine.
Prerequisites
Installation
- Clone the repo
git clone https://github.com/dyte-in/docs.git
- Install NPM packages
npm install
- Run the app
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 and edit the required files there.
To create a new version inside a section, for example, flutter. Make your changes in 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:
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.
Say you're adding a new Go section:
{
plugins: [
// ...
[
'@docusaurus/plugin-content-docs',
{
path: 'docs/go',
routeBasePath: 'go',
id: 'go',
sidebarPath: require.resolve('./sidebars/sidebars-go.js'),
sidebarCollapsible: false,
onlyIncludeVersions: !isDev
? require('./go_versions.json')
: undefined,
},
],
]
}
After you add this, you'll need to create a sidebars file ./sidebars/sidebars-go.js.
Also add your new docs to ./docs/go, say you add introduction.mdx
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 Context Switcher, edit ./src/components/ContextSwitcher.jsx.
For example, for a section go, you will add:
import { GoIcon } from '../assets/icons';
const CONTEXTS = [
// ...
{
id: 'go',
name: 'Go',
icon: GoIcon,
},
]
You'll need to create a GoIcon component too.
That is it!
For more examples, please refer to the Docusaurus Documentation.
Version History
See CHANGELOG.
Roadmap
See the open issues for a list of proposed features (and known issues).
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!
You are requested to follow the contribution guidelines specified in CONTRIBUTING.md and code of conduct at CODE_OF_CONDUCT.md while contributing to the project
Support
Contributions, issues, and feature requests are welcome! Give a
License
Distributed under the Apache License, Version 2.0. See LICENSE for more information.
About
docs is created & maintained by Dyte, Inc. You can find us on Twitter - @dyte_io or write to us at dev [at] dyte.io.
The names and logos for Dyte are trademarks of Dyte, Inc.
We love open source software! See our other projects and our products.
18 Dec 26, 2022
165 Dec 31, 2022
2 May 20, 2022
3 Nov 4, 2022
2 Feb 3, 2022
28 Dec 20, 2022
9 Nov 21, 2022
71 Dec 11, 2022
1 Aug 30, 2022
30 Dec 29, 2022
5 Sep 14, 2022
2 Jun 13, 2022
14 Jul 10, 2022
47 Dec 20, 2022
7 Dec 1, 2022
225 Dec 22, 2022
20 Aug 16, 2022
30.5k Jan 9, 2023
22 Aug 14, 2022