deploy-to-neocities 项目使用教程

deploy-to-neocities 项目使用教程

deploy-to-neocities 🐈 Github Action to deploy a folder to Neocities 项目地址: https://gitcode.com/gh_mirrors/de/deploy-to-neocities

1. 项目介绍

deploy-to-neocities 是一个 GitHub Action，用于将文件夹部署到 Neocities 平台。Neocities 是一个提供静态网站托管服务的平台，支持 CDN、IPv6 和自定义域名等功能。deploy-to-neocities 通过内容感知差异更新，仅更新已更改的文件，从而实现高效的网站部署。

2. 项目快速启动

2.1 创建 GitHub 仓库

首先，创建一个新的 GitHub 仓库，或者使用现有的仓库。

2.2 配置 Neocities API Token

1. 登录到 Neocities 网站，进入 Settings 页面。
2. 在 API Key 部分，获取你的 API Token。
3. 在 GitHub 仓库中，进入 Settings -> Secrets，添加一个新的 Secret，命名为 NEOCITIES_API_TOKEN，并将你的 API Token 粘贴进去。

2.3 创建 GitHub Actions 工作流

在仓库的 .github/workflows 目录下创建一个新的 .yml 文件，例如 deploy-to-neocities.yml，并添加以下内容：

name: Deploy to Neocities

on:
  push:
    branches:
      - main

concurrency:
  group: deploy-to-neocities
  cancel-in-progress: true

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Use Node.js
        uses: actions/setup-node@v3
        with:
          node-version: 'lts/*'

      - name: Install dependencies and build
        run: |
          npm install
          npm run build

      - name: Deploy to Neocities
        uses: bcomnes/deploy-to-neocities@v2
        with:
          api_token: ${{ secrets.NEOCITIES_API_TOKEN }}
          dist_dir: public
          cleanup: false

2.4 提交并推送代码

将上述配置文件提交并推送到 GitHub 仓库的 main 分支。GitHub Actions 将自动触发部署流程，将 public 目录中的文件部署到 Neocities。

3. 应用案例和最佳实践

3.1 个人博客

deploy-to-neocities 非常适合用于部署个人博客。你可以使用静态网站生成器（如 Jekyll、Hugo 或 Gatsby）生成博客内容，并使用 deploy-to-neocities 自动部署到 Neocities。

3.2 项目文档

对于开源项目，你可以将项目文档生成静态网站，并使用 deploy-to-neocities 自动部署到 Neocities，方便用户访问和查阅。

3.3 静态网站

任何静态网站都可以使用 deploy-to-neocities 进行部署。你可以使用 HTML、CSS 和 JavaScript 构建静态网站，并通过 GitHub Actions 自动部署到 Neocities。

4. 典型生态项目

4.1 async-neocities

async-neocities 是一个用于 Neocities 的异步差异引擎，deploy-to-neocities 使用了该引擎来实现高效的文件更新。

4.2 Neocities API Docs

Neocities 官方提供了 API 文档，详细介绍了如何使用 Neocities API 进行网站管理和文件操作。

4.3 neocities-node

neocities-node 是 Neocities 官方的 Node.js API 客户端，提供了与 Neocities API 交互的接口。

通过这些生态项目，你可以进一步扩展和定制 deploy-to-neocities 的功能，满足更多复杂的部署需求。

deploy-to-neocities 🐈 Github Action to deploy a folder to Neocities 项目地址: https://gitcode.com/gh_mirrors/de/deploy-to-neocities