swanlake

Author: wangfenjin

.github/workflows/pages.yml

@@ -0,0 +1,72 @@
+name: Deploy Hugo site to Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_ENVIRONMENT: production
+      HUGO_ENV: production
+      TZ: UTC
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23'
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Install Hugo
+        run: |
+          HUGO_VERSION=0.155.3
+          wget -O "$RUNNER_TEMP/hugo.deb" \
+            "https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb"
+          sudo dpkg -i "$RUNNER_TEMP/hugo.deb"
+
+      - name: Install frontend dependencies
+        run: npm install
+
+      - name: Build site
+        run: hugo --gc --minify
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ./public
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,219 +1,39 @@
-# Docsy Example
+# SwanLake Website
 
-[Docsy][] is a [Hugo theme module][] for technical documentation sites,
-providing easy site navigation, structure, and more. This **Docsy Example
-Project** uses the Docsy theme component as a hugo module and provides a
-skeleton documentation structure for you to use. You can clone/copy this project
-and edit it with your own content, or use it as an example.
+This repository contains the Hugo + Docsy website for the SwanLake project.
 
-In this project, the Docsy theme is pulled in as a Hugo module, together with
-its dependencies:
+- Main project: <https://github.com/swanlake-io/swanlake>
+- Website source: <https://github.com/swanlake-io/swanlake.github.io>
 
-```console
-$ hugo mod graph
-...
-```
-
-For Docsy documentation, see [Docsy user guide][].
-
-This Docsy Example Project is hosted on [Netlify][] at [example.docsy.dev][].
-You can view deploy logs from the [deploy section of the project's Netlify
-dashboard][deploys], or this [alternate dashboard][].
-
-This is not an officially supported Google product. This project is currently
-maintained.
-
-## Using the Docsy Example Project as a template
-
-A simple way to get started is to use this project as a template, which gives
-you a site project that is set up and ready to use. To do this:
-
-1. Use the dropdown for switching branches/tags to change to the **latest**
-   released tag.
-
-2. Click **Use this template**.
-
-3. Select a name for your new project and click **Create repository from
-   template**.
-
-4. Make your own local working copy of your new repo using git clone, replacing
-   https://github.com/me/example.git with your repo’s web URL:
-
-```bash
-git clone --depth 1 https://github.com/me/example.git
-```
-
-Depending on your environment you may need to adjust the top-level `module`
-settings in your project's Hugo config file, for example, by adding a proxy to
-use when downloading remote modules. You can find details of what these
-configuration settings do in the
-[Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level).
-
-Once your settings are adjusted, you can edit your own versions of the site’s
-source files.
+## Local development
 
-If you want to do SCSS edits and want to publish these, you need to install
-`PostCSS`
+Prerequisites:
+- Hugo extended (`>= 0.155.0`)
+- Go (for Hugo module resolution)
 
-```bash
-npm install
-```
-
-## Running the website locally
-
-Building and running the site locally requires a recent `extended` version of
-[Hugo](https://gohugo.io). You can find out more about how to install Hugo for
-your environment in our
-[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation)
-guide.
-
-Once you've made your working copy of the site repo, from the repo root folder,
-run:
+Run locally:
 
 ```bash
 hugo server
 ```
 
-## Running a container locally
-
-You can run docsy-example inside a [Docker](https://docs.docker.com/) container,
-the container runs with a volume bound to the `docsy-example` folder. This
-approach doesn't require you to install any dependencies other than
-[Docker Desktop](https://www.docker.com/products/docker-desktop) on Windows and
-Mac, and [Docker Compose](https://docs.docker.com/compose/install/) on Linux.
-
-1. Build the docker image
-
-   ```bash
-   docker-compose build
-   ```
-
-1. Run the built image
-
-   ```bash
-   docker-compose up
-   ```
-
-   > NOTE: You can run both commands at once with `docker-compose up --build`.
-
-1. Verify that the service is working.
-
-   Open your web browser and type `http://localhost:1313` in your navigation
-   bar, This opens a local instance of the docsy-example homepage. You can now
-   make changes to the docsy example and those changes will immediately show up
-   in your browser after you save.
-
-### Cleanup
-
-To stop Docker Compose, on your terminal window, press **Ctrl + C**.
-
-To remove the produced images run:
+Build static output:
 
 ```bash
-docker-compose rm
-```
-
-For more information see the [Docker Compose documentation][].
-
-## Using a local Docsy clone
-
-Make sure your installed go version is `1.18` or higher.
-
-Clone the latest version of the docsy theme into the parent folder of your
-project. The newly created repo should now reside in a sibling folder of your
-site's root folder.
-
-```shell
-cd root-of-your-site
-git clone --branch v0.12.0 https://github.com/google/docsy.git ../docsy
-```
-
-Now run:
-
-```shell
-HUGO_MODULE_WORKSPACE=docsy.work hugo server --ignoreVendorPaths "**"
-```
-
-or, when using npm, prepend `local` to the script you want to invoke, e.g.:
-
-```shell
-npm run local serve
-```
-
-By using the `HUGO_MODULE_WORKSPACE` directive (either directly or via prefix
-`local` when using npm), the server now watches all files and directories inside
-the sibling directory `../docsy` , too. Any changes inside the local `docsy`
-theme clone are now immediately picked up (hot reload), you can instantly see
-the effect of your local edits.
-
-In the command above, we used the environment variable `HUGO_MODULE_WORKSPACE`
-to tell hugo about the local workspace file `docsy.work`. Alternatively, you can
-declare the workspace file inside your settings file `hugo.toml`:
-
-```toml
-[module]
-  workspace = "docsy.work"
-```
-
-Your project's `hugo.toml` file already contains these lines, the directive for
-workspace assignment is commented out, however. Remove the two trailing comment
-characters '//' so that this line takes effect.
-
-## Troubleshooting
-
-As you run the website locally, you may run into the following error:
-
-```console
-$ hugo server
-WARN 2023/06/27 16:59:06 Module "project" is not compatible with this Hugo version; run "hugo mod graph" for more information.
-Start building sites …
-hugo v0.101.0-466fa43c16709b4483689930a4f9ac8add5c9f66+extended windows/amd64 BuildDate=2022-06-16T07:09:16Z VendorInfo=gohugoio
-Error: Error building site: "C:\Users\foo\path\to\docsy-example\content\en\_index.md:5:1": failed to extract shortcode: template for shortcode "blocks/cover" not found
-Built in 27 ms
+hugo --gc --minify
 ```
 
-This error occurs if you are running an outdated version of Hugo. As of docsy
-theme version `v0.12.0`, hugo version `0.146.0` or higher is required. See this
-[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)
-of the user guide for instructions on how to install Hugo.
-
-Or you may be confronted with the following error:
+## Content structure
 
-```console
-$ hugo server
-
-INFO 2021/01/21 21:07:55 Using config file:
-Building sites … INFO 2021/01/21 21:07:55 syncing static files to /
-Built in 288 ms
-Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache
-```
-
-This error occurs if you have not installed the extended version of Hugo. See
-this
-[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)
-of the user guide for instructions on how to install Hugo.
-
-Or you may encounter the following error:
-
-```console
-$ hugo server
-
-Error: failed to download modules: binary with name "go" not found
-```
+- Homepage: `content/en/_index.md`
+- Docs landing: `content/en/docs/_index.md`
+- Core docs pages: `content/en/docs/*.md`
+- About page: `content/en/about/index.md`
+- Community page: `content/en/community/_index.md`
+- Static images: `static/images/`
 
-This error occurs if the `go` programming language is not available on your
-system. See this
-[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language)
-of the user guide for instructions on how to install `go`.
+## Deployment
 
-[alternate dashboard]: https://app.netlify.com/sites/goldydocs/deploys
-[deploys]: https://app.netlify.com/sites/docsy-example/deploys
-[Docsy user guide]: https://docsy.dev/docs
-[Docsy]: https://github.com/google/docsy
-[example.docsy.dev]: https://example.docsy.dev
-[Hugo theme module]:
-  https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
-[Netlify]: https://netlify.com
-[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/
+This site is intended for GitHub Pages deployment from this repository.
 
-<!-- cSpell:ignore hugo docsy TOCSS -->
+If you decide between `swanlake.github.io` and `swanlake-io.github.io`, update `baseURL` in `hugo.yaml` to the final canonical URL.