More features for html output (#95)

* feat: introduce advanced-html

* docs: md lint

* test: add test for advanced html

* docs: fix

* cicd: add action for github pages

* cicd: add action for github pages

* cicd: test in feature branch

* docs

---------

Co-authored-by: fabianfgross <[email protected]>

.github/workflows/github-pages.yml

@@ -10,22 +10,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    - name: Set up Python
-      uses: actions/setup-python@v4
+    # check out repo
+    - uses: actions/checkout@v4
+    # install all deps in pipenv
+    - name: install_deps
+      uses: VaultVulp/[email protected]
       with:
-        python-version: '3.12'
-
-    - name: Install Pipenv
-      run: pip install pipenv
-
-    - name: Install dependencies
-      run: pipenv install
-
-    - name: Run Python script
-      run: pipenv run python stella.py -fh -ah -hcp EXAMPLE/prometheus -o ./index.html
+        command: install
+    # run stella
+    - name: install_deps
+      uses: VaultVulp/[email protected]
+      with:
+        command: run python stella.py -fh -ah -hcp EXAMPLE/prometheus -o ./index.html
 
     - name: Deploy to GitHub Pages
       uses: peaceiris/actions-gh-pages@v4

README.md

@@ -20,9 +20,13 @@ templates and generate a Markdown or HTML documentation from that data.
 
 For an example output when running `stella` for the
 [prometheus](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus)
-helm chart, follow
-[this](https://github.com/very-doge-wow/stella/blob/main/EXAMPLE/prometheus.md)
-link.
+helm chart, follow these links:
+
+<!-- markdownlint-disable MD013 -->
+* [Advanced HTML (Deployed)](https://very-doge-wow.github.io/stella/)
+* [Markdown (Source)](https://github.com/very-doge-wow/stella/blob/main/EXAMPLE/prometheus.md)
+* [Simple HTML (Source)](https://github.com/very-doge-wow/stella/blob/main/EXAMPLE/prometheus.html)
+<!-- markdownlint-enable MD013 -->
 
 ## Usage