README.md

Markdown Beautifier

This is a toy project designed to create a semi-useful web-application that meets Lighthouse audits and is a progressive, off-line capable application.

Code quality and test coverage are secondary considerations!

Goals

• Progressive, off-line performance
• Small build size, leverage CDN versions of libraries where possible

Dependencies

This project utilizes the following open-source projects. If you find it useful, please consider donating to them:

• https://webpack.js.org/
• https://github.com/remarkjs/remark
• https://github.com/showdownjs/showdown

References

• https://developers.google.com/web/tools/lighthouse/
• https://codeburst.io/progressive-web-app-with-webpack-198b073f6c74

Getting started

• Install NPM and Yarn
• Clone this project
• Run yarn to install dependencies
• Run npm start to start up the development server
• Application is now available at localhost:8080