Hugo PaperFlow is a fork of PaperMod that's based on hugo-paper.
The goal of this project is to add more features and customization.

• Uses Hugo's asset generator with pipelining, fingerprinting, bundling and minification by default.
• 3 Modes:
  • Regular Mode.
  • Home-Info Mode.
  • 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.

1. Create a new Hugo site (using YAML configuration format):

   hugo new site MyBlog --format yml
   cd MyBlog
   

2. Start a new project with Git:

   git init
   

3. Edit hugo.yml file and add theme: hugo-PaperFlow to use the theme. Note: It's recommended to use the config.yml file from the example site as a starting point for your configuration.

4. Add your first content:

   hugo new posts/my-first-post.md
   

5. Install the theme (choose one):

   5.1. Clone the repo: git clone https://github.com/0Ky/hugo-PaperFlow.git themes/hugo-PaperFlow

   5.2. Git submodule:

   git submodule add https://github.com/0Ky/hugo-PaperFlow.git themes/hugo-PaperFlow
   git submodule update --init --recursive
   

6. Start the local development server:

   hugo server -D
   

Contributions are welcome and encouraged! This Hugo theme is a community-driven project and all kinds of improvements are appreciated, whether you're working on new features, bug fixes, styling updates, accessibility improvements, optimization, documentation or contents in the exampleSite.

You can contribute by:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes or additions in the codebase.
4. Test thoroughly using the exampleSite by running hugo server --source exampleSite.
5. Submit a pull request with a clear description of what you've changed and why.

Release ChangeLog has info about stuff added: Releases

• Star 🌟 this repository.
• Help spread the word about PaperFlow by sharing it on social media and recommending it to your friends. 🗣️
• You can also sponsor 🏅 on Github Sponsors.

• Nán Xiǎo Běi
• Aditya Telange
• Highlight.js
• Fuse.js
• Feather Icons
• Simple Icons
• All Contributors and Supporters