A ready-made setup to write articles in Markdown and be able to see live preview and export the article in HTML
You can create your own GitHub repository from this template and have all the basic scaffolding under your control.
Once you created your own repo from this one, clone it locally and run
npm install to get all the necessary dependencies for testing and building your Markdown article.
This template comes with some handy scripts to make editing markdown files a nicer experience:
npm test, your
ARTICLE.md will be tested for syntax errors using
npm run preview
npm run preview, you will open an Electron window that will show a live preview of your
ARTICLE.md and it will automatically update when you make changes to the source file. This command will be using
vmd under the hood.
npm run build
npm run build:watch
npm run build, an HTMl version of the article will be created and named
ARTICLE.html. This feature is built using
This command will also use
npm pack to create an archive containing all the files related to the article so that you can easily share it with some third party.
If you wish to run the build every single time that your
ARTICLE.md changes, you can do so by running
npm run build:watch. This command will be using
chokidar-cli under the hood to watch for changes.
Licensed under MIT License. © Luciano Mammino.