Compiiile (https://github.com/compiiile/compiiile) is the most convenient way to render and deploy a folder containing markdown files.

  • 📦 No config required, everything just works out of the box, without changing your files (resolves images and relative links (cross-references), print-ready rendering, ☀️ light and 🌛 dark themes)
  • 🌱 Available everywhere with static files deployment: just host it somewhere and access it in any browser on your computer, phone or whatever you are using
  • 🔗 Quick access to your files via the navbar and links to the previous and next file (with table of content generation)
  • 📺 Display some files as slides
  • 🔍 Full-text quick search with content preview
  • ⚡️ Hot-reload content preview as you edit it
  • 🎉 Supports MDX files: add your own components to your documentation
  • 💡 Can serve as knowledge base, and handles symlinks to reuse content
  • 🔧 Customizable by env variables or config file, it's up to you

🌟 You get it, it simply does the job, period.