Skip to content

Commit 5a80c18

Browse files
committed
Update outputs
1 parent 4f62940 commit 5a80c18

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ icon: lucide/rocket
44

55
[![Zensical Action](assets/images/logo.png){ align=right width=96 }](https://github.com/cssnr/zensical-action?tab=readme-ov-file#readme)
66

7+
# :lucide-rocket: Get Started
8+
79
[![GitHub Tag Major](https://img.shields.io/github/v/tag/cssnr/zensical-action?sort=semver&filter=!v*.*&logo=git&logoColor=white&labelColor=585858&label=%20)](https://github.com/cssnr/zensical-action/tags)
810
[![GitHub Tag Minor](https://img.shields.io/github/v/tag/cssnr/zensical-action?sort=semver&filter=!v*.*.*&logo=git&logoColor=white&labelColor=585858&label=%20)](https://github.com/cssnr/zensical-action/releases)
911
[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/zensical-action?logo=git&logoColor=white&labelColor=585858&label=%20)](https://github.com/cssnr/zensical-action/releases/latest)
@@ -18,8 +20,6 @@ icon: lucide/rocket
1820
[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)
1921
[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr)
2022

21-
# :lucide-rocket: Get Started
22-
2323
Zensical GitHub Action to checkout, build, upload, and deploy [Zensical Docs](https://github.com/zensical/zensical) to GitHub Pages.
2424

2525
- https://github.com/cssnr/zensical-action
@@ -66,4 +66,4 @@ jobs:
6666
uses: cssnr/zensical-action@v1
6767
```
6868
69-
See the [Usage](usage.md) for more options or check out additional [Examples](examples.md).
69+
See the [Usage](usage.md) for **more options** or check out some additional [Examples](examples.md).

docs/usage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ The following outputs are available.
6969
| **page_url** | Pages URL from [actions/deploy-pages](https://github.com/actions/deploy-pages) |
7070
| **version** | Zensical Version Used for Build |
7171
| **path** | Site Path Used for Artifact |
72-
| **name** | Artifact Name if `upload` is `artifact` |
72+
| **name** | Artifact [name](#name) from [upload](#upload) step |
7373
7474
The `path` will always be `site` or what you set for the input `path`.
7575

76-
The `name` will always be `artifact` or what you set for the input [name](#name).
76+
Example Outputs.
7777

7878
```yaml
7979
- name: 'Zensical Action'
@@ -82,10 +82,10 @@ The `name` will always be `artifact` or what you set for the input [name](#name)
8282
8383
- name: 'Echo Output'
8484
run: |
85-
echo "page_url: ${{ steps.zensical.outputs.page_url }}"
86-
echo "version: ${{ steps.zensical.outputs.version }}"
87-
echo "path: ${{ steps.zensical.outputs.path }}"
88-
echo "name: ${{ steps.zensical.outputs.name }}"
85+
echo "GitHub page_url: ${{ steps.zensical.outputs.page_url }}"
86+
echo "Zensical version: ${{ steps.zensical.outputs.version }}"
87+
echo "Site path: ${{ steps.zensical.outputs.path }}"
88+
echo "Artifact name: ${{ steps.zensical.outputs.name }}"
8989
```
9090

9191
See the [Examples](examples.md) for more...

0 commit comments

Comments
 (0)