Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.91 KB

README.md

File metadata and controls

33 lines (21 loc) · 1.91 KB

Welcome to A4Doks

Dive into A4Doks, where the robustness of markdown meets the elegance of the shadcn component library. Craft, customize, and deploy stunning documentation websites effortlessly.

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 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.

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! 📝🎨🚀