Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/souporserious/omnidoc
Documentation That Matches the Quality of Your Product
https://github.com/souporserious/omnidoc
Last synced: 2 months ago
JSON representation
Documentation That Matches the Quality of Your Product
- Host: GitHub
- URL: https://github.com/souporserious/omnidoc
- Owner: souporserious
- License: agpl-3.0
- Created: 2022-12-06T08:46:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T08:50:10.000Z (2 months ago)
- Last Synced: 2024-08-30T13:12:00.965Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.96 MB
- Stars: 382
- Watchers: 5
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Documentation That Matches the Quality of Your Product
Meticulously crafted React components and utilities, designed to elevate every stage of your JavaScript documentation.
## Features
- 📝 Quickly start authoring MDX
- ✅ Type-check content
- 📘 Generate type documentation
- 📊 Gather module metadata
- 🖼️ Preview source code examples
- 📁 Generate file-based routes
- 🌈 Accurately highlight code blocks
## Getting Started
```bash
npm install omnidoc
```
After installing the package and required dependencies, you can start creating content or documentation using any framework that supports React Server Components.
To get started, use the `createCollection` function to render a collection of files from the file system:
```tsx
import { createCollection } from 'omnidoc/collections'
const posts = createCollection('docs/*.mdx')
export default async function Page({ params }) {
const Content = await posts
.getSource(params.slug)
.getDefaultExport()
.getValue()
return
}
```
There are many different components to help facilitate writing technical content. Visit the [site](https://omnidoc.dev) to view the full documentation and learn more about the features and capabilities of Omnidoc.
## License
[AGPLv3](/LICENSE.md) © [souporserious](https://souporserious.com/)