https://github.com/jana-marie/pinknote

a very simple single page markdown webpage generator
https://github.com/jana-marie/pinknote

css markdown web

Last synced: about 1 year ago
JSON representation

a very simple single page markdown webpage generator

• Host: GitHub
• URL: https://github.com/jana-marie/pinknote
• Owner: Jana-Marie
• Created: 2025-05-13T08:08:30.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-05-14T20:37:47.000Z (about 1 year ago)
• Last Synced: 2025-05-24T01:51:57.644Z (about 1 year ago)
• Topics: css, markdown, web
• Language: CSS
• Homepage: https://pinknote.janamarie.dev
• Size: 14.9 MB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# pinknote

---

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.

![pinknote logo](assets/pinknote.png)

#### why?

because I enjoyed it! :3 There are probably hundreds of such projects out there, but doing it myself was fun!

## Demo

This projects description is hosted at [pinknote.janamarie.dev](https://pinknote.janamarie.dev), compiled by pinknote!

## Usage

To generate a web-page you just need a Markdown file, render it via

    ./generate.py 

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 ` parameter.

### Themes

To choose a different theme, a different CSS file you can use the option `-css static/css/.css`, thee following are currently inlcuded.

  

    
clean

    
pinknote

    
mint

  

  

    

    

    

    

    

    

  

  

    --css static/css/clean.css

    --css static/css/pinknote.css

    --css static/css/mint.css

  

  

    
sunset

    
code

    
banana

  

  

    

    

    

    

    

    

  

  

    --css static/css/sunset.css

    --css static/css/code.css

    --css static/css/banana.css

  


I would love to see more themes contributed! :3

## Files

```

  ./ 

    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

```

## Todo

 - [x] Set proper website title and meta var

 - [ ] Make JS package optional