Deploy to Neocities (using neocities-red gem)
Version updated for https://github.com/o-200/deploy-sites-neocities-red to version v1.
- This action is used across all versions by ? repositories.
Action Type
This is a Composite action.
Go to the GitHub Marketplace to find the latest changes.
Action Summary
This GitHub Action automates the deployment of website files to Neocities, a static site hosting platform. It simplifies the process of publishing updates for static sites built with frameworks like Hugo, Jekyll, or plain HTML/CSS/JS, ensuring efficient and consistent deployment. Key capabilities include seamless integration with GitHub workflows and secure API token management for authentication.
What’s Changed
Deploy to Neocities
A GitHub Action for deploying a folder to Neocities using neocities-red.
This action is useful for giant website, static sites built with tools like Hugo, Jekyll, Eleventy, Astro, VitePress, or plain HTML/CSS/JS projects.
Usage
Basic example
- place this code in .github/workflows
name: Deploy to neocities.org
on:
push:
branches:
- main
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run your action
uses: o-200/deploy-sites-neocities-red@v1
with:
key: ${{ secrets.NEOCITIES_API_TOKEN }}
place your neocities api token into github secrets
Now, it ready to work!
How to get API TOKEN?
- Open your account settings in neocities
- Open “Manage Site Settings” in “Sites”
- Go to “API” and take your API token
How to place api token in github secrets?
- Open your website’s github repository
- Settings
- Secrets And Variables
- New Repository Secret
- Name - “NEOCITIES_API_TOKEN” (without quotes), put your api key in Secret
- Done!
Full Changelog: https://github.com/o-200/deploy-sites-neocities-red/compare/v1...v1