Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.82 KB

README.md

File metadata and controls

57 lines (36 loc) · 2.82 KB
Raw

Welcome to A4Doks

A4Doks is an open-source documentation software. With this starter template, you get a starting point to clone and run a documentation site locally.

This documentation is hosted at https://docs.a4doks.com/docs/welcome

Simplifying Documentation

At A4Doks, we're reshaping the documentation landscape. Seamlessly blend raw markdown power with shadcn's beautiful components, bringing a dynamic touch to your static content.

How to run it locally?

  1. Install dependencies and start the local server.
npm i
npm run start
  1. Open the docs on the browser from http://localhost:3000.
  2. Start editing your markdown files.

How does it work?

  1. GitHub Integration: Sign up using your GitHub account to begin.
  2. Use Our Boilerplate: Fork our essential markdown-file boilerplate repository.
  3. Edit & Enhance: Modify or add markdown files and infuse them with shadcn's custom components like checkboxes, accordions, and more.
  4. Include Custom Components: Enhance your markdowns with custom components such as checkboxes, accordions, dialogs, cards, buttons, alerts, and more. All powered by the shadcn component library.
  5. Local Preview: Experience the blend of markdown and shadcn locally with the A4Doks CLI.
  6. One-Click Deployment: Deploy your enriched documentation site to our cloud in a snap via the A4Doks CLI.
  7. Light and Dark Mode: Switch between themes for the ideal reader experience.

Free migration service

Already have documentation elsewhere? Or just a simple README on GitHub? We'll handle the migration to A4Doks at no cost, ensuring a smooth transition.

Contributing

We value each and every contributor to the A4Doks CLI! Here's how you can make a difference:

  • Report Bugs: Open an issue if you believe you've encountered a bug or something isn't working as expected.
  • Enhance the CLI: Feel free to make a pull request to add new features, make quality-of-life improvements, or fix bugs. We appreciate your help in making A4Doks CLI better for everyone.

License

A4Doks CLI is proudly open-source. It's licensed under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. For more details, please refer to the LICENSE file in the repository.

Coming Up Next

Our vision never stops. Here's a glimpse into our roadmap:

  • Custom Branding: Personalize to resonate with your brand's aura.
  • Insightful Analytics: Dive deep into user engagement and insights.
  • AI-Powered Suggestions: Elevate your content with smart recommendations.

Thank you for embracing A4Doks. Together, let's revolutionize the world of documentation!

Happy Crafting and Deploying! 📝🎨🚀