From 7244c38131ad70681825b365f4a7d643a250dd13 Mon Sep 17 00:00:00 2001 From: fabianfgross Date: Wed, 25 Sep 2024 15:27:17 +0200 Subject: [PATCH] docs: fix readme --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7f632f5..7e86f3d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ It supports simple templating, so custom templates for output can be used as well. Will read metadata such as `Chart.yaml`, `values.yaml` or the present templates and generate a Markdown or HTML documentation from that data. -## Example +## Example For an example output when running `stella` for the [prometheus](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus) @@ -188,10 +188,23 @@ He is most famously known for being a cartographer and for creating multiple waterways, which is fitting when considering the tool should create helm chart docs. -## 🧑‍💻 Development +## 🧑‍💻 Development + +
Expand for more info +### Linting Code + +Install [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) first. + +```shell +markdownlint './*.md' \ + --ignore './test/output.md' \ + --ignore './test/custom-template-keywords.md' \ + --ignore './EXAMPLE_OUTPUT.md' +``` + ### Running Unit Tests ```shell @@ -201,10 +214,19 @@ pipenv run pytest -vv --cov --cov-report=xml ### Updating Example Outputs -``` +```shell pipenv install -pipenv run python stella.py -fh -css EXAMPLE/style.css -hcp EXAMPLE/prometheus -o EXAMPLE/prometheus.html -pipenv run python stella.py -fh --advanced-html -hcp EXAMPLE/prometheus -o EXAMPLE/prometheus-advanced.html +pipenv run python stella.py \ + -fh \ + -css EXAMPLE/style.css \ + -hcp EXAMPLE/prometheus \ + -o EXAMPLE/prometheus.html +pipenv run python stella.py \ + -fh \ + --advanced-html \ + -hcp EXAMPLE/prometheus \ + -o EXAMPLE/prometheus-advanced.html ``` -
\ No newline at end of file + +