We know how hard it is to produce and maintain comprehensive, accessible and feature-rich documentation for your project's users. To help the community, we are available to host external Open Source projects at opensource.deepmedia.io/community, rendered with our documentation engine, with your logo and color palette.
json{
"name": "SampleProject",
"description": "A sample project to showcase the manifest file to be provided for free community doc hosting.",
"repo": "username/SampleProject",
"provider": "github",
"logo": "/logo-sampleproject-512x512.png",
"version": "1.0.0",
"tag": "v1.0.0",
"docs": "./docs",
"revisions": [{
"version": "1.0.0 (beta)",
"tag": "v1.0.0-beta"
}, {
"version": "0.1.0",
"tag": "v0.1.0"
}]
}
Our documentation engine can be seen in action on any of our own projects and has built-in support for:
- Versioned documentation
- Multiplatform pages and blocks
- Downloadable assets
- Code highlighting
- Project-wide, full text search
- Dark / light theme
- Images
- GitHub Flavored Markdown
All we need is a JSON manifest file: the engine will pull your documentation, written as Markdown files, from the GitHub repo you specify. Get in touch to get more info!