Documenting projects should be a delightful endeavor. At SimpleDocs, our mission is to simplify the documentation journey. Born from the experiences of a software company, we aim to empower developers with a tool that transforms GitHub repositories into beautifully curated documentation sites. With features like OpenAPI Specification (OAS) support and one-click Azure deployments on the horizon, the future looks promising.
- Tailored for Developers: Conceived with the developer's needs in mind.
- GitHub Integration: Effortlessly link your repositories and watch SimpleDocs work its magic.
- Minimalistic Mastery: Zero in on the content; leave the presentation to us.
- Built on Angular: Harnessing the power and versatility of Angular.
- Installation:
npm install simpledocs
- Embark on Your Documentation Journey:
Set out with our Quick Start Guide.
- Customize and Conquer:
Explore the depths with our Configuration Guide.
Driving SimpleDocs is a trio of powerful frameworks and libraries:
- Angular: The backbone that provides a robust and modular architecture.
- ngx-markdown: Skillfully converting markdown content to create engaging documentation.
- Tailwind SCSS: Giving your documentation that sleek and modern design edge.
- Angular Foundation
- Markdown Handling with ngx-markdown
- Tailwind SCSS Styling
- OpenAPI Specification (OAS) Support for JSON/YAML
- One-Click Azure Deployment (Coming Soon!)
Open-source thrives on collaborative energy. Whether brainstorming features or contributing to the codebase, your involvement enriches SimpleDocs. Familiarize yourself with our CONTRIBUTING guidelines.
Help refine SimpleDocs. Browse our FAQs or share your insights via an issue on GitHub.
SimpleDocs proudly operates under the MIT License. For the specifics, head to the LICENSE section.