diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3c830a4..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environment (please complete the following information):** - -- OS: [e.g. macOS] -- Browser [e.g. chrome, safari] -- Hugo Version [e.g. v0.114.0 extended] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..e2a30d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,115 @@ +name: Bug report +description: Create a bug report +labels: + - 'T: Bug' + - 'S: Untriaged' +body: + - type: markdown + attributes: + value: | + Please finish verify steps which list in the end first before create bug report + + - type: textarea + id: reproduce + attributes: + label: Step to reproduce + description: | + Please write down the reproduction steps here and include the error log. If necessary, please provide screenshots or recordings. + placeholder: | + 1. + 2. + 3. + [Screen recording] + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behaviour + description: | + Describe what should happened here + placeholder: | + It should be ... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behaviour + description: | + Describe what actually happened here, screenshots is better + placeholder: | + Actually it ... + [Screenshots] + validations: + required: true + + - type: textarea + id: env + attributes: + label: Logs + description: | + CLI output or browser log. + placeholder: | + ❯ pnpm run server + + > bridget@v1.0.0 server /Users/spedon/eden/hugo/bridget + > run-p vite:server hugo:server + validations: + required: false + + - type: textarea + id: more + attributes: + label: Addition details + description: | + Describe addition details here + placeholder: | + Additional details and attachments + validations: + required: false + + - type: input + id: hugo-version + attributes: + label: Hugo version + description: You can get version output with hugo --version + placeholder: v0.114.0 + validations: + required: true + + - type: input + id: bridget-version + attributes: + label: Bridget version + description: Release version or commit SHA + placeholder: v1.0.1 or 633f6a40e202a023471c58c09f05a92ec2130c93 + validations: + required: true + + - type: input + id: system + attributes: + label: OS version + description: OS + version code + placeholder: Windows 11, macOS 14 + validations: + required: true + + - type: checkboxes + id: check + attributes: + label: Verify steps + description: | + Please ensure you have obtained all needed options + options: + - label: Pull request is welcome. Check this if you want to start a pull request + required: false + + - label: I have searched on [Issue Tracker](https://github.com/Sped0n/bridget/issues), No duplicate or related open issue has been found + required: true + + - label: Ensure there is only one bug report in this issue. Please make mutiply issue for mutiply bugs + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..05f63fb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: All other questions + url: https://github.com/Sped0n/bridget/discussions + about: Turn to discussions diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 2f28cea..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..c675efe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,60 @@ +name: Feature request +description: Suggest an idea +labels: + - 'T: Feature' + - 'S: Untriaged' +body: + - type: markdown + attributes: + value: | + Please finish verify steps which list in the end first before suggest an idea + + - type: textarea + id: request + attributes: + label: Requirement + description: | + Ddescribe what you need here. + placeholder: | + I want ABC feature ... + validations: + required: true + + - type: textarea + id: impl + attributes: + label: Suggested implements + description: | + Describe your suggested implements here, It's recommend to add a photo if you are making a UI feature request. + placeholder: | + I recommend add ABC feature to DEF... + Photos (if exists) + validations: + required: true + + - type: textarea + id: more + attributes: + label: Addition details + description: | + Describe addition details here + placeholder: | + Additional details and attachments + validations: + required: false + + - type: checkboxes + id: check + attributes: + label: Verify steps + description: | + Please ensure you have obtained all needed options + options: + - label: Pull request is welcome. Check this if you want to start a pull request + required: false + + - label: I have searched on [Issue Tracker](https://github.com/Sped0n/bridget/issues), No duplicate or related open issue has been found + required: true + + - label: Ensure there is only one feature request in this issue. Please make mutiply issue for mutiply feature request + required: true diff --git a/README.md b/README.md index c7ecc29..6aec895 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Sped0n/bridget/build.yml?logo=github) ![GitHub deployments](https://img.shields.io/github/deployments/Sped0n/bridget/Production?logo=vercel&label=deploy) -Bridget is a minimal [Hugo](https://gohugo.io) theme designed for photographers / visual artists. +Bridget is a minimal [Hugo](https://gohugo.io) theme for photographers/visual artists, powered by Solid.js. -It’s based on the https://github.com/tylermcrobert/bridget-pictures-www. +Based on the https://github.com/tylermcrobert/bridget-pictures-www. ![thumbnail](images/tn.jpg) @@ -18,10 +18,9 @@ Head to this [documentation](https://github.com/Sped0n/bridget/blob/main/doc/get ## Features -- **Blazingly fast**: 99/100 on mobile and 100/100 on desktop in [Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights) - -- JS **dynamic loading** (powered by ES6 syntax) -- JS **code splitting** by [rollup.js](https://rollupjs.org) +- **Blazingly fast**: 100/100 on both desktop and mobile in [Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights) +- Powered by **[Solid.js](https://www.solidjs.com)**, a declarative, efficient, and flexible JavaScript library for building user interfaces +- JS **dynamic loading** (powered by ESM) - Image **Preloading**/**Lazy loading** - **Dynamic resolution** based on view mode - Multiple **analytics** services supported @@ -46,3 +45,4 @@ Bridget supports the following languages: - https://github.com/tylermcrobert/bridget-pictures-www - https://www.youtube.com/watch?v=Jt3A2lNN2aE - https://github.com/d4cho/bridget-pictures-clone +- https://www.solidjs.com/tutorial diff --git a/doc/getStarted.md b/doc/getStarted.md index a915bf6..c8db8fc 100644 --- a/doc/getStarted.md +++ b/doc/getStarted.md @@ -182,14 +182,6 @@ path = "github.com/Sped0n/bridget" Detailed description in the comments. -> ⚠️⚠️⚠️ -> -> Only thing that you need to pay **extra attention** is the [`bundled`](https://github.com/Sped0n/bridget/blob/1e2f1fadde9c16989eef1ab771f2ac8463dec5a4/exampleSite/config/_default/params.toml#L6) option, please read the corresponding doc and set it as your need. -> -> For users who have installation with module, please always set this option to `true`, unless you know what you are doing. -> -> Or you might get the error related to `node_modules/swiper/swiper.scss`. - ### `sitemap.toml` https://gohugo.io/templates/sitemap-template/#configuration @@ -197,23 +189,9 @@ https://gohugo.io/templates/sitemap-template/#configuration ## Customization (AKA for developer) > Before heading to this section, please make sure you have **installation with Git**. +> +> You can use any package manager you want (npm/pnpm/yarn/bun). -### Option 1: _it just works_ way - -> If you want to modify js/ts file, please use option 2. - -1. Use hugo create a site and move the bridget theme into the theme directory. -2. Run `npm install` in the _bridget theme root dir_, not _your hugo site root dir_. -3. After the command is done, copy the `node_modules` dir from _bridget theme root dir_ to _your hugo site root dir_. -4. In _your hugo site root dir_, write/modify configuration files according to your needs, remember to set `bundled` option to `false`, so hugo will not use prebuilt css file. -5. Run `hugo server` in _your hugo site root dir_, and you are good to go. - -### Option 2: recommended way - -1. Use hugo create a site and move the bridget theme into the theme directory. -2. Run `npm install` in the _bridget theme root dir_, not _your hugo site root dir_. -3. Run `npm run dev` in the _bridget theme root dir_, we will use content in exampleSite to debug. -4. Make your customization. -5. After modification, run `npm run build` in the _bridget theme root dir_ to build artifacts. -6. In _your hugo site root dir_, write/modify configuration files according to your needs, remember to set `bundled` option to `true`, so hugo will use the artifacts you built in step 5. -7. Run `hugo server` in _your hugo site root dir_, and you are good to go. +- run `pnpm install` to install neceessary dependencies. +- run `pnpm run dev` to host a dev server. +- when you’re ready, run `pnpm run build` to update artifacts.