{"id":19136530,"url":"https://github.com/dsmith73/make-md","last_synced_at":"2026-04-18T00:32:13.709Z","repository":{"id":215628539,"uuid":"253475676","full_name":"dsmith73/make-md","owner":"dsmith73","description":"make-md takes a code file, passed as a var during playbook invocation, pulls the comments out of the file, and created a markdown file template, to increase efficiency in code documentation.","archived":false,"fork":false,"pushed_at":"2024-07-11T10:53:02.000Z","size":29,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-22T18:20:28.046Z","etag":null,"topics":["code","comment","generate","markdown","template"],"latest_commit_sha":null,"homepage":"","language":"Go","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/dsmith73.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2020-04-06T11:21:08.000Z","updated_at":"2024-07-11T10:53:05.000Z","dependencies_parsed_at":"2024-11-09T06:34:43.102Z","dependency_job_id":null,"html_url":"https://github.com/dsmith73/make-md","commit_stats":null,"previous_names":["dsmith73/make-md"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dsmith73/make-md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsmith73%2Fmake-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsmith73%2Fmake-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsmith73%2Fmake-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsmith73%2Fmake-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsmith73","download_url":"https://codeload.github.com/dsmith73/make-md/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsmith73%2Fmake-md/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31951304,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T17:29:20.459Z","status":"ssl_error","status_checked_at":"2026-04-17T17:28:47.801Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["code","comment","generate","markdown","template"],"created_at":"2024-11-09T06:34:37.666Z","updated_at":"2026-04-18T00:32:13.654Z","avatar_url":"https://github.com/dsmith73.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":" # Make MD Template  \r\n  \r\n \u003e This playbook will take a code file, passed as a var during execution, pull the comments out of the file, and create a markdown template file in the same directory as the code file. The purpose is to reduce effort of documenting code, and providing a simple outline to guide you through the process.  \r\n  \r\n_The base of this file was generated with_ ***make-md***  \r\n\r\n---\r\n\r\n ### Usage:  \r\n  \r\n `ansible-playbook make_md_template.yml -e \"code_file=\u003cpath to file\u003e/\u003cfile name\u003e\"`  \r\n\r\n ---   \r\n\r\n ### Process:  \r\n  \r\n Get the extension of the file and strip off the rest   \r\n get the name, without the extension  \r\n get the file path  \r\n \"Case statement to take the extension fact and convert it into {{ comment_style }}\"  \r\n\r\n---\r\n\r\n[![](https://mermaid.ink/img/eyJjb2RlIjoiZ3JhcGggTFJcbiAgYTEoKG1ha2UtbWQueW1sKSkgLS0-IGEye3tcIkRldGVybWluZSBTdHlsZVwifX1cbiAgYTIgLS4tPiBiMShmYTpmYS1jb2RlIEhhc2gpXG4gIGEyIC0uLT4gYzEoZmE6ZmEtY29kZSBTbGFzaClcbiAgYTIgLS4tPiBkMShmYTpmYS1jb2RlIFNlbWlDb2wpXG4gIGEyIC0uLT4gZTEoZmE6ZmEtY29kZSBXZWIpXG4gIGEyIC0uLT4gZjEoZmE6ZmEtY29kZSBEYXNoRGFzaClcbiAgYTIgLS4tPiBnMShmYTpmYS1jb2RlIGV0Yy4uLilcblxuICBjMSAtLi0-IGEzXG4gIGUxIC0uLT4gYTNcbiAgZjEgLS4tPiBhM1xuICBnMSAtLi0-IGEzXG4gIGIxIC0uLT4gYTNcbiAgZDEgLS4tPiBhM1tbZXh0cmFjdCBjb21tZW50c11dXG5cbiAgYTMgLS0-IGE0W1tjcmVhdGUgLm1kXV0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZm9yZXN0In0sInVwZGF0ZUVkaXRvciI6ZmFsc2V9)](https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ3JhcGggTFJcbiAgYTEoKG1ha2UtbWQueW1sKSkgLS0-IGEye3tcIkRldGVybWluZSBTdHlsZVwifX1cbiAgYTIgLS4tPiBiMShmYTpmYS1jb2RlIEhhc2gpXG4gIGEyIC0uLT4gYzEoZmE6ZmEtY29kZSBTbGFzaClcbiAgYTIgLS4tPiBkMShmYTpmYS1jb2RlIFNlbWlDb2wpXG4gIGEyIC0uLT4gZTEoZmE6ZmEtY29kZSBXZWIpXG4gIGEyIC0uLT4gZjEoZmE6ZmEtY29kZSBEYXNoRGFzaClcbiAgYTIgLS4tPiBnMShmYTpmYS1jb2RlIGV0Yy4uLilcblxuICBjMSAtLi0-IGEzXG4gIGUxIC0uLT4gYTNcbiAgZjEgLS4tPiBhM1xuICBnMSAtLi0-IGEzXG4gIGIxIC0uLT4gYTNcbiAgZDEgLS4tPiBhM1tbZXh0cmFjdCBjb21tZW50c11dXG5cbiAgYTMgLS0-IGE0W1tjcmVhdGUgLm1kXV0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZm9yZXN0In0sInVwZGF0ZUVkaXRvciI6ZmFsc2V9)  \r\n\r\n--- \r\n  \r\n### Named Steps:  \r\n  \r\n  * set facts for {{ code_file }}\"  \r\n  * set {{ file_extension }} fact for the file in {{ file_path }}\"  \r\n  * let's see what we captured\"  \r\n  * run comment role for {{ comment_style }} commenting style\"  \r\n\r\n---\r\n\r\n**Future:**  \r\n\u003e This could be used as part of a pipeline to generate process documentation for the programs / applications being written.  \r\n\r\n---\r\n\r\n\u003ctable\u003e\r\n    \u003cthead\u003e\r\n        \u003ctr\u003e\r\n            \u003cth colspan=3\u003eComment Style\u003c/th\u003e\r\n        \u003c/tr\u003e\r\n    \u003c/thead\u003e\r\n    \u003ctbody\u003e\r\n        \u003ctr\u003e\r\n            \u003ctd\u003eHash\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e # \u003c/code\u003e\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e \u003c#   #\u003e \u003c/code\u003e\u003c/td\u003e\r\n        \u003c/tr\u003e\r\n        \u003ctr\u003e\r\n            \u003ctd\u003eSlash\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e // \u003c/code\u003e\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e /*  */ \u003c/code\u003e\u003c/td\u003e\r\n        \u003c/tr\u003e\r\n        \u003ctr\u003e\r\n            \u003ctd\u003eWeb\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e \u0026lt;!--  --\u003e \u003c/code\u003e\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e \u0026lt;meta\u003e \u003c/code\u003e\u003c/td\u003e\r\n        \u003c/tr\u003e\r\n        \u003ctr\u003e\r\n            \u003ctd\u003eSemi-Colon\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e ; \u003c/code\u003e\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e  \u003c/code\u003e\u003c/td\u003e\r\n        \u003c/tr\u003e\r\n        \u003ctr\u003e\r\n            \u003ctd\u003e\u0026#916;Dash Dash\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e -- \u003c/code\u003e\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e --[[ \u003c/code\u003e\u003c/td\u003e\r\n        \u003c/tr\u003e\r\n        \u003ctr\u003e\r\n            \u003ctd\u003e\u0026#916;Remark\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e REM \u003c/code\u003e\u003c/td\u003e\r\n            \u003ctd\u003e\u003ccode\u003e ' \u003c/code\u003e\u003c/td\u003e\r\n        \u003c/tr\u003e\r\n    \u003c/tbody\u003e\r\n\u003c/table\u003e\r\n\r\n\r\nΔ - Not fully implemented \r\n\r\n---\r\n\r\n_ansible generated process flow wireframe for make_md_template.md_  \r\n\r\n---\r\n\r\n|[#dsmith73](https://github.com/dsmith73)|\r\n| :---: |\r\n|![github.com/dsmith73](https://avatars1.githubusercontent.com/u/44279121?s=60\u0026u=7a933a33b51505f9d6435eeffae1c8156a47dc77\u0026v=4 \"github.com/dsmith73\")  \r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsmith73%2Fmake-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsmith73%2Fmake-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsmith73%2Fmake-md/lists"}