Repository files navigation

Congo is designed to be a powerful, lightweight theme forHugo. 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

• Fully responsive layout built with Tailwind CSS 3.0
• 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
• Multilingual content support including support for RTL languages
• Ability to link to posts on third-party websites
• Client-side site search powered by Fuse.js
• Diagrams and visualisations using Mermaid
• Charts using Chart.js
• Mathematical notation using KaTeX
• SVG icons from FontAwesome 6
• Automatic image resizing using Hugo Pipes
• Heading anchors, Tables of Contents, Code copy, Buttons, Badges and more
• HTML and Emoji support in articles 🎉
• SEO friendly with links for sharing to social media
• Fathom Analytics, Plausible Analytics, Umami Analytics and Google Analytics support
• RSS feeds, Favicons and comments support
• Advanced customisation using simple Tailwind colour definitions and styles
• Optimised for performance and accessibility with perfect Lighthouse scores
• Fully documented with regular updates

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

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 theInstallation 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.

Note: Ensure you haveGo andHugo 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. Createconfig/_default/module.toml and add the following:

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

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

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

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

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

5. Follow theGetting Started instructions to configure your website.

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

Detailedupdate instructions are available in the docs.

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.

• 🐛Bug reports & issues: UseGitHub Issues
• 💡Ideas for new features: Open a discussion onGitHub Discussions
• 🙋‍♀️General questions: Head toGitHub Discussions

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