diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index 68f4ac8..6ea8b62 100644 --- a/.github/workflows/github-pages.yml +++ b/.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/action-pipenv@v2.0.1 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/action-pipenv@v2.0.1 + 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 diff --git a/README.md b/README.md index b56c422..481eb92 100644 --- a/README.md +++ b/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: + + +* [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) + ## Usage