hibby
/
PaperModX
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of hugo-PapermodX for my own purposes
926 Commits 1 Branch 0 Tags 5.5 MiB
HTML 53%
CSS 24.6%
JavaScript 17.1%
SCSS 5.1%
Makefile 0.2%
Go to file
Reorx d94f895296 allow customizing pagination by adding "paginate" in frontmatter 2022-04-14 15:06:24 +08:00
.github add exampleSite 2022-04-14 11:38:07 +08:00
assets Match right side padding when ToC is used on left 2022-04-13 13:12:58 -04:00
data Add podcast, Bitcoin, and Monero icons 2022-04-13 12:51:57 -04:00
exampleSite add exampleSite 2022-04-14 11:38:07 +08:00
i18n Update translation zh.yaml (#868) 2022-04-09 13:23:18 +05:30
images images: update 2020-09-25 13:35:31 +05:30
layouts allow customizing pagination by adding "paginate" in frontmatter 2022-04-14 15:06:24 +08:00
LICENSE update LICENSE for 2021 2021-01-08 23:37:28 +05:30
Makefile add exampleSite 2022-04-14 11:38:07 +08:00
README.md update readme for TocSide 2022-04-13 18:14:22 +08:00
go.mod chore: add go.mod (#51) 2020-10-21 10:36:44 +05:30
theme.toml Bump minimum Hugo version to `0.83.0` 2021-10-22 20:01:02 +05:30

README.md

PaperModX

PaperModX is a forked version of PaperMod, it aims at adding new features and improving code quality, makes it easier to read and modify by anyone with basic knowledge of Hugo and HTML.

Features and changes:

  • Table of Contents (ToC) floating on the side
  • InstantClick integration
  • Social icons from Simple Icons
  • Opinionated UI enhancements

Table of Contents (ToC) floating on the side

By adding config:

params:
  TocSide: 'left'  # or 'right'

ToC will float on the left/right side of the page. The ToC box is responsive, it only shows on the side when minimum screen size is 1440px.

this feature is enabled on this site.

InstantClick integration

By adding config:

params:
  EnableInstantClick: true

InstantClick will be enabled, making navigation behaves like Single Page Application.

Note that /search pages are omitted from InstantClick to prevent conflicts from search's JavaScript, this may be changed in the future after refactoring those scripts.

Another thing to notice is smooth scrolling will be disabled if InstantClick is enabled, because they both listen click event on every <a> tags. IMO smooth scrolling is not very useful so it has to give way to InstantCllick.

This feature is enabled on this site.

Social icons from Simple Icons

Add social icons with -simple suffix from Simple Icons.

Available icons:

  • github-simple
  • rss-simple
  • telegram-simple
  • twitter-simple
  • pinboard-simple

Opinionated UI enhancements

  • Distinguish home page width and post page width, post page is wider (800px) for better readability, you can change it by --post-width in theme-vars.css.
  • Menu links are always bold, this feels more consistent when clicking around. Active links have deeper color.