For all my projects, I will create a manual page (man). These manual pages are produced during the development of each project, and are used to give information to the reader, and perhaps more of an understanding of what the project is doing.

The application I use to take notes is called Notion . This is a pretty popular markdown note taking application that will work on windows / mac / IOS and Android.

Within this application, you have the ability to export your markdown as HTML too, you just have to do the following:

Click the three dots at the top right hand side of the page you're wanting to export.

Click Export

Select the "Export Format" as HTML

This will then produce a zip file with the page as html and the assets that need to be included with it to give it it's presentation, i.e. Cascading Style Sheets.

The problem I faced was that it was easy to write and present markdown for my documentation, but to retain this markdown style which can be seen in places such as GIT READMEs is quite hard. If you were to take the time to manually translate the markdown to HTML, it would be a do-able but lengthy process.

Markdown styles - Nodejs

This is where I found markdown-styles. This is a nodejs tool that will allow you to easily convert your markdown documents to HTML.

The process is simple and as follows:

Install NPM

https://www.npmjs.com/get-npm

Installing markdown-styles

sudo npm install -g markdown-styles

Using markdown-styles

mkdir input/ echo "# Hello world

YOLO" > input/index.md generate-md --layout github --input ./input --output ./output google-chrome ./output/index.html

There are many different types of layouts you can specify for your markdown to be converted to!