Merge pull request #3 from imlargo/migration

Migration

Author: imlargo

.github/workflows/node.yml

@@ -21,26 +21,17 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - name: Install node module
-        run: |
-          npm install -D --save autoprefixer
-          npm install -D --save postcss-cli
-          npm audit fix
-
-      - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v3
-        with:
-          hugo-version: '0.125.4'
-          extended: true
+      - name: Install node modules
+        run: npm install
 
       - name: Build
         run: |
-          hugo --minify
+          npm run build
           echo 'gin-gonic.com' > public/CNAME
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4
         if: github.ref == 'refs/heads/master'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./public
+          publish_dir: ./dist

.gitignore

@@ -1,3 +1,10 @@
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -11,7 +18,16 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
-public
-resources
-node_modules
-.hugo_build.lock
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*

README.md

@@ -1,26 +1,17 @@
-
 # Gin website
 
 [![Run Deploy](https://github.com/gin-gonic/website/actions/workflows/node.yml/badge.svg)](https://github.com/gin-gonic/website/actions/workflows/node.yml)
 
 Welcome! This repository houses all the assets required to build the Gin website and documentation. We're pleased that you want to contribute! The website is hosted at https://gin-gonic.com.
 
-We use [Hugo](https://gohugo.io/) to format and generate our website, the [Docsy](https://github.com/google/docsy) theme for styling and site structure. Thanks!.
-
-**Note:** We only support hugo [v0.75.1 version](https://github.com/gohugoio/hugo/releases/tag/v0.75.1).
+We use [Astro](https://astro.build) to format and generate our website, the [Starlight](https://starlight.astro.build) template for styling and site structure. Thanks!.
 
 ## Contribution
 
 - Fork the repository
 
 You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called as fork.
 
-> You need to use the below command to clone code for docsy theme.
-
-```sh
-git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git themes/docsy
-```
-
 - Create one pull request
 
 Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
@@ -31,19 +22,52 @@ Once your pull request is created, a Gin reviewer will take responsibility for p
 
 ## Running
 
-See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions.
+See the [official Astro documentation](https://docs.astro.build/en/getting-started) for Astro installation instructions. and [Starlight documentation](https://starlight.astro.build/getting-started) for Starlight installation instructions.
 
 To run the site locally when you have Hugo installed:
 
 ```sh
-# If use `hugo` command, you need to use `npm install` command
-$ npm install
-$ hugo
-# Or use `hugo server`, it not need `npm install` command
-$ hugo server
+npm install
+npm run dev
 ```
 
-This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh.
+This will start the local Astro server on port 4321. Open up your browser to http://localhost:4321 to view the site. As you make changes to the source files, Astro updates the site and forces a browser refresh.
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   └── content.config.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
 
 ## Thanks
 

assets/scss/_variables_project.scss

@@ -0,0 +1,93 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import starlightUtils from "@lorenzo_lewis/starlight-utils";
+
+import sitemap from "@astrojs/sitemap";
+
+// https://astro.build/config
+export default defineConfig({
+    integrations: [starlight({
+        plugins: [starlightUtils({
+            multiSidebar: {
+                switcherStyle: "horizontalList",
+            },
+        })],
+
+        title: 'Gin Web Framework',
+        favicon: '/favicon.ico',
+        logo: {
+            src: "./src/assets/gin.png",
+        },
+
+        defaultLocale: 'en',
+        locales: {
+            'en': {
+                label: 'English',
+                lang: 'en',
+            },
+            'es': {
+                label: 'Español',
+                lang: 'es',
+            },
+            "fa": {
+                label: "Persian",
+                lang: "fa",
+            },
+            "ja": {
+                label: "日本語",
+                lang: "ja",
+            },
+            "ko-kr": {
+                label: "한국어",
+                lang: "ko-kr",
+            },
+            "pt": {
+                label: "Português",
+                lang: "pt",
+            },
+            "ru": {
+                label: "Russian",
+                lang: "ru",
+            },
+            "tr": {
+                label: "Turkish",
+                lang: "tr",
+            },
+            "zh-cn": {
+                label: "简体中文",
+                lang: "zh-cn",
+            },
+            "zh-tw": {
+                label: "繁體中文",
+                lang: "zh-tw",
+            },
+        },
+
+        social: {
+            github: 'https://github.com/gin-gonic/gin',
+            gitter: "https://gitter.im/gin-gonic/gin"
+        },
+        sidebar: [
+            {
+                label: "Docs",
+                autogenerate: { directory: "docs" }
+            },
+            {
+                label: "Blog",
+                autogenerate: { directory: "blog" }
+            },
+        ],
+        expressiveCode: {
+            themes: ['github-dark', 'github-light'],
+        },
+        editLink: {
+            baseUrl: 'https://github.com/gin-gonic/website/edit/master/',
+        },
+        customCss: [
+            './src/styles/custom.css',
+        ],
+        lastUpdated: true,
+        credits: false, // Opcional
+    }), sitemap()],
+});