Skip to content

docs: update actions and workflows documentation #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoverkraft-bot merged 1 commit into from
Mar 24, 2026
Merged

docs: update actions and workflows documentation #356

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 22 additions & 16 deletions actions/deploy/jekyll/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,15 @@ Main steps performed by this action:
## Usage

````yaml
- uses: hoverkraft-tech/ci-github-publish/actions/deploy/jekyll@642cdb54493d05debdc1394f4bfd7365f82e7bf1 # 0.18.2
- uses: hoverkraft-tech/ci-github-publish/actions/deploy/jekyll@5ff7d4c3910971ed53834becd5967271b4e228cf # 0.21.1
with:
# The Jekyll theme to use for the site.
# Default: `jekyll-theme-cayman`
theme: jekyll-theme-cayman

# The Jekyll pages path to build. Supports glob patterns and multiple paths (one per line). Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files.
# The Jekyll pages path to build.
# Supports glob patterns and multiple paths (one per line).
# Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files.
#
# ```yml
# pages: |
Expand All @@ -62,7 +64,8 @@ Main steps performed by this action:
# ```
pages: ""

# Additional files to copy into the generated `assets/` directory. Supports glob patterns and multiple paths (one per line).
# Additional files to copy into the generated `assets/` directory.
# Supports glob patterns and multiple paths (one per line).
#
# ```yml
# assets: |
Expand Down Expand Up @@ -90,18 +93,21 @@ Main steps performed by this action:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`theme`** | The Jekyll theme to use for the site. | **false** | `jekyll-theme-cayman` |
| **`pages`** | The Jekyll pages path to build. Supports glob patterns and multiple paths (one per line). Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files. | **false** | - |
| | | | |
| | <!-- textlint-disable --><pre lang="yml">pages: \|&#13; docs/\*\*/\*.md&#13; .github/workflows/\*.md&#13; actions/\*/README.md</pre><!-- textlint-enable --> | | |
| **`assets`** | Additional files to copy into the generated `assets/` directory. Supports glob patterns and multiple paths (one per line). | **false** | - |
| | | | |
| | <!-- textlint-disable --><pre lang="yml">assets: \|&#13; css/\*\*&#13; images/\*\*&#13; media/\*\*/\*.png</pre><!-- textlint-enable --> | | |
| **`site-path`** | The working directory where the prepared Jekyll site is written. Relative to the workspace. | **false** | `_site` |
| | Defaults to `_site`. | | |
| **`build-path`** | The destination directory for the built site assets. Relative to the workspace. Defaults to `build` when not set. | **false** | `build` |
| **Input** | **Description** | **Required** | **Default** |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | --------------------- |
| **`theme`** | The Jekyll theme to use for the site. | **false** | `jekyll-theme-cayman` |
| **`pages`** | The Jekyll pages path to build. | **false** | - |
| | Supports glob patterns and multiple paths (one per line). | | |
| | Accepts Markdown (`.md`, `.markdown`) and HTML (`.html`, `.htm`) files. | | |
| | | | |
| | <!-- textlint-disable --><pre lang="yml">pages: \|&#13; docs/\*\*/\*.md&#13; .github/workflows/\*.md&#13; actions/\*/README.md</pre><!-- textlint-enable --> | | |
| **`assets`** | Additional files to copy into the generated `assets/` directory. | **false** | - |
| | Supports glob patterns and multiple paths (one per line). | | |
| | | | |
| | <!-- textlint-disable --><pre lang="yml">assets: \|&#13; css/\*\*&#13; images/\*\*&#13; media/\*\*/\*.png</pre><!-- textlint-enable --> | | |
| **`site-path`** | The working directory where the prepared Jekyll site is written. Relative to the workspace. | **false** | `_site` |
| | Defaults to `_site`. | | |
| **`build-path`** | The destination directory for the built site assets. Relative to the workspace. Defaults to `build` when not set. | **false** | `build` |

<!-- inputs:end -->

Expand Down Expand Up @@ -140,7 +146,7 @@ This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2025 hoverkraft
Copyright © 2026 hoverkraft

For more details, see the [license](http://choosealicense.com/licenses/mit/).

Expand Down