Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 4.31 KB

README.md

File metadata and controls

96 lines (64 loc) · 4.31 KB
Raw

Congo

Congo is designed to be a simple, lightweight theme for Hugo. It's built using Tailwind CSS with a clean and minimalist design that prioritises to your content.

🌏 Demo site
📑 Theme documentation
🐛 Bug reports & issues
💡 Questions & feature requests

Screenshot

Features

  • Built with Tailwind CSS JIT for minified stylesheets without any excess code
  • Fully responsive layout
  • Multiple colour schemes (or fully customise your own)
  • Dark mode (forced on/off or auto-switching with user toggle)
  • Highly customisable configuration
  • Multiple homepage layouts
  • Flexible with any content types, taxonomies and menus
  • Ability to link to posts on third-party websites
  • Diagrams and visualisations using Mermaid
  • Charts using Chart.js
  • Mathematical notation using KaTeX
  • SVG icons from FontAwesome 5
  • Heading anchors, Buttons, Badges and more
  • HTML and Emoji support in articles 🎉
  • SEO friendly with links for sharing to social media
  • RSS feeds
  • Fathom Analytics and Google Analytics support
  • Favicons support
  • Comments support
  • Advanced customisation using simple Tailwind colour definitions and styles
  • Fully documented
  • Regular updates with fixes and new features

Documentation

Congo has extensive documentation that covers all aspects of the theme. Be sure to read the docs to learn more about how to use the theme and its features.

Installation

Congo supports several installation methods - as a Hugo Module (easiest), a git submodule, or as a completely manual install.

Detailed instructions for each method can be found in the Installation docs. You should consult the documentation for the simplest setup experience. Below is a quick start guide using Hugo modules if you're already confident installing Hugo themes.

Quick start using Hugo

Note: Ensure you have Go and Hugo installed, and that you have created a new Hugo project before proceeding.

  1. From your project directory, initialise Hugo Modules:

    hugo mod init github.com/<username>/<repo-name>

  2. Create config/_default/module.toml and add the following:

    [[imports]]
path = "github.com/jpanther/congo"

  3. Start your server using hugo server and the theme will be downloaded automatically.

  4. In the root folder of your website, delete the config.toml file that was generated by Hugo. Copy the *.toml config files from the theme into your config/_default/ folder.

    Note: Do not overwrite the module.toml file you created above!

    You will find these theme config files in the Hugo cache directory, or download a copy from GitHub.

  5. Follow the Getting Started instructions to configure your website.

Installing theme updates

As new releases are posted, you can update the theme using Hugo. Simply run hugo mod get -u from your project directory and the theme will automatically update to the latest release.

Detailed update instructions are available in the docs.

Contributing

Congo is expected to evolve over time. I intend to keep adding features and making changes as required.

Feel free to get in touch with any issues or suggestions for new features you'd like to see.

If you're able to fix a bug or implement a new feature, I welcome PRs for this purpose. Learn more in the contributing guidelines.