{"id":17712533,"url":"https://github.com/tzador/makedown","last_synced_at":"2025-04-08T11:08:15.808Z","repository":{"id":257824147,"uuid":"871805366","full_name":"tzador/makedown","owner":"tzador","description":"Organise your shell scripts within executable markdown files","archived":false,"fork":false,"pushed_at":"2024-10-18T19:03:11.000Z","size":450,"stargazers_count":233,"open_issues_count":23,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-21T00:11:39.551Z","etag":null,"topics":["cli","makefile","markdown","scripts"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tzador.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":"2024-10-13T01:42:34.000Z","updated_at":"2024-10-20T18:53:26.000Z","dependencies_parsed_at":"2024-10-19T18:57:05.696Z","dependency_job_id":null,"html_url":"https://github.com/tzador/makedown","commit_stats":{"total_commits":71,"total_committers":5,"mean_commits":14.2,"dds":0.09859154929577463,"last_synced_commit":"4418bd111b4f86d0e35038d45332153c263c2d06"},"previous_names":["tzador/xfile","tzador/makedown","tzador/x.md","tzador/makedown.sh"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzador%2Fmakedown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzador%2Fmakedown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzador%2Fmakedown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzador%2Fmakedown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tzador","download_url":"https://codeload.github.com/tzador/makedown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247829491,"owners_count":21002995,"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":["cli","makefile","markdown","scripts"],"created_at":"2024-10-25T09:01:56.013Z","updated_at":"2025-04-08T11:08:15.778Z","avatar_url":"https://github.com/tzador.png","language":"Python","readme":"# [makedown]() - A Markdown powered Makefile alternative\n\n`makedown` (aka Makefile + Markdown) is motivated by developers need to define\nmultiple scripts in one file next to their documentation, and have a handy way\nto run them from terminal.\n\n`Makefile`s are great for this, but are lucking some of the\n[`makedown`](https://github.com/tzador/makedown) features, such as syntax\nhighlighting, hierarchical scanning of .md files with embedded documentation.\n\nThere are also `package.json` scripts in `node.js` world, but users are forced\nto write script commands in one line.\n\nIt is implemented in Python for portability reasons, since most Unix-like\nsystems already have a Python interpreter installed.\n\nHere is [DEMO.md](./DEMO.md) file with examples of usage.\n\n---\n\nThis is a fresh project still under active development.\n\nFeel free to open and [issue](https://github.com/tzador/makedown/issues) or\n[PR](https://github.com/tzador/makedown/pulls).\n\nWe also have have a [Discord](https://discord.gg/Gcr9H897zD) server for quick\ndiscussions and sharing ideas or feedback.\n\n---\n\n## Key Features\n\n- **Executable Markdown Scripting**: Use markdown files (.md) to organize\n  commands and their documentation.\n- **Multilingual Execution**: Supports `zsh`, `bash`, `javascript`, `python` and\n  **infinitely** many more, using custom hashbangs.\n- **Syntax Highlighting**: Leverages markdown code blocks for readability.\n\n---\n\n## Install\n\n```bash\npip install makedown\n```\n\n## Use\n\nDefine commands in a `.md` file:\n\n````markdown\n# my_scripts.md\n\nHere are a few examples of commands:\n\n## [hello]() Prints \"hello\" using bash\n\n```bash\necho \"hello\"\n```\n\n## [world]() Prints \"world\" using python\n\nThis is a more detailed description of the command.\n\n```python\n#!/usr/bin/env python\n\nprint(\"world\")\n```\n````\n\nTo run commands in a markdown file, execute `makedown` from the same directory\nor any subdirectory:\n\n```bash\nmakedown hello\n```\n\nA shorter version is also available:\n\n```bash\nm world\n```\n\nTo see all the available commands with their short descriptions, use one of the\nfollowing:\n\n```bash\nmakedown --help\n```\n\nor just run it without any arguments:\n\n```bash\nm\n```\n\nTo get more details about a specific command, use:\n\n```bash\nmakedown world --help\n```\n\n## Upgrade\n\n```bash\npip install --upgrade makedown\n```\n\n## Uninstall\n\n```bash\npip uninstall makedown\n```\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzador%2Fmakedown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftzador%2Fmakedown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzador%2Fmakedown/lists"}