https://github.com/outposthq/readout
Build blazing fast docs with zero configuration.
https://github.com/outposthq/readout
docs documentation documentation-generator mdx react readout theme
Last synced: 4 months ago
JSON representation
Build blazing fast docs with zero configuration.
- Host: GitHub
- URL: https://github.com/outposthq/readout
- Owner: outpostHQ
- License: mit
- Created: 2022-12-15T04:37:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-23T10:05:17.000Z (over 2 years ago)
- Last Synced: 2025-02-10T05:45:35.026Z (5 months ago)
- Topics: docs, documentation, documentation-generator, mdx, react, readout, theme
- Language: TypeScript
- Homepage:
- Size: 321 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.MD
Awesome Lists containing this project
README
# Readout
Build blazing fast docs with zero configuration.
> Note: This project is under development, do not use it in production!
## Instructions
**Step 1:** Create a docs folder in the root of any public repository. The docs folder needs to have a file named `index.mdx` inside of it.
**Step 2:** Create a `readout.config.json` file with the navigation field to generate the
TOC of the your documentation site.
## config
**navigation**:
Add mdx file in the
**sample navigation**:\*\*\*\*
```json
{
"navigation": {
"anchors": [
{ "name": "outside One", "href": "https://outpost.run" },
{ "name": "outside two", "href": "https://controlplane.com" }
]
}
}
```
You can also have navigation groups which help you group several navigation links together
```json
{
"navigation": {
"navLinks": [
{ "name": "outside One", "path": "outside_one.mdx" },
{ "name": "outside two", "path": "outside_two.mdx" }
],
"groups": [
{
"name": "one",
"navLinks": [
{ "name": "page One", "path": "first_post.mdx" },
{ "name": "page two", "path": "second_post.mdx" }
]
},
{
"name": "two",
"navLinks": [
{ "name": "page One", "path": "first_post.mdx" },
{ "name": "page two", "path": "second_post.mdx" }
]
}
]
}
}
```
## License
Readout is a project by [Outpost](https://outpost.run).
Released under the MIT License.