From da84a0302b8dcb2a5146ab1f9f1477ee4a6e03aa Mon Sep 17 00:00:00 2001 From: Reorx Date: Mon, 11 Apr 2022 16:11:55 +0800 Subject: [PATCH] update readme --- README.md | 97 ++++++------------------------------------------------- 1 file changed, 9 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index ce755c7..d247e6a 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,11 @@ -

Hugo PaperMod | Demo

+# PaperModX -

☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive

-
+PaperModX is a forked version of [PaperMod](https://github.com/adityatelange/hugo-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. -> Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper). -> The goal of this project is to add more features and customization to the og theme. - -The [demo](https://adityatelange.github.io/hugo-PaperMod/) includes a lot of documentation about Installation, Features with a few more stuff. Make sure you visit it, to get an awesome hands-on experience and get to know about the features ... - -**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. - -[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.83.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.83.0) -[![Build GH-Pages](https://github.com/adityatelange/hugo-PaperMod/workflows/Build%20GH-Pages/badge.svg)](https://github.com/adityatelange/hugo-PaperMod/deployments/activity_log?environment=github-pages) -[![GitHub](https://img.shields.io/github/license/adityatelange/hugo-PaperMod)](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE) -[![hugo-papermod](https://img.shields.io/badge/Hugo--Themes-@PaperMod-blue)](https://themes.gohugo.io/themes/hugo-papermod/) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adityatelange_hugo-PaperMod&metric=alert_status)](https://sonarcloud.io/dashboard?id=adityatelange_hugo-PaperMod) -![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod) - ---- - -

- Mockup image -

- ---- - -## Features/Mods 💥 - -- 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 -- No webpack, nodejs and other dependencies are required to edit the theme. - -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)** - ---- - -## Social-Icons/Share-Icons 🖼️ - -Read Wiki For More Details => **[PaperMod-Icons](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)** - ---- - -## FAQs / How To's Guide 🙋 - -Read Wiki For More Details => **[PaperMod-FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)** - ---- - -## 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/) - ---- - -## 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** +Features and changes: +- Table of Contents (ToC) floating on the side +- InstantClick integration +- Social icons from [Simple Icons](https://simpleicons.org/) +- Opinionated UI enhancements