Overview:
Hugo-Primer is a simple and beautiful Hugo theme based on GitHub’s Primer CSS. It is designed to create GitHub style pages with added blog-like features. It is a perfect fit for those who are familiar with GitHub’s style and want to incorporate it into their own websites.
Features:
- Primer CSS like theme: Gives your website a similar style to GitHub’s Primer CSS.
- Menu bar header: Provides a menu bar header for easy navigation.
- Colored code pen: Allows you to display code snippets with colored syntax highlighting.
- Math inline: Supports inline math equations.
- Awesome TOC: Includes a table of contents for easy navigation within longer articles.
- Tags & Categories: Allows you to organize your content using tags and categories.
- Social Share buttons: Provides social media sharing buttons for easy sharing of your content.
Installation:
To install the Hugo-Primer theme, follow these steps:
- Clone the theme to your theme directory using the command:
git clone [theme repository URL] [theme directory]. - Copy the exampleSite folder from the cloned theme to the root of your Hugo project.
- Customize the configuration in the config.toml file according to your preferences.
- Remove your site’s archetypes/default.md file or replace it with Hugo-Primer’s archetypes/default.md file.
- Customize the page-level parameters in the front matter of your content files as needed.
Summary:
Hugo-Primer is a Hugo theme that brings the style of GitHub’s Primer CSS to your website. It offers a range of features including a menu bar header, colored code snippets, math equation support, a table of contents, and more. With its easy installation process and customizable configuration, Hugo-Primer is a great choice for those who want to create GitHub-style pages with additional blog-like features.
