{"id":20882488,"url":"https://github.com/mr-sunglasses/readify","last_synced_at":"2025-05-12T18:30:58.479Z","repository":{"id":115998925,"uuid":"596603427","full_name":"Mr-Sunglasses/Readify","owner":"Mr-Sunglasses","description":"A Python tool for Rendering markdown files to your Browsers.","archived":false,"fork":false,"pushed_at":"2023-02-03T01:46:40.000Z","size":131,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-01T09:04:59.915Z","etag":null,"topics":["flask","python3","readme","rendering"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mr-Sunglasses.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-02T14:48:25.000Z","updated_at":"2023-06-25T14:34:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"253ea4b0-6cf1-4bd4-9887-d3b350173923","html_url":"https://github.com/Mr-Sunglasses/Readify","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mr-Sunglasses%2FReadify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mr-Sunglasses%2FReadify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mr-Sunglasses%2FReadify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mr-Sunglasses%2FReadify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mr-Sunglasses","download_url":"https://codeload.github.com/Mr-Sunglasses/Readify/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253797939,"owners_count":21965980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","python3","readme","rendering"],"created_at":"2024-11-18T07:32:07.947Z","updated_at":"2025-05-12T18:30:58.224Z","avatar_url":"https://github.com/Mr-Sunglasses.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readify\n\nA Python tool for Rendering markdown files to your Browsers.\n\n## Setup\n```bash\ngit clone https://github.com/Mr-Sunglasses/Readify.git \n\ncd readify\n\npython3 -m venv venv\n\nsource venv/bin/activate\n\npip3 install -r requirements.txt\n```\n\n## Usage\n```bash\ncd readify\n\npython3 readify.py --help\n\npython3 readify.py \u003cpath of the readme\u003e --port=\u003cport in which you want to serve the render README\u003e\n```\n\n# Demo images\n### help\n![Image-1](https://i.ibb.co/xfNvq99/demo-image1.png)\n### rendering Markdowns\n![Image-2](https://i.ibb.co/BwNjzg0/demo-image2.png)\n### Serving Webapp\n![Image-1](https://i.ibb.co/FmG5Kcn/demo-image3.png)\n\n\n## To add Readify to your PATH [for linux and mac users]\n```bash\ncd bin\nchmod +x readify\necho 'export PATH=\"$PATH:`pwd`/readify/bin\"' \u003e\u003e ~./bashrc\n#update current shell\nsource ~/.bashrc\n\n# to verify if Readify is working\nreadify --help\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmr-sunglasses%2Freadify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmr-sunglasses%2Freadify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmr-sunglasses%2Freadify/lists"}