https://github.com/rocity/readmegen

A Flask app that lets me generate Markdown files that has a "title" and a "list".
https://github.com/rocity/readmegen

Last synced: about 1 month ago
JSON representation

A Flask app that lets me generate Markdown files that has a "title" and a "list".

• Host: GitHub
• URL: https://github.com/rocity/readmegen
• Owner: rocity
• License: mit
• Created: 2016-09-28T05:35:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-09-28T05:37:44.000Z (over 9 years ago)
• Last Synced: 2025-09-02T10:44:45.773Z (9 months ago)
• Language: HTML
• Homepage:
• Size: 76.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Readmegen

A Flask app that lets me generate Markdown files that has a "title" and a "list".

# Install

- `pip install -r requirements.txt`

- `export FLASK_APP=main.py`

    - On Windows: `set FLASK_APP=main.py`

- `flask run`

# Why did you create this?

To create notes on directories that I created. I always lose track on what I put inside folders.

Here's a view of an example folder

![Folder view](docs/img/ss1.png)

The content of the MD file in that folder

![MD Code](docs/img/ss2.png)

I have a Markdown Viewer extension on my browser, so I can also view the Markdown file's neatly formatted output

![MD Preview](docs/img/ss3.png)

# License

This software is licensed under [The MIT License](./LICENSE).