{"repo":"joerdav/xc","free":true,"listed":false,"github":"https://github.com/joerdav/xc","clone":"git clone https://github.com/joerdav/xc.git","description":"Markdown defined task runner.","language":"Go","stars":1403,"topics":["build-tool","documentation","go","golang","task-runner"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"xc - Simple, Convenient, Docs-based task runner. Docs Getting Started GitHub xc is a task runner similar to Make or npm run , that aims to be more discoverable and approachable. The problem xc is intended to solve is scripts maintained separately from their documentation. Often a Makefile or a package.json will contain some useful scripts for developing on a project, then the README.md will surface and describe these scripts. In such a case, since the documentation is separate, it may not be updated when scripts are changed or added. xc aims to solve this by defining the scripts inline with the documentation. xc is designed to maximise convenience, and minimise complexity. Each xc task is defined in simple, human-readable Markdown or org-mode. This means that even people without the xc tool installed can use the README (or whatever documentation file contains the tasks) as a source of useful commands for the project. Installation Installation instructions are described at . Contributing Find our guidelines & HOWTOs at CONTRIBUTING.md. Features - Tasks defined in Markdown or org-mode files as code blocks. - Editor integration: - VSCode (list and run xc tasks) - Vim (recommended config for listing and running xc tasks) - Emacs - See also: org-mode specific features. Example Take the tag task in the README.md of the xc repository: export VERSION= git rev-list --count HEAD echo Adding git tag with version v0.0.${VERSION} git tag v0.0.${VERSION} git push origin v0.0.${VERSION} The","default_branch":null,"files":null,"tree":[],"storefront":"/r/joerdav","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/joerdav/xc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}