https://github.com/mr-sunglasses/readify

A Python tool for Rendering markdown files to your Browsers.
https://github.com/mr-sunglasses/readify

flask python3 readme rendering

Last synced: 2 months ago
JSON representation

A Python tool for Rendering markdown files to your Browsers.

• Host: GitHub
• URL: https://github.com/mr-sunglasses/readify
• Owner: Mr-Sunglasses
• License: gpl-3.0
• Created: 2023-02-02T14:48:25.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-03T01:46:40.000Z (almost 2 years ago)
• Last Synced: 2024-06-11T21:29:07.456Z (8 months ago)
• Topics: flask, python3, readme, rendering
• Language: Python
• Homepage:
• Size: 128 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Readify

A Python tool for Rendering markdown files to your Browsers.

## Setup

```bash

git clone https://github.com/Mr-Sunglasses/Readify.git 

cd readify

python3 -m venv venv

source venv/bin/activate

pip3 install -r requirements.txt

```

## Usage

```bash

cd readify

python3 readify.py --help

python3 readify.py  --port=

```

# Demo images

### help

![Image-1](https://i.ibb.co/xfNvq99/demo-image1.png)

### rendering Markdowns

![Image-2](https://i.ibb.co/BwNjzg0/demo-image2.png)

### Serving Webapp

![Image-1](https://i.ibb.co/FmG5Kcn/demo-image3.png)

## To add Readify to your PATH [for linux and mac users]

```bash

cd bin

chmod +x readify

echo 'export PATH="$PATH:`pwd`/readify/bin"' >> ~./bashrc

#update current shell

source ~/.bashrc

# to verify if Readify is working

readify --help

```