{"repo":"erNail/labdoc","free":true,"listed":false,"github":"https://github.com/erNail/labdoc","clone":"git clone https://github.com/erNail/labdoc.git","description":"Automatically generate documentation for GitLab CI/CD components and CI/CD pipelines","language":"Go","stars":19,"topics":["documentation","gitlab","gitlab-ci","go","markdown"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"labdoc Automatically generate documentation for GitLab CI/CD components and CI/CD pipelines. What is labdoc ? labdoc currently focuses on generating documentation for GitLab CI/CD components. For an example, check out the labdoc component documentation, which is generated with labdoc . In the future, the focus might shift to generating documentation for GitLab CI/CD Pipelines in general. Getting Started Install labdoc Via Homebrew Via mise Via Binary Check the releases for the available binaries. Download the correct binary and add it to your $PATH . Via Go Via Container From Source Check out this repository and run the following: Add the resulting binary to your $PATH . Run labdoc Prepare your GitLab CI/CD components labdoc currently expects all your CI/CD components to be in a directory, with all files on the root level. By default, labdoc will use the templates directory. The documentation is generated from the spec.inputs. .description keywords, and from the comments above the spec and the job keywords. Below is a minimal example: Generate Documentation This will generate a README.md in the templates directory. The --repoUrl flag is required to generate the instructions on how to include your components. Change the documentation output directory Change the component directory Check if the documentation is up-to-date This command will not write the documentation to a file. It will only check if there is already documentation, and if the content would change. If the content","default_branch":null,"files":null,"tree":[],"storefront":"/r/erNail","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/erNail/labdoc/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."}