Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
docs/** linguist-documentation
docs.ps1 linguist-vendored
build.ps1 linguist-vendored
*.ps1 linguist-vendored
6 changes: 6 additions & 0 deletions .github/actionlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
paths:
.github/workflows/**/*.{yml,yaml}:
ignore:
- '"inputs" section is alias node but mapping node is expected'
- '"paths" section must be sequence node but got alias node with "" tag'
- '"paths-ignore" section must be sequence node but got alias node with "" tag'
2 changes: 1 addition & 1 deletion .github/workflows/dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
timeout-minutes: 5
steps:
- name: "Zensical Action"
uses: cssnr/zensical-action@v1
uses: cssnr/zensical-action@master
with:
upload: "artifact"
#prepare: 'sed -i "s/>Zensical</>Zensical ${ZENSICAL_VERSION}</" zensical.toml'
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ jobs:
steps:
- name: "Zensical Action"
id: zensical
uses: cssnr/zensical-action@v1
uses: cssnr/zensical-action@master
with:
prepare: 'sed -i "s/>Zensical<\/a>/>Zensical<\/a> v${ZENSICAL_VERSION}/" zensical.toml'

- name: "Send Notification"
if: ${{ !cancelled() }}
continue-on-error: true
uses: sarisia/actions-status-discord@v1
uses: sarisia/actions-status-discord@eb045afee445dc055c18d3d90bd0f244fd062708 # v1.16.0
with:
webhook: ${{ secrets.DISCORD_WEBHOOK }}
description: ${{ steps.zensical.outputs.page_url }}
2 changes: 1 addition & 1 deletion .github/workflows/labeler.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:

steps:
- name: "Checkout Configs"
uses: actions/checkout@v5
uses: actions/checkout@v6
with:
repository: cssnr/configs
ref: master
Expand Down
33 changes: 11 additions & 22 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
push:
branches: [master]
pull_request:
branches: [master]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand All @@ -13,6 +14,7 @@ concurrency:
jobs:
lint:
name: "Lint"
if: ${{ !contains(github.event.head_commit.message, '#nolint') }}
runs-on: ubuntu-latest
timeout-minutes: 5

Expand All @@ -21,20 +23,19 @@ jobs:

steps:
- name: "Checkout"
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: "Debug event.json"
if: ${{ !github.event.act }}
continue-on-error: true
run: |
cat "${GITHUB_EVENT_PATH}"

run: cat "${GITHUB_EVENT_PATH}"
- name: "Debug CTX github"
if: ${{ !github.event.act }}
continue-on-error: true
env:
GITHUB_CTX: ${{ toJSON(github) }}
run: echo "$GITHUB_CTX"
- name: "Debug Environment"
continue-on-error: true
run: env

- name: "prettier"
if: ${{ !cancelled() }}
Expand All @@ -47,25 +48,13 @@ jobs:
- name: "yamllint"
if: ${{ !cancelled() }}
env:
CONFIG: "{extends: relaxed, ignore: [node_modules/], rules: {line-length: {max: 119}}}"
CONFIG: .github/yamllint.yaml
run: |
echo "::group::List Files"
yamllint -d '${{ env.CONFIG }}' --list-files .
yamllint -c "${{ env.CONFIG }}" --list-files .
echo "::endgroup::"
yamllint -d '${{ env.CONFIG }}' .
yamllint -c "${{ env.CONFIG }}" .

- name: "actionlint"
if: ${{ !cancelled() }}
run: |
echo "::group::Download"
loc=$(curl -sI https://github.com/rhysd/actionlint/releases/latest | grep -i '^location:')
echo "loc: ${loc}"
tag=$(echo "${loc}" | sed -E 's|.*/tag/v?(.*)|\1|' | tr -d '\t\r\n')
echo "tag: ${tag}"
url="https://github.com/rhysd/actionlint/releases/latest/download/actionlint_${tag}_linux_amd64.tar.gz"
echo "url: ${url}"
curl -sL "${url}" | tar xz -C "${RUNNER_TEMP}" actionlint
file "${RUNNER_TEMP}/actionlint"
"${RUNNER_TEMP}/actionlint" --version
echo "::endgroup::"
"${RUNNER_TEMP}/actionlint" -color -verbose -shellcheck= -pyflakes=
uses: cssnr/actionlint-action@v1
7 changes: 7 additions & 0 deletions .github/yamllint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: relaxed

ignore-from-file: .gitignore

rules:
line-length:
max: 119
16 changes: 6 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# Generic
.idea/
*.iml
.vscode/
.venv/
venv/
__pycache__/
*.egg-info/
dist/
node_modules/
.*cache
*.log
*.pyc
.coverage
coverage.xml
site/
.cache/
eslint_report.json
# App
site
18 changes: 5 additions & 13 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
# IDE
.idea/
.vscode/

# Build
dist/
node_modules/

# Tools
.ruff_cache/
.mypy_cache/
.pytest_cache/
dist/
package-lock.json

# Files
package-lock.json
*.html
.github/disabled/
.github/PULL_REQUEST_TEMPLATE/
.github/pull_request_template.md
4 changes: 2 additions & 2 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"trailingComma": "es5",
"semi": false,
"singleQuote": true,
"printWidth": 90,
"overrides": [
{
"files": ["**/*.html", "**/*.yaml", "**/*.yml"],
"options": {
"singleQuote": false
"singleQuote": false,
"printWidth": 120
}
},
{
Expand Down
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
[![Deployment Docs](https://img.shields.io/github/deployments/cssnr/zensical-action-docs/docs?logo=github&label=docs)](https://github.com/cssnr/zensical-action-docs/deployments/docs)
[![Deployment Dev](https://img.shields.io/github/deployments/cssnr/zensical-action-docs/dev?logo=github&label=dev)](https://github.com/cssnr/zensical-action-docs/deployments/dev)
[![Workflow Docs](https://img.shields.io/github/actions/workflow/status/cssnr/zensical-action-docs/docs.yaml?logo=cachet&label=docs)](https://github.com/cssnr/zensical-action-docs/actions/workflows/docs.yaml)
[![Workflow Dev](https://img.shields.io/github/actions/workflow/status/cssnr/zensical-action-docs/dev.yaml?logo=cachet&label=dev)](https://github.com/cssnr/zensical-action-docs/actions/workflows/dev.yaml)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/zensical-action-docs?logo=github&label=updated)](https://github.com/cssnr/zensical-action-docs/pulse)
[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/zensical-action-docs?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/zensical-action-docs?tab=readme-ov-file#readme)
[![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/zensical-action-docs?logo=github)](https://github.com/cssnr/zensical-action-docs/graphs/contributors)
[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/zensical-action?logo=github)](https://github.com/cssnr/zensical-action/discussions)
[![GitHub Forks](https://img.shields.io/github/forks/cssnr/zensical-action?style=flat&logo=github)](https://github.com/cssnr/zensical-action/forks)
[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/zensical-action?style=flat&logo=github)](https://github.com/cssnr/zensical-action/stargazers)
[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&label=org%20stars)](https://cssnr.github.io/)
[![Deployment Docs](https://img.shields.io/github/deployments/cssnr/zensical-action-docs/docs?logo=materialformkdocs&logoColor=white&label=docs)](https://github.com/cssnr/zensical-action-docs/deployments/docs)
[![Deployment Dev](https://img.shields.io/github/deployments/cssnr/zensical-action-docs/dev?logo=materialformkdocs&logoColor=white&label=dev)](https://github.com/cssnr/zensical-action-docs/deployments/dev)
[![Workflow Docs](https://img.shields.io/github/actions/workflow/status/cssnr/zensical-action-docs/docs.yaml?logo=testcafe&logoColor=white&label=docs)](https://github.com/cssnr/zensical-action-docs/actions/workflows/docs.yaml)
[![Workflow Dev](https://img.shields.io/github/actions/workflow/status/cssnr/zensical-action-docs/dev.yaml?logo=testcafe&logoColor=white&label=dev)](https://github.com/cssnr/zensical-action-docs/actions/workflows/dev.yaml)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/zensical-action?logo=listenhub&label=updated)](https://github.com/cssnr/zensical-action/pulse)
[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/zensical-action?logo=buffer&label=repo%20size)](https://github.com/cssnr/zensical-action?tab=readme-ov-file#readme)
[![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/zensical-action?logo=southwestairlines)](https://github.com/cssnr/zensical-action/graphs/contributors)
[![GitHub Issues](https://img.shields.io/github/issues/cssnr/zensical-action?logo=codeforces&logoColor=white)](https://github.com/cssnr/zensical-action/issues)
[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/zensical-action?logo=livechat&logoColor=white)](https://github.com/cssnr/zensical-action/discussions)
[![GitHub Forks](https://img.shields.io/github/forks/cssnr/zensical-action?style=flat&logo=forgejo&logoColor=white)](https://github.com/cssnr/zensical-action/forks)
[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/zensical-action?style=flat&logo=gleam&logoColor=white)](https://github.com/cssnr/zensical-action/stargazers)
[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=apachespark&logoColor=white&label=org%20stars)](https://cssnr.github.io/)
[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)
[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr)

Expand Down
6 changes: 6 additions & 0 deletions docs/assets/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/* Fix content shift on scrollbar */
@supports (scrollbar-gutter: stable) {
html {
scrollbar-gutter: stable;
}
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Open External Links in New Tab

// noinspection JSUnresolvedReference,JSIgnoredPromiseFromCall
document$.subscribe(function () {
// console.log('processing:', window.location)
// console.log('documentLoaded:', globalThis.location)
for (const el of document.querySelectorAll('a')) {
if (el.host !== globalThis.location.host) {
// console.log('el.host:', el.host)
if (el.host && el.host !== globalThis.location.host) {
el.target = '_blank'
el.rel = 'noopener'
}
Expand Down
19 changes: 13 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ icon: lucide/rocket
[![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)
[![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)
[![Action Run Using](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Fzensical-action%2Frefs%2Fheads%2Fmaster%2Faction.yml&query=%24.runs.using&logo=githubactions&logoColor=white&label=runs)](https://github.com/cssnr/zensical-action/blob/master/action.yml)
[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/zensical-action?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/zensical-action?tab=readme-ov-file#readme)
[![Workflow Release](https://img.shields.io/github/actions/workflow/status/cssnr/zensical-action/release.yaml?logo=testcafe&logoColor=white&label=release)](https://github.com/cssnr/zensical-action/actions/workflows/release.yaml)
[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/zensical-action/lint.yaml?logo=testcafe&logoColor=white&label=lint)](https://github.com/cssnr/zensical-action/actions/workflows/lint.yaml)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/zensical-action?logo=github&label=updated)](https://github.com/cssnr/zensical-action/pulse)
[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/cssnr/zensical-action?logo=github)](https://github.com/cssnr/zensical-action/issues)
[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/zensical-action?logo=github)](https://github.com/cssnr/zensical-action/discussions)
[![GitHub Forks](https://img.shields.io/github/forks/cssnr/zensical-action?style=flat&logo=github)](https://github.com/cssnr/zensical-action/forks)
[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/zensical-action?style=flat&logo=github)](https://github.com/cssnr/zensical-action/stargazers)
[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&label=org%20stars)](https://cssnr.github.io/)
[![GitHub Issues](https://img.shields.io/github/issues/cssnr/zensical-action?logo=codeforces&logoColor=white)](https://github.com/cssnr/zensical-action/issues)
[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/zensical-action?logo=livechat&logoColor=white)](https://github.com/cssnr/zensical-action/discussions)
[![GitHub Forks](https://img.shields.io/github/forks/cssnr/zensical-action?style=flat&logo=forgejo&logoColor=white)](https://github.com/cssnr/zensical-action/forks)
[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/zensical-action?style=flat&logo=gleam&logoColor=white)](https://github.com/cssnr/zensical-action/stargazers)
[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=apachespark&logoColor=white&label=org%20stars)](https://cssnr.github.io/)
[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)
[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr)

Expand Down Expand Up @@ -69,3 +70,9 @@ jobs:
```

See the [Usage](usage.md) for **more options** or check out some additional [Examples](examples.md).

&nbsp;

!!! question

If you need **help** getting started or run into any issues, [support](support.md) is available!
38 changes: 21 additions & 17 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
{% extends "base.html" %}
{% extends "base.html" %} {% block site_meta %} {{ super() }}

{% block site_meta %}
{{ super() }}
<meta property="og:type" content="website" />
<meta property="og:title" content="Zensical Action" />
<meta property="og:site_name" content="Zensical GitHub Action" />
<meta
property="og:description"
content="GitHub Action to checkout, build, upload, and deploy Zensical Docs to GitHub Pages."
/>
<meta property="og:image" content="/assets/images/logo.png" />
<meta property="og:image:alt" content="Zensical Action" />

<meta property="og:type" content="website">
<meta property="og:site_name" content="Zensical GitHub Action">
<meta property="og:title" content="Zensical Action">
<meta property="og:image" content="/assets/images/logo.png">
<meta property="og:image:alt" content="Zensical Action">
<meta property="twitter:card" content="summary" />
<meta property="twitter:title" content="Zensical Action" />
<meta property="twitter:site" content="Zensical GitHub Action" />
<meta
property="twitter:description"
content="GitHub Action to checkout, build, upload, and deploy Zensical Docs to GitHub Pages."
/>
<meta property="twitter:image" content="/assets/images/logo.png" />
<meta property="twitter:image:alt" content="Zensical Action" />

<meta property="twitter:card" content="summary">
<meta property="twitter:site" content="GitHub Action to checkout, build, upload, and deploy Zensical Docs to GitHub Pages.">
<meta property="twitter:title" content="Zensical Action">
<meta property="twitter:description" content="GitHub Action to checkout, build, upload, and deploy Zensical Docs to GitHub Pages.">
<meta property="twitter:image" content="/assets/images/logo.png">
<meta property="twitter:image:alt" content="Zensical Action">
<link rel="apple-touch-icon" href="/assets/images/logo.png" />

<link rel="apple-touch-icon" href="/assets/images/logo.png">

<meta name="darkreader-lock">
<meta name="darkreader-lock" />
{% endblock %}
10 changes: 5 additions & 5 deletions docs/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,31 @@ or [Q&A](https://github.com/cssnr/zensical-action/discussions/categories/q-a).
If you want to see a new feature, start a discussion in
the [Feature Requests](https://github.com/cssnr/zensical-action/discussions/categories/feature-requests) section.

[:fontawesome-brands-github: Start A Discussion](https://github.com/cssnr/zensical-action/discussions){ .md-button .md-button--primary }
[:fontawesome-brands-github: &nbsp; Start A Discussion](https://github.com/cssnr/zensical-action/discussions){ .md-button .md-button--primary }

## GitHub Issues

If you run into any problems or find a bug, please [open an issue](https://github.com/cssnr/zensical-action/issues).

**These reports are treated with the highest priority.**

[:lucide-circle-alert: Report an Issue](https://github.com/cssnr/zensical-action/issues){ .md-button .md-button--primary }
[:lucide-circle-alert: &nbsp; Report an Issue](https://github.com/cssnr/zensical-action/issues){ .md-button .md-button--primary }

## Discord Chat

You can chat with us about anything [on discord](https://discord.gg/wXy6m2X8wY).

From here you can contact me directly, `Shane@111150265075298304`.

[:fontawesome-brands-discord: Chat on Discord](https://discord.gg/wXy6m2X8wY){ .md-button .md-button--primary }
[:fontawesome-brands-discord: &nbsp; Chat on Discord](https://discord.gg/wXy6m2X8wY){ .md-button .md-button--primary }

## General Feedback

You can submit general feedback via the [web form](https://cssnr.github.io/feedback/?app=zensical-action).

_This method is not recommended to [report issues](https://github.com/cssnr/zensical-action/issues) or [request features](https://github.com/cssnr/zensical-action/discussions/categories/feature-requests)._

[:lucide-send: Send Feedback](https://cssnr.github.io/feedback/?app=zensical-action){ .md-button .md-button--primary }
[:lucide-send: &nbsp; Send Feedback](https://cssnr.github.io/feedback/?app=zensical-action){ .md-button .md-button--primary }

## Additional Links

Expand All @@ -55,7 +55,7 @@ _This method is not recommended to [report issues](https://github.com/cssnr/zens

Additionally, if you would like a [new action](https://github.com/cssnr/actions/discussions/categories/github-actions) created, let us know...

[:lucide-activity: Request New Action](https://github.com/cssnr/actions/discussions/categories/github-actions){ .md-button .md-button--primary }
[:lucide-activity: &nbsp; Request New Action](https://github.com/cssnr/actions/discussions/categories/github-actions){ .md-button .md-button--primary }

&nbsp;

Expand Down
1 change: 1 addition & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The [Outputs](#outputs) include the `page_url` and more.
| **uv-version** | _Latest_ | UV Version (see [setup-uv](https://github.com/astral-sh/setup-uv?tab=readme-ov-file#inputs)) |
| **directory** | `.` | Build Directory (relative to root) |
| **path** | `site` | Site Path (relative to root) |
| **args** | `-c` | Build Arguments passed to zensical |
| **checkout** | `true` | Runs: [actions/checkout](https://github.com/actions/checkout) |
| [upload](#upload) | `github-pages` | Upload: [`github-pages`,`artifact`,`false`] |
| [name](#name) | `artifact` | Artifact Name if [upload](#upload) is `artifact` |
Expand Down
Loading
Loading