DEV Community 👩‍💻👨‍💻

🌌 Sébastien Feugère ☔
🌌 Sébastien Feugère ☔

Posted on • Updated on

Writing HTML in Markdown

This is a very quick comment about this interesting blog post about CMS and site generators that I saw this morning in the WebOps Weekly newsletter.

It totally makes sense: either you can write with a WYSIWYG editor like Seamonkey, or write in Markdown and just convert to HTML with Pandoc using a oneliner:

pandoc 2019-06-27.md -f markdown -t html -s -o 2019-06-27.html
Enter fullscreen mode Exit fullscreen mode

And then, just trash the whole thing to your website.

Top comments (0)

Timeless DEV post...

How to write a kickass README

Arguably the single most important piece of documentation for any open source project is the README. A good README not only informs people what the project does and who it is for but also how they use and contribute to it.

If you write a README without sufficient explanation of what your project does or how people can use it then it pretty much defeats the purpose of being open source as other developers are less likely to engage with or contribute towards it.