This is a work in progress. The goal is to be a documentation site for all the GitHub Actions.
Currently, each "site" is seperated into a folder, with its own sidebar configuration.
These docs are written in plain text using Markdown and built with VitePress.
| Location | Description |
|---|---|
| docs | Documentation Root (Markdown files) |
| docs/public | Static Root (copied to docs root) |
| docs/index.md | Special VitePress Home Page |
| .vitepress | VitePress Configuration Root |
| .vitepress/config.mts | VitePress Configuration File |
| .vitepress/scripts | Custom Scripts Root |
| .vitepress/sidebars | Sidebar Configuration Root |
| .vitepress/theme | VitePress Custom Theme Root |
| .vitepress/theme/index.js | VitePress Custom Theme File |
| .vitepress/theme/custom.css | VitePress Global CSS File |
| .vitepress/theme/components | VitePress Components Root |
To get started, clone the repository and run npm i then npm run dev.
npm install
npm run devThe site should now be available at: http://localhost:5173/
If you would like to submit a PR, please review the CONTRIBUTING.md.
Please consider making a donation to support the development of this project and additional open source projects.
Additionally, you can support other GitHub Actions I have published:
- Stack Deploy Action
- Portainer Stack Deploy Action
- Docker Context Action
- Actions Up Action
- VirusTotal Action
- Mirror Repository Action
- Update Version Tags Action
- Docker Tags Action
- Update JSON Value Action
- JSON Key Value Check Action
- Parse Issue Form Action
- Cloudflare Purge Cache Action
- Mozilla Addon Update Action
- Package Changelog Action
- NPM Outdated Check Action
- Label Creator Action
- Algolia Crawler Action
- Upload Release Action
- Check Build Action
- Web Request Action
- Get Commit Action
❔ Unpublished Actions
These actions are not published on the Marketplace, but may be useful.
- cssnr/create-files-action - Create various files from templates.
- cssnr/draft-release-action - Keep a draft release ready to publish.
- cssnr/env-json-action - Convert env file to json or vice versa.
- cssnr/push-artifacts-action - Sync files to a remote host with rsync.
- smashedr/update-release-notes-action - Update release notes.
- smashedr/combine-release-notes-action - Combine release notes.
📝 Template Actions
These are basic action templates that I use for creating new actions.
- js-test-action - JavaScript
- ts-test-action - TypeScript
- py-test-action - Python (Dockerfile)
- docker-test-action - Docker (Image)
Note: The docker-test-action builds, runs and pushes images to GitHub Container Registry.
For a full list of current projects visit: https://cssnr.github.io/
