From a9a3b3b421bb6ef8cfe9f1e881d98a8b548fb06f Mon Sep 17 00:00:00 2001 From: Reorx Date: Thu, 14 Apr 2022 16:02:19 +0800 Subject: [PATCH] update readme for recent new features --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/README.md b/README.md index 760d717..9d94653 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,54 @@ so it has to give way to InstantCllick. This feature is enabled on this site. +## Give links an accent color. + +Though PaperModX is designed to be minimal, accent color is still essential. +It's a good way to show personality and make your site feels more delightful. + +The default color is a purple vibe, +you can customize the colors of link, link underline and the hover variants of them +by override the following css variables in `assets/css/extended/custom.css` of your site. + +```css +:root { + --link-color: var(--primary); + --link-hover-color: #573eaa; + --link-underline-shadow: 0 1px 0 var(--link-color); + --link-hover-underline-color: #573eaa; + --link-hover-underline-shadow: 0 2px 0 var(--link-hover-underline-color); +} +``` + + +## Customize pagniator size + +In section pages, if you want the paginator size be different from the +[global config](https://gohugo.io/templates/pagination/#configure-pagination), +you can add `paginate` in the frontmatter to customize. + +```yaml +--- +paginate: 10 +--- +``` + + +## Menus external link + +You can add `external: true` to a menu item's params to mark it as an external link, +this will add a small icon to the end, and make the link open in new tab when clicked. + +```yaml +menu: + main: + - name: "@Author" + url: "https://reorx.com" + params: + external: true +``` + + ## Social icons from Simple Icons Add social icons with `-simple` suffix from [Simple Icons](https://simpleicons.org/). @@ -60,6 +108,7 @@ Available icons: - twitter-simple - pinboard-simple + ## Opinionated UI enhancements - Distinguish home page width and post page width, post page is wider