markdownViewer/README.md
2025-03-21 11:28:15 +01:00

29 lines
679 B
Markdown

## flask markdownViewer
### running the project
##### **Dependencies**
- python3
- git
```bash
git clone https://git.k4li.de/pika/markdownViewer.git && cd markdownViewer
pip install -r requirements.txt
python3 run.py
```
> Just clone the repo, install the dependencies by the requirements.txt file and run the webapp!
### features
- **Upload your markdown files and display them in a styled way**
- **Host links or files for display purposes**
## todo
- **Login**: Make it, so that you can only add new things when logged in
- **Update**: Update current markdown files to display new content
- **Fetching**: Fetch .md from plain text links to display them dynamically