DEV Community

Cover image for Markdown to website in one command, without any configuration - Free & open source: discover Compiiile
Alban
Alban

Posted on

Markdown to website in one command, without any configuration - Free & open source: discover Compiiile

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.

Top comments (0)