https://github.com/jonchang/deploy-neocities
Deploy to Neocities
https://github.com/jonchang/deploy-neocities
Last synced: 28 days ago
JSON representation
Deploy to Neocities
- Host: GitHub
- URL: https://github.com/jonchang/deploy-neocities
- Owner: jonchang
- License: mit
- Created: 2020-03-30T03:37:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-02T15:30:11.000Z (about 3 years ago)
- Last Synced: 2025-05-05T05:06:40.648Z (28 days ago)
- Language: Shell
- Size: 8.79 KB
- Stars: 26
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deploy to Neocities
An action that deploys a local directory from a workflow to Neocities.
## Usage
```yaml
- name: Deploy to Neocities
# Don't use master, use a full 40 character commit hash, e.g.,
# jonchang/deploy-neocities@deadbeef...
uses: jonchang/deploy-neocities@master
with:
# Required, to access Neocities API.
# https://neocities.org/settings
# Set in Settings -> Secrets
key: ${{ secrets.NEOCITIES_API_KEY }}
# Required, local directory to deploy to Neocities
dir: _site
# Optional, if true, delete remote files not present locally
clean: false
```
## Caveats
* Can be slow for large sites.
## See also
* [bcomnes/deploy-to-neocities](https://github.com/bcomnes/deploy-to-neocities), Node.js action with fancier diffing algorithm
* [neocities/neocities-ruby](https://github.com/neocities/neocities-ruby), the Ruby gem this is based on
* [A blog post on how to use this Action](https://jonathanchang.org/blog/deploying-your-static-site-to-neocities-using-github-actions/) and a brief explanation for why this exists in the first place