From ae3082b7b20fac34372b12fb4cd0a2c72a4df1f0 Mon Sep 17 00:00:00 2001 From: tofuwine Date: Mon, 13 May 2024 09:58:48 +0800 Subject: [PATCH] PaperMod-PE --- .github/ISSUE_TEMPLATE/bug_report.md | 50 ------------ .github/ISSUE_TEMPLATE/config.yml | 5 -- .github/ISSUE_TEMPLATE/proposal.md | 7 -- .github/PULL_REQUEST_TEMPLATE.md | 44 ----------- .github/workflows/gh-pages.yml | 77 ------------------- .gitignore | 1 + LICENSE | 1 + README.md | 111 ++++++--------------------- assets/css/core/license.css | 7 +- assets/css/extended/blank.css | 2 - assets/js/license.js | 5 +- go.mod | 2 +- layouts/_default/baseof.html | 4 +- layouts/partials/footer.html | 2 +- theme.toml | 20 ++--- 15 files changed, 45 insertions(+), 293 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/proposal.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/gh-pages.yml create mode 100644 .gitignore diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d88b750f73..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: '' - ---- - - - -**Describe the bug** - - - - Device/Os: [e.g. Android 10] - - Type: [e.g. Desktop/Mobile] - - Browser and version [e.g. Chrome 86.0]: - - Hugo Version [ >=0.112.4 expected]: - - Theme Version [e.g. v4.0, master, or commit-id ]: - -**Steps to reproduce the behavior:** - - -**Expected behavior**: - - -**Repo/Source where this issue can be reproduced**: - - -**Screenshots** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index eeb6e553c3..0000000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,5 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: PaperMod Discussions - url: https://github.com/adityatelange/hugo-PaperMod/discussions - about: Please ask and answer questions/doubts here, DO NOT open an issue for questions. diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md deleted file mode 100644 index c7e35e120e..0000000000 --- a/.github/ISSUE_TEMPLATE/proposal.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: Proposal -about: Propose a new feature or change to a feature for Hugo-PaperMod. -title: "" -labels: "enhancement" -assignees: "" ---- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 00b856cb24..0000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,44 +0,0 @@ - - - -**What does this PR change? What problem does it solve?** - - - - -**Was the change discussed in an issue or in the Discussions before?** - - - - -## PR Checklist - -- [ ] This change adds/updates translations and I have used the [template present here](https://github.com/adityatelange/hugo-PaperMod/wiki/Translations#want-to-add-your-language-). -- [ ] I have enabled [maintainer edits for this PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork). -- [ ] I have verified that the code works as described/as intended. -- [ ] This change adds a Social Icon which has a permissive license to use it. -- [ ] This change **does not** include any CDN resources/links. -- [ ] This change **does not** include any unrelated scripts such as bash and python scripts. -- [ ] This change updates the overridden internal templates from HUGO's repository. diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml deleted file mode 100644 index 6a43bcddf2..0000000000 --- a/.github/workflows/gh-pages.yml +++ /dev/null @@ -1,77 +0,0 @@ -name: Deploy Hugo PaperMod Demo to Pages - -on: - push: - paths-ignore: - - "images/**" - - "LICENSE" - - "README.md" - branches: - - master - - exampleSite - workflow_dispatch: - # manual run - inputs: - hugoVersion: - description: "Hugo Version" - required: false - default: "0.112.4" - -# Allow one concurrent deployment -concurrency: - group: "pages" - cancel-in-progress: true - -# Default to bash -defaults: - run: - shell: bash - -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - -jobs: - # Build job - build: - runs-on: ubuntu-latest - env: - HUGO_VERSION: ${{ github.event.inputs.hugoVersion || '0.112.4' }} - steps: - - name: Install Hugo CLI - run: | - wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_${HUGO_VERSION}_linux-amd64.deb \ - && sudo dpkg -i ${{ runner.temp }}/hugo.deb - - name: Checkout - uses: actions/checkout@v3 - with: - ref: exampleSite - - name: Setup Pages - id: pages - uses: actions/configure-pages@v3 - - name: Get Theme - run: git submodule update --init --recursive - - name: Update theme to Latest commit - run: git submodule update --remote --merge - - name: Build with Hugo - run: | - hugo \ - --buildDrafts --gc \ - --baseURL ${{ steps.pages.outputs.base_url }} - - name: Upload artifact - uses: actions/upload-pages-artifact@v2 - with: - path: ./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@v2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..723ef36f4e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea \ No newline at end of file diff --git a/LICENSE b/LICENSE index 07edff36c9..859e8d71a7 100644 --- a/LICENSE +++ b/LICENSE @@ -2,6 +2,7 @@ MIT License Copyright (c) 2020 nanxiaobei and adityatelange Copyright (c) 2021-2024 adityatelange +Copyright (c) 2024 tofuwine Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 0637bf92cf..bcbe06b28b 100644 --- a/README.md +++ b/README.md @@ -1,106 +1,39 @@ -

Hugo PaperMod | Demo

+

PaperMod PE | Demo

-

โ˜„๏ธ Fast | โ˜๏ธ Fluent | ๐ŸŒ™ Smooth | ๐Ÿ“ฑ Responsive


-> Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper/tree/4330c8b12aa48bfdecbcad6ad66145f679a430b3).
-> The goal of this project is to add more features and customization to the og theme. +PaperMod PE ๆ˜ฏ [Hugo-PaperMod](https://github.com/adityatelange/hugo-PaperMod) ็š„ไธชๆ€งๅŒ–็‰ˆๆœฌใ€‚ -**Documentation** can be found here: [**๐Ÿ“š Wiki**](https://github.com/adityatelange/hugo-PaperMod/wiki) -**ExampleSite** can be found here: [**exampleSite**](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite). Demo is built up with [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite) as source. +## Todolist -[![hugo-papermod](https://img.shields.io/badge/Hugo--Themes-@PaperMod-blue)](https://themes.gohugo.io/themes/hugo-papermod/) -[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=>=v0.112.4&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.112.4) -[![Discord](https://img.shields.io/discord/971046860317921340?label=Discord&logo=discord)](https://discord.gg/ahpmTvhVmp) -[![GitHub](https://img.shields.io/github/license/adityatelange/hugo-PaperMod)](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE) -![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod) -[![X (formerly Twitter) URL](https://img.shields.io/badge/-Share%20on%20X-gray?style=flat&logo=x)](https://x.com/intent/tweet/?text=Checkout%20Hugo%20PaperMod%20%E2%9C%A8%0AA%20fast,%20clean,%20responsive%20Hugo%20theme.&url=https://github.com/adityatelange/hugo-PaperMod&hashtags=Hugo,PaperMod) +็Šถๆ€่ฏดๆ˜Ž: +๐ŸŸข ๅฎŒๆˆ +๐ŸŸ  ๆต‹่ฏ• +๐ŸŸฃ ๅผ€ๅ‘ +๐Ÿ”ต ๅพ…ๅŠž +โšซ ๅผƒ็”จ +### ๆ ทๅผ ---- +- ๐Ÿ”ต ไปฃ็ ๅ— -

- Mockup image -

+### ๅŠŸ่ƒฝ ---- +- ๐Ÿ”ต giscus (่ฏ„่ฎบ) +- ๐Ÿ”ต Mermaid +- ๐Ÿ”ต LaTex -## Features/Mods ๐Ÿ’ฅ +### shortcode -- Uses Hugo's asset generator with pipelining, fingerprinting, bundling and minification by default. -- 3 Modes: - - [Regular Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#regular-mode-default-mode) - - [Home-Info Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#home-info-mode) - - [Profile Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#profile-mode) -- Table of Content Generation (newer implementation). -- Archive of posts. -- Social Icons (home-info and profile-mode). -- Social-Media Share buttons on posts. -- Menu location indicator. -- Multilingual support. (with language selector). -- Taxonomies. -- Cover image for each post (with Responsive image support). -- Light/Dark theme (automatic theme switch a/c to browser theme and theme-switch button). -- SEO Friendly. -- Multiple Author support. -- Search Page with Fuse.js -- Other Posts suggestion below a post -- Breadcrumb Navigation. -- Code Block Copy buttons. -- Hugo's Chroma syntax highlighter. -- No webpack, nodejs and other dependencies are required to edit the theme. +- ๐Ÿ”ต admonition +- ๐Ÿ”ต hl -Read Wiki For More Details => **[PaperMod - Features](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)** +### ่‡ชๅฎšไน‰้กต้ข ---- +- ๐Ÿ”ต ๅ…ณไบŽ +- ๐Ÿ”ต ๆœ€ๆ–ฐๆ–‡็ซ  +- ๐Ÿ”ต ๅ‹้“พ -## Install/Update ๐Ÿ“ฅ -Read Wiki For More Details => **[PaperMod - Installation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)** ---- - -## FAQs / How To's Guide ๐Ÿ™‹ - -Read Wiki For More Details => **[PaperMod-FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)** - ---- - -## Social-Icons/Share-Icons ๐Ÿ–ผ๏ธ - -Read Wiki For More Details => **[PaperMod-Icons](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)** - ---- - -## Release Changelog ๐Ÿ“ƒ - -Release ChangeLog has info about stuff added: **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)** - ---- - -## [Pagespeed Insights (100% ?)](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/) ๐Ÿ‘€ - ---- - -## Support ๐Ÿซถ - -- Star ๐ŸŒŸ this repository. -- Help spread the word about PaperMod by sharing it on social media and recommending it to your friends. ๐Ÿ—ฃ๏ธ -- You can also sponsor ๐Ÿ… on [Github Sponsors](https://github.com/sponsors/adityatelange) / [Ko-Fi](https://ko-fi.com/adityatelange). - ---- - -## Special Thanks ๐ŸŒŸ - -- [**Highlight.js**](https://github.com/highlightjs/highlight.js) -- [**Fuse.js**](https://github.com/krisk/fuse) -- [**Feather Icons**](https://github.com/feathericons/feather) -- [**Simple Icons**](https://github.com/simple-icons/simple-icons) -- **All Contributors and Supporters** - ---- - -## Stargazers over time ๐Ÿ“ˆ - -[![Stargazers over time](https://starchart.cc/adityatelange/hugo-PaperMod.svg?background=%23ffffff00&axis=%23858585&line=%236b63ff)](https://starchart.cc/adityatelange/hugo-PaperMod) diff --git a/assets/css/core/license.css b/assets/css/core/license.css index fb3dfecc00..b38b842f51 100644 --- a/assets/css/core/license.css +++ b/assets/css/core/license.css @@ -1,6 +1,7 @@ /* - PaperMod v7 - License: MIT https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE + PaperMod-PE V1 + License: MIT https://github.com/tofuwine/PaperMod-PE/blob/master/LICENSE Copyright (c) 2020 nanxiaobei and adityatelange Copyright (c) 2021-2024 adityatelange -*/ + Copyright (c) 2024 tofuwine +*/ \ No newline at end of file diff --git a/assets/css/extended/blank.css b/assets/css/extended/blank.css index a577295368..5082933485 100644 --- a/assets/css/extended/blank.css +++ b/assets/css/extended/blank.css @@ -1,5 +1,3 @@ /* This is just a placeholder blank stylesheet so as to support adding custom styles budled with theme's default styles - -Read https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#bundling-custom-css-with-themes-assets for more info */ diff --git a/assets/js/license.js b/assets/js/license.js index fb3dfecc00..763afab772 100644 --- a/assets/js/license.js +++ b/assets/js/license.js @@ -1,6 +1,7 @@ /* - PaperMod v7 - License: MIT https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE + PaperMod-PE V1 + License: MIT https://github.com/tofuwine/PaperMod-PE/blob/master/LICENSE Copyright (c) 2020 nanxiaobei and adityatelange Copyright (c) 2021-2024 adityatelange + Copyright (c) 2024 tofuwine */ diff --git a/go.mod b/go.mod index af95855690..76cf58d61d 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ -module github.com/adityatelange/hugo-PaperMod +module github.com/tofuwine/PaperMod-PE go 1.12 diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index df611bfbea..d8e0935362 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -1,5 +1,5 @@ -{{- if lt hugo.Version "0.112.4" }} -{{- errorf "=> hugo v0.112.4 or greater is required for hugo-PaperMod to build " }} +{{- if lt hugo.Version "0.125.3" }} +{{- errorf "=> hugo 0.125.3 or greater is required for PaperMod-PE to build " }} {{- end -}} diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 832cdbad33..115f8787f7 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -17,7 +17,7 @@ Powered by Hugo & - PaperMod + PaperMod-PE {{- end }} diff --git a/theme.toml b/theme.toml index f659f5c9aa..dda604e60a 100644 --- a/theme.toml +++ b/theme.toml @@ -1,11 +1,11 @@ # theme.toml template for a Hugo theme # See https://github.com/gohugoio/hugoThemes#themetoml for an example -name = "PaperMod" +name = "PaperMod-PE" license = "MIT" -licenselink = "https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE" +licenselink = "https://github.com/tofuwine/PaperMod-PE/blob/master/LICENSE" description = "A fast, clean, responsive Hugo theme" -homepage = "https://adityatelange.github.io/hugo-PaperMod/" +homepage = "https://tofuwine.github.io" tags = [ "responsive", "simple", @@ -37,15 +37,15 @@ features = [ "scroll-to-top", "search" ] -min_version = "0.112.4" +min_version = "0.125.3" [author] - name = "Aditya Telange" - homepage = "https://github.com/adityatelange/" + name = "tofuwine" + homepage = "https://github.com/tofuwine/" # If porting an existing theme [original] - name = "Paper" - author = "nanxiaobei" - homepage = "https://github.com/nanxiaobei" - repo = "https://github.com/nanxiaobei/hugo-paper/" + name = "PaperMod" + author = "adityatelange" + homepage = "https://github.com/adityatelange/" + repo = "https://github.com/adityatelange/hugo-PaperMod/"