From 30c4ff0288c6504730ce78c40e40e050bc2e3ab1 Mon Sep 17 00:00:00 2001 From: alyenc Date: Tue, 21 Jan 2025 03:36:23 +0800 Subject: [PATCH] update --- .devcontainer/devcontainer.json | 22 ----- .github/CONTRIBUTING.md | 110 ---------------------- .github/FUNDING.yml | 15 --- .github/ISSUE_TEMPLATE/bug_report.md | 42 --------- .github/ISSUE_TEMPLATE/feature_request.md | 24 ----- .github/workflows/pages.yml | 78 --------------- .vscode/settings.json | 5 - .vscode/tailwind.json | 55 ----------- 8 files changed, 351 deletions(-) delete mode 100644 .devcontainer/devcontainer.json delete mode 100644 .github/CONTRIBUTING.md delete mode 100644 .github/FUNDING.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/workflows/pages.yml delete mode 100644 .vscode/settings.json delete mode 100644 .vscode/tailwind.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json deleted file mode 100644 index 5401f2c..0000000 --- a/.devcontainer/devcontainer.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "image": "mcr.microsoft.com/devcontainers/go:1", - "features": { - "ghcr.io/devcontainers/features/hugo:1": { - "extended": true, - "version": "0.131.0" - }, - "ghcr.io/devcontainers/features/node:1": {} - }, - "customizations": { - "vscode": { - "extensions": [ - "mhutchie.git-graph", - "esbenp.prettier-vscode", - "tamasfe.even-better-toml", - "budparr.language-hugo-vscode" - ] - } - }, - "postCreateCommand": "npm install", - "forwardPorts": [1313] -} diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index edaa953..0000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,110 +0,0 @@ -# Contribute to Hextra - -👋 Thank you for being interested in contributing to Hextra! As an open source project, we welcome contributions of many forms including bug reports, feature requests, documentation improvements, and code contributions. - - -## Table of Contents - -- [Guidelines](#guidelines) - - [Contributing Code](#contributing-code) - - [Contributing Documentation](#contributing-documentation) - - [💬 GitHub Discussions](#-github-discussions) - - [GitHub Issues](#github-issues) -- [Development](#development) - - [Local development setup](#local-development-setup) - - [Project structure](#project-structure) - - [Start the development server](#start-the-development-server) - - [Compile the styles](#compile-the-styles) - - -## Guidelines - -### Contributing Code - -To contribute, please follow the ["Fork and Pull Request"][fork and pull] workflow： - -Fork the repository, make your changes, and then submit a pull request. -Please make sure to include a description of the changes you made and why you made them. -Use [Conventional Commits][conventional commits] message to make it easier to understand the changes you made. - -### Contributing Documentation - -Similar to contributing code, you can also contribute to the documentation by submitting a pull request. - -The documentation site is located in the [`exampleSite`](../exampleSite/) folder. -You can make changes to the documentation and create a pull request. A preview of the new documentation will be automatically generated and displayed in the pull request comment via [Netlify][netlify deploy preview]. - -### 💬 GitHub Discussions - -We’re using [Discussions][discussions] as a place to connect with other members using Hextra: - -- Ask questions you’re wondering about. -- Share ideas. -- Engage with other users. - -### GitHub Issues - -If you find a bug or have a feature request, please [open an issue][issues]. - -Please make sure to include a description of the bug or feature you are requesting. If you are reporting a bug, please include steps to reproduce the bug. - -We recommend that you search existing [issues][issues] or discussions before opening a new one to prevent duplicates. - -## Development - -> **Note** -> You can start developing on [GitHub Codespaces][open in codespaces] or use [devcontainer][devcontainer] locally without installing any dependencies. - -### Local development setup - -- [Hugo][hugo] >= v0.124.0 (extended version) -- [Node.js][nodejs] -- [Go][go] - -Install dependencies: - -```bash -npm i -``` - -### Project structure - -- [`assets`](../assets/): CSS styles and JavaScript files. -- [`data`](../data/): The theme data files. Now only contains the `icons.yaml` file. -- [`exampleSite`](../exampleSite/): The documentation site for the theme. -- [`i18n`](../i18n/): The theme translation files. -- [`layouts`](../layouts/): The theme layouts. -- [`static`](../static/): The static files for the theme. For example, the favicon and the site logo. - -Please refer to the [Hugo documentation][hugo] for more information. - -### Start the development server - -```bash -npm run dev:theme -``` - -It will start the Hugo server on `http://localhost:1313/` for the `exampleSite` content. - -### Compile the styles - -For development preview, we compile the Tailwind CSS styles on the fly. But for production, we need to compile the styles first. - -```bash -npm run build:css -``` - -It will compile the Tailwind CSS styles and generate the `assets/css/compiled/main.css` file. - - - -[fork and pull]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects -[conventional commits]: https://www.conventionalcommits.org -[issues]: https://github.com/imfing/hextra/issues -[discussions]: https://github.com/imfing/hextra/discussions -[nodejs]: https://nodejs.org/en/ -[hugo]: https://gohugo.io/ -[go]: https://golang.org/doc/install -[devcontainer]: https://code.visualstudio.com/docs/devcontainers/containers -[open in codespaces]: https://codespaces.new/imfing/hextra -[netlify deploy preview]: https://docs.netlify.com/site-deploys/deploy-previews/ diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index b1d6700..0000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,15 +0,0 @@ -# These are supported funding model platforms - -github: imfing -patreon: # Replace with a single Patreon username -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry -polar: # Replace with a single Polar username -buy_me_a_coffee: # Replace with a single Buy Me a Coffee username -thanks_dev: # Replace with a single thanks.dev username -custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 41be0cf..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Description** - - - -**Steps To Reproduce** - -1. -2. -3. - - - -**Expected Behavior** - - - -**Actual Behavior** - - - -**Screenshots** - - - -**Environment** - -- Hugo Version: [e.g., 0.85.0] -- Browser/OS: [e.g., Chrome, MacOS] -- Theme Version: [e.g., v2.0] - -**Additional Context** - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 6937c03..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Feature Description** - - - -**Problem/Solution** - - - -**Alternatives Considered** - - - -**Additional Context** - - diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml deleted file mode 100644 index 8c9d466..0000000 --- a/.github/workflows/pages.yml +++ /dev/null @@ -1,78 +0,0 @@ -# Sample workflow for building and deploying a Hugo site to GitHub Pages -name: Deploy Hugo site to Pages - -on: - # Runs on pushes targeting the default branch - push: - branches: ["main"] - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - -# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. -# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. -concurrency: - group: "pages" - cancel-in-progress: false - -# Default to bash -defaults: - run: - shell: bash - -jobs: - # Build job - build: - runs-on: ubuntu-latest - env: - HUGO_VERSION: 0.138.0 - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod - submodules: recursive - - name: Setup Go - uses: actions/setup-go@v5 - with: - go-version: '1.23' - - name: Setup Pages - id: pages - uses: actions/configure-pages@v5 - - name: Setup Hugo - run: | - 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: Build with Hugo - env: - # For maximum backward compatibility with Hugo modules - HUGO_ENVIRONMENT: production - HUGO_ENV: production - # Use the latest release of the theme to build exampleSite - run: | - cd exampleSite && rm go.mod - hugo mod init github.com/imfing/hextra/exampleSite - hugo mod get -u github.com/imfing/hextra - hugo --minify --baseURL "${{ steps.pages.outputs.base_url }}/" - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: ./exampleSite/public - - # Deployment job - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - needs: build - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index d238639..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "editor.tabSize": 2, - "css.customData": [".vscode/tailwind.json"], - "markdown.extension.toc.levels": "2..6" -} diff --git a/.vscode/tailwind.json b/.vscode/tailwind.json deleted file mode 100644 index 96a1f57..0000000 --- a/.vscode/tailwind.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "version": 1.1, - "atDirectives": [ - { - "name": "@tailwind", - "description": "Use the `@tailwind` directive to insert Tailwind's `base`, `components`, `utilities` and `screens` styles into your CSS.", - "references": [ - { - "name": "Tailwind Documentation", - "url": "https://tailwindcss.com/docs/functions-and-directives#tailwind" - } - ] - }, - { - "name": "@apply", - "description": "Use the `@apply` directive to inline any existing utility classes into your own custom CSS. This is useful when you find a common utility pattern in your HTML that you’d like to extract to a new component.", - "references": [ - { - "name": "Tailwind Documentation", - "url": "https://tailwindcss.com/docs/functions-and-directives#apply" - } - ] - }, - { - "name": "@responsive", - "description": "You can generate responsive variants of your own classes by wrapping their definitions in the `@responsive` directive:\n```css\n@responsive {\n .alert {\n background-color: #E53E3E;\n }\n}\n```\n", - "references": [ - { - "name": "Tailwind Documentation", - "url": "https://tailwindcss.com/docs/functions-and-directives#responsive" - } - ] - }, - { - "name": "@screen", - "description": "The `@screen` directive allows you to create media queries that reference your breakpoints by **name** instead of duplicating their values in your own CSS:\n```css\n@screen sm {\n /* ... */\n}\n```\n…gets transformed into this:\n```css\n@media (min-width: 640px) {\n /* ... */\n}\n```\n", - "references": [ - { - "name": "Tailwind Documentation", - "url": "https://tailwindcss.com/docs/functions-and-directives#screen" - } - ] - }, - { - "name": "@variants", - "description": "Generate `hover`, `focus`, `active` and other **variants** of your own utilities by wrapping their definitions in the `@variants` directive:\n```css\n@variants hover, focus {\n .btn-brand {\n background-color: #3182CE;\n }\n}\n```\n", - "references": [ - { - "name": "Tailwind Documentation", - "url": "https://tailwindcss.com/docs/functions-and-directives#variants" - } - ] - } - ] -}