Yaml Markdown To Html

screenshot of Yaml Markdown To Html

:fax: “Bring your own libraries“ ~100 LOC static site generator

Overview

If you're looking to effortlessly convert Markdown files into beautifully structured HTML, the yaml-markdown-to-html tool is an innovative solution. Designed as a static site generator, it offers a simple yet powerful command-line interface that allows you to leverage your favorite libraries for rendering. With just a few configurations, you can transform a folder of Markdown files complete with YAML front matter into polished HTML output.

One of the standout features is its flexibility; you have the freedom to integrate any markdown and rendering library of your choice. Whether you need to fetch data from APIs or incorporate various asynchronous processes, this CLI tool is designed to accommodate your needs seamlessly. If you're a developer aiming for customization without compromising on simplicity, this tool is certainly worth your attention.

Features

  • Bring Your Own Libraries: Flexibly use any markdown and rendering libraries you prefer, allowing tailored setups for your projects.
  • Async Render Function: Simply provide an asynchronous function that takes raw Markdown and converts it into HTML, making the process straightforward.
  • User-Friendly CLI: The command line interface simplifies the integration process, accepting source, destination, and render folders effortlessly.
  • Metadata Access: Each file processed receives its parsed metadata alongside the raw Markdown string, enabling deeper customization.
  • Post-Rendering Options: The ability to define a post-render function allows for additional processing after all files are rendered.
  • Promise-Based Output: The generator optimally utilizes Promises, ensuring that the generated HTML is ready only when all asynchronous operations are complete.
  • MIT License: Open to use and modify under the MIT License, making it a community-friendly choice for developers.