{"id":22473125,"url":"https://github.com/bas080/markatzea","last_synced_at":"2025-03-27T16:26:10.581Z","repository":{"id":45755091,"uuid":"378205992","full_name":"bas080/markatzea","owner":"bas080","description":"Evaluate markdown code-blocks and render the output in markdown ","archived":false,"fork":false,"pushed_at":"2023-07-28T21:35:16.000Z","size":37,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T20:12:17.274Z","etag":null,"topics":["documentation","generated","literate","markdown","perl"],"latest_commit_sha":null,"homepage":"","language":"Perl","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/bas080.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}},"created_at":"2021-06-18T16:19:37.000Z","updated_at":"2023-07-13T04:33:24.000Z","dependencies_parsed_at":"2022-08-05T06:15:43.142Z","dependency_job_id":null,"html_url":"https://github.com/bas080/markatzea","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fmarkatzea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fmarkatzea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fmarkatzea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bas080%2Fmarkatzea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bas080","download_url":"https://codeload.github.com/bas080/markatzea/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245880961,"owners_count":20687643,"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":["documentation","generated","literate","markdown","perl"],"created_at":"2024-12-06T12:19:14.174Z","updated_at":"2025-03-27T16:26:10.533Z","avatar_url":"https://github.com/bas080.png","language":"Perl","readme":"# markatzea\n\nThis project's `README.md` and stdout codeblocks are created using\nmarkatzea:\n\n```bash\nmarkatzea README.mz \u003e README.md\n```\n\nMarkatzea does not break your existing markdown. It adds a little syntax for\ndefining the interpreter for that code block. This is defined after the\ncode-block's language name. The code-block is then passed as stdin into the\ninterpreter configured for that code-block.\n\n## Usage\n\n```bash\npod2text markatzea\n```\n```\nNAME\n    markatzea - evaluate your markdown code blocks\n\nSYNOPSIS\n    markatzea \u003cfile\u003e\n\nDESCRIPTION\n    markatzea is a tool which takes markdown, evaluates code blocks with\n    interpreters and prints the output of those processes to a different\n    codeblock.\n\n```\n\n## Examples\n\n### Normal code-block\n\nWhen no interpreter is defined, markatzea will print the markdown as is.\n\n    ```bash\n    echo 'Does not evaluate this bash code-block'\n    ```\n\n```bash\necho 'Does not evaluate this bash code-block'\n```\n\n### Evaluated code-block\n\n    ```bash bash\n    echo 'Does evaluate this bash code-block with bash'\n    ```\n\n```bash\necho 'Does evaluate this bash code-block with bash'\n```\n```\nDoes evaluate this bash code-block with bash\n```\n\n### Output Language\n\nYou can define the language to use for the output code block.\n\n    ```bash|javascript bash\n    echo 'const value = 42;'\n    ```\n\n```bash\necho 'const value = 42;'\n```\n```javascript\nconst value = 42;\n```\n\n### Literate Programming\n\nYou can achieve a form of a literate programming using a template language that\noffers a command line interface. See [memplate][2] for more information.\n\nAn example:\n\n```bash\nset -eo pipefail\n```\n\nNow we use the aliased template in another template.\n\n```bash\n\u003csane-bash-defaults\n\nls not-a-file |\n  cat - ||\n  echo 'Good! The ls process caused the pipe to stop.'\n```\n```\nGood! The ls process caused the pipe to stop.\n```\n\n## Projects that use markatzea\n\n\u003e A list of projects that use markatzea.\n\n- https://github.com/bas080/markatzea\n- https://github.com/bas080/patroon\n- https://github.com/bas080/furver\n- https://github.com/bas080/package.sh\n\nNotice that it makes it easier to maintain and test documentation by making\nusage examples runnable and thereby testable.\n\n## License\n\n[GPL-3.0][1]\n\n[1]:./LICENSE\n[2]:https://github.com/bas080/memplate\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbas080%2Fmarkatzea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbas080%2Fmarkatzea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbas080%2Fmarkatzea/lists"}