Skip to content

Commit 92716d2

Browse files
netops2devopsnetops2devops
committed
re-add theme
1 parent 298e4e4 commit 92716d2

File tree

189 files changed

+12494
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

189 files changed

+12494
-0
lines changed

‎themes/PaperModX/.github/ISSUE_TEMPLATE/bug_report.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
12+
## READ BEFORE OPENING ISSUES
13+
14+
Please fill the template below
15+
- **DO NOT** ask for instructions.
16+
- Search for previous issues/ pull requests
17+
18+
-->
19+
20+
**Describe the bug**
21+
<!-- A clear and concise description of what the bug is. -->
22+
23+
- Device/Os: [e.g. Android 10]
24+
- Type: [e.g. Desktop/Mobile]
25+
- Browser and version [e.g. Chrome 86.0]:
26+
- Hugo Version [ >=0.83.0 expected]:
27+
- Theme Version [e.g. v4.0, master, or commit-id ]:
28+
29+
**Steps to reproduce the behavior:**
30+
<!--
31+
1. Go to '...'
32+
2. Click on '....'
33+
3. Scroll down to '....'
34+
4. See error
35+
-->
36+
37+
**Expected behavior**:
38+
<!-- A clear and concise description of what you expected to happen. -->
39+
40+
**Screenshots**
41+
<!-- If applicable, add screenshots to help explain your problem. -->
42+
43+
**Additional context**
44+
<!--Add any other context about the problem here. -->

‎themes/PaperModX/.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎themes/PaperModX/.github/ISSUE_TEMPLATE/new-blank-issue.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: New Blank Issue
3+
about: Anything other than bug report
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---

‎themes/PaperModX/.github/stale.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 7
3+
# Number of days of inactivity before a stale issue is closed
4+
daysUntilClose: 3
5+
# Issues with these labels will never be considered stale
6+
exemptLabels:
7+
- pinned
8+
- keep
9+
# Label to use when marking an issue as stale
10+
staleLabel: stale
11+
# Comment to post when marking an issue as stale. Set to `false` to disable
12+
markComment: >
13+
This issue has been automatically marked as stale because it has not had
14+
recent activity. It will be closed if no further activity occurs. Thank you
15+
for your contributions.
16+
# Comment to post when closing a stale issue. Set to `false` to disable
17+
closeComment: false

‎themes/PaperModX/.github/workflows/gh-pages.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# https://github.com/actions/starter-workflows/blob/main/pages/hugo.yml
2+
name: Deploy Hugo site to Pages
3+
4+
on:
5+
push:
6+
paths-ignore:
7+
- "README.md"
8+
branches:
9+
- master
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# Allow one concurrent deployment
21+
concurrency:
22+
group: "pages"
23+
cancel-in-progress: true
24+
25+
26+
jobs:
27+
build:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- uses: actions/checkout@v3
31+
with:
32+
fetch-depth: 1
33+
34+
- name: Configure Pages
35+
id: pages
36+
uses: actions/configure-pages@v3
37+
38+
- name: Setup Hugo
39+
uses: peaceiris/actions-hugo@v2
40+
with:
41+
hugo-version: 'latest'
42+
extended: true
43+
44+
- name: Build
45+
run: |
46+
hugo \
47+
--minify --verbose -D \
48+
--buildFuture \
49+
--environment production \
50+
--themesDir ../.. --theme hugo-PaperModX \
51+
--baseURL "${{ steps.pages.outputs.base_url }}/"
52+
working-directory: exampleSite
53+
- name: Upload artifact
54+
uses: actions/upload-pages-artifact@v1
55+
with:
56+
path: ./exampleSite/public
57+
58+
# Deployment job
59+
deploy:
60+
environment:
61+
name: github-pages
62+
url: ${{ steps.deployment.outputs.page_url }}
63+
runs-on: ubuntu-latest
64+
needs: build
65+
steps:
66+
- name: Deploy to GitHub Pages
67+
id: deployment
68+
uses: actions/deploy-pages@v1

‎themes/PaperModX/.hugo_build.lock

Whitespace-only changes.

‎themes/PaperModX/.vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"search.exclude": {
3+
"**/public": true
4+
}
5+
}

‎themes/PaperModX/LICENSE

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2020 nanxiaobei and adityatelange
4+
Copyright (c) 2021 adityatelange
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

‎themes/PaperModX/Makefile

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
run-default:
2+
cd exampleSite && hugo server -D --gc -p 13131 --config config.default.yml
3+
4+
run-profile-mode:
5+
cd exampleSite && hugo server -D --gc -p 13131 --config config.profileMode.yml
6+
7+
chroma-css:
8+
hugo gen chromastyles --style=onedark > assets/css/lib/chroma-dark.css
9+
hugo gen chromastyles --style=tango > assets/css/lib/chroma-light.css

‎themes/PaperModX/README.md

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# PaperModX
2+
3+
PaperModX is a forked version of [PaperMod](https://github.com/adityatelange/hugo-PaperMod),
4+
it aims at adding new features and improving code quality,
5+
makes it easier to read and modify by anyone with basic knowledge of Hugo and HTML.
6+
7+
Features and changes:
8+
- Table of Contents (ToC) floating on the side
9+
- InstantClick integration
10+
- Social icons from [Simple Icons](https://simpleicons.org/)
11+
- Opinionated UI enhancements
12+
13+
## Getting started
14+
15+
You can use [reorx/papermodx-example](https://github.com/reorx/papermodx-example) as a boilerplate to create a new Hugo site with PaperModX theme. For detailed instructions please see the README of papermodx-example repo.
16+
17+
## Table of Contents (ToC) floating on the side
18+
19+
By adding config:
20+
21+
```yaml
22+
params:
23+
TocSide: 'left' # or 'right'
24+
```
25+
26+
ToC will float on the left/right side of the page.
27+
You can take a look at how `'right'` feels like in [Installation | Update](https://reorx.github.io/hugo-PaperModX/docs/installation/).
28+
29+
The ToC box is responsive, it only shows on the side when minimum screen size is 1440px.
30+
31+
This feature is enabled on this site.
32+
33+
34+
## InstantClick integration
35+
36+
By adding config:
37+
38+
```yaml
39+
params:
40+
EnableInstantClick: true
41+
```
42+
43+
[InstantClick](http://instantclick.io/) will be enabled,
44+
making navigation behaves like Single Page Application.
45+
46+
Note that `/search` pages are omitted from InstantClick
47+
to prevent conflicts from search's JavaScript,
48+
this may be changed in the future after refactoring those scripts.
49+
50+
Another thing to notice is smooth scrolling will be disabled
51+
if InstantClick is enabled, because they both listen click
52+
event on every `<a>` tags. IMO smooth scrolling is not very useful
53+
so it has to give way to InstantCllick.
54+
55+
This feature is enabled on this site.
56+
57+
58+
## Give links an accent color.
59+
60+
Though PaperModX is designed to be minimal, accent color is still essential.
61+
It's a good way to show personality and make your site feels more delightful.
62+
63+
The default color is a purple vibe,
64+
you can customize the colors of link, link underline and their hover variants
65+
by override the following css variables in `assets/css/extended/custom.css` of your site.
66+
67+
```css
68+
:root {
69+
--link-color: var(--primary);
70+
--link-hover-color: #573eaa;
71+
--link-underline-shadow: 0 1px 0 var(--link-color);
72+
--link-hover-underline-color: #573eaa;
73+
--link-hover-underline-shadow: 0 2px 0 var(--link-hover-underline-color);
74+
}
75+
```
76+
77+
78+
## Customize pagniator size
79+
80+
In section pages, if you want the paginator size be different from the
81+
[global config](https://gohugo.io/templates/pagination/#configure-pagination),
82+
you can add `paginate` in the frontmatter to customize.
83+
84+
```yaml
85+
---
86+
paginate: 10
87+
---
88+
```
89+
90+
91+
## Menus external link
92+
93+
You can add `external: true` to a menu item's params to mark it as an external link,
94+
this will add a small icon to the end, and make the link open in new tab when clicked.
95+
96+
```yaml
97+
menu:
98+
main:
99+
- name: "@Author"
100+
url: "https://reorx.com"
101+
params:
102+
external: true
103+
```
104+
105+
106+
## Highlight code with Chroma, no bullshit
107+
108+
PaperMod uses highlight.js to highlight code blocks.
109+
In PaperModX, we use Chroma which is the recommended way in Hugo's
110+
[official docs](https://gohugo.io/content-management/syntax-highlighting/#:~:text=Hugo%20uses%20Chroma%20as%20its%20code%20highlighter%3B%20it%20is%20built%20in%20Go%20and%20is%20really%2C%20really%20fast),
111+
thus changing theme is easily supported.
112+
113+
By default the themes are `github` for light and `dracula` for dark,
114+
you can change it by adding `chroma-light.css` and `chroma-dark.css`
115+
in site's `assets/css/lib` directory.
116+
117+
118+
## Social icons from Simple Icons
119+
120+
Add social icons with `-simple` suffix from [Simple Icons](https://simpleicons.org/).
121+
122+
Available icons:
123+
- github-simple
124+
- rss-simple
125+
- telegram-simple
126+
- twitter-simple
127+
- pinboard-simple
128+
129+
The icons are moved from `layouts/partials/svg.html` to `data/svg.toml`,
130+
makes it easier to maintain, it's now possible to have an index page
131+
to show all the icons, check it out at: [Icons Preview](https://reorx.github.io/hugo-PaperModX/docs/icons_preview/)
132+
133+
134+
## Opinionated UI enhancements
135+
136+
- Distinguish home page width and post page width, post page is wider
137+
(800px) for better readability, you can change it by `--post-width` in `theme-vars.css`.
138+
- Menu links are always bold, this feels more consistent when clicking around. Active links have deeper color.

‎themes/PaperModX/assets/css/common/404.css

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.not-found {
2+
position: absolute;
3+
left: 0;
4+
right: 0;
5+
display: flex;
6+
align-items: center;
7+
justify-content: center;
8+
height: 80%;
9+
font-size: 160px;
10+
font-weight: 700;
11+
}

‎themes/PaperModX/assets/css/common/archive.css

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.archive-posts {
2+
width: 100%;
3+
font-size: 16px;
4+
}
5+
6+
.archive-year {
7+
margin-top: 40px;
8+
}
9+
10+
.archive-year:not(:last-of-type) {
11+
border-bottom: 2px solid var(--border);
12+
}
13+
14+
.archive-month {
15+
display: flex;
16+
align-items: flex-start;
17+
padding: 10px 0;
18+
}
19+
20+
.archive-month-header {
21+
margin: 22px 0;
22+
width: 200px;
23+
}
24+
25+
.archive-month:not(:last-of-type) {
26+
border-bottom: 1px solid var(--border);
27+
}
28+
29+
.archive-entry {
30+
position: relative;
31+
padding: 5px;
32+
margin: 10px 0;
33+
}
34+
35+
.archive-entry-title {
36+
margin: 5px 0;
37+
font-weight: 400;
38+
}
39+
40+
.archive-count,
41+
.archive-meta {
42+
color: var(--secondary);
43+
font-size: 14px;
44+
}

0 commit comments

Comments
 (0)