pinknote is a simple Markdown to HTML renderer, that includes simple CSS and JS templates to render a web-page, ready for deployment from just a markdown file. It comes with a basic light & dark theme mode, respects the users theme preference and is accessible via mobile.
because I enjoyed it! :3 There are probably hundreds of such projects out there, but doing it myself was fun!
This projects description is hosted at pinknote.janamarie.dev, compiled by pinknote!
To generate a web-page you just need a Markdown file, render it via
./generate.py <Markdown>
With no additional paramets the HTML file will be put into www/ and your assets into www/assets/. You can change this by passing the -o <output-path> parameter.
To choose a different theme, a different CSS file you can use the option -css static/css/<theme>.css, thee following are currently inlcuded.
| --css static/css/clean.css | --css static/css/pinknote.css | --css static/css/mint.css | |||
| --css static/css/sunset.css | --css static/css/code.css | --css static/css/banana.css | |||
I would love to see more themes contributed! :3
./
assets/ - Contains the Image files for this repo
static/
assets/ - Put your assets in here
css/ - Themes, stylesheets
index.js - The light-dark theme selector, put your additional JS in here
templates/ - index.html template
generate.py - The generator itself, run this to render your Markdown file
README.md - This file
- Set proper website title and meta var
- Make JS package optional