{"id":16238337,"url":"https://github.com/realkarthiknair/code-to-md","last_synced_at":"2025-03-19T16:30:40.662Z","repository":{"id":42502967,"uuid":"454876603","full_name":"realKarthikNair/Code-to-md","owner":"realKarthikNair","description":"Create a single md file from a directory full of code files","archived":false,"fork":false,"pushed_at":"2023-12-26T12:57:35.000Z","size":76,"stargazers_count":15,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T08:51:27.964Z","etag":null,"topics":["automation","generator","github","markdown","markdown-generator","md","python","python-3","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/realKarthikNair.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/funding.yml","license":null,"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},"funding":{"custom":["https://coindrop.to/realkarthiknair"]}},"created_at":"2022-02-02T17:44:30.000Z","updated_at":"2025-03-16T01:28:45.000Z","dependencies_parsed_at":"2024-10-27T21:43:16.457Z","dependency_job_id":null,"html_url":"https://github.com/realKarthikNair/Code-to-md","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realKarthikNair%2FCode-to-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realKarthikNair%2FCode-to-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realKarthikNair%2FCode-to-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realKarthikNair%2FCode-to-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/realKarthikNair","download_url":"https://codeload.github.com/realKarthikNair/Code-to-md/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244463592,"owners_count":20456914,"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":["automation","generator","github","markdown","markdown-generator","md","python","python-3","python3"],"created_at":"2024-10-10T13:39:55.000Z","updated_at":"2025-03-19T16:30:40.406Z","avatar_url":"https://github.com/realKarthikNair.png","language":"Python","funding_links":["https://coindrop.to/realkarthiknair"],"categories":[],"sub_categories":[],"readme":"# **Code-to-md**\n\n*inspired from [code_to_md](https://github.com/Dinex-dev/code_to_md) by @Dinex-dev*\n\n\n## **Generate a markdown file from a folder of programs, each program numbered with the first comment as title and the rest as code block**\n\n### **1. Why?**\n\n#### To generate a file like [this](https://github.com/realKarthikNair/Learning-C-Lang/blob/main/Learning_C/F.%20Loops/1.%20For%20loops/programs0/readme.md) from a directory filled with programs.\n\n### **2. How to set-up**\n\nMethod 1: Clone the repo\n\n        git clone https://github.com/realKarthikNair/Code-to-md\n        cd Code-to-md\n\n\nMethod 2: [Download zip](https://github.com/realKarthikNair/Code-to-md/archive/refs/heads/main.zip) and extract it\n\n\n### **3. Usage**\n\n    ./code-to-md.py -idir \u003cpath-to-code-directory\u003e -e \u003cextension\u003e -odir \u003cmd-file-destination\u003e -o \u003cmd-filename\u003e\n\nfor example, \n    \n    ./code-to-md.py -idir /home/karthik/Temp/python/new/programs/ -e .py -odir /home/karthik/Temp/python/ -o programs.md\n\nTo choose \\\u003ccurrent directory/programs\\\u003e as code dir and \\\u003ccurrent directory\\\u003e as markdown location without any further prompts\n\n    ./code-to-md.py -d\n\n\u003e The script also has a CLI-based interface, so you can even skip entering path as shell arguments\n\n\u003e The default code directory is \\\u003ccurrent working directory\\\u003e/programs/ and the default output directory is \\\u003ccurrent working directory\\\u003e/\n\n\u003e I personally have this script placed at /usr/local/bin so that I can use it from anywhere\n\n\u003e Okay so that's it: Enjoy!\n\n### **4. How to reach me?**\n\n\u003cp align=\"left\"\u003e\n    \u003ca href=\"https://www.instagram.com/karthiknair.sh\" alt=\"instagram\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Instagram-%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB-yellowgreen\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.telegram.me/realkarthiknair\" alt=\"Telegram\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Telegram-%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB-orange\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.twitter.com/realkarthiknair\" alt=\"twitter\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Twitter-%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB-orange\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n### Incase you want to buy me a coffee...\n\n\u003ca slign=\"left\" href=\"https://coindrop.to/realkarthiknair\" target=\"_blank\"\u003e\u003cimg align=\"left\" src=\"https://coindrop.to/embed-button.png\" style=\"border-radius: 10px; height: 57px !important;width: 229px !important;\" alt=\"Coindrop.to me\"\u003e\u003c/img\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealkarthiknair%2Fcode-to-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frealkarthiknair%2Fcode-to-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealkarthiknair%2Fcode-to-md/lists"}