2021-08-11 10:22:25 +00:00
# Congo
2021-08-11 05:28:33 +00:00
2021-08-19 01:49:20 +00:00
Congo is designed to be a simple, lightweight theme for [Hugo ](https://gohugo.io ). It's built using Tailwind CSS with a clean and minimalist design that prioritises to your content.
2021-08-11 05:28:33 +00:00
2021-08-18 23:36:00 +00:00
🌏 [Demo site ](https://jpanther.github.io/congo/ )
2021-08-19 01:49:20 +00:00
📑 [Theme documentation ](https://jpanther.github.io/congo/docs/ )
🐛 [Bug reports & issues ](https://github.com/jpanther/congo/issues )
💡 [Questions & feature requests ](https://github.com/jpanther/congo/discussions )
2021-08-14 00:50:40 +00:00
2021-08-18 23:36:00 +00:00
2021-08-12 07:33:04 +00:00
2021-08-11 05:28:33 +00:00
## Features
2021-08-14 00:50:40 +00:00
- Built with Tailwind CSS JIT for minified stylesheets without any excess code
2021-08-14 03:33:45 +00:00
- Fully responsive layout
2021-08-20 07:02:08 +00:00
- Multiple colour schemes (or fully customise your own)
2021-10-29 01:10:38 +00:00
- Dark mode (forced on/off or auto-switching with user toggle)
2021-08-14 00:50:40 +00:00
- Highly customisable configuration
2021-08-15 08:41:40 +00:00
- Multiple homepage layouts
2021-08-12 07:33:04 +00:00
- Flexible with any content types, taxonomies and menus
2021-08-16 07:19:10 +00:00
- Ability to link to posts on third-party websites
2021-10-21 00:13:11 +00:00
- Diagrams and visualisations using Mermaid
2021-10-28 04:32:27 +00:00
- Charts using Chart.js
2021-11-03 23:58:26 +00:00
- Mathematical notation using KaTeX
2021-08-14 00:50:40 +00:00
- SVG icons from FontAwesome 5
2021-08-16 07:19:10 +00:00
- Heading anchors, Buttons, Badges and more
2021-10-21 00:13:11 +00:00
- HTML and Emoji support in articles 🎉
2021-08-16 07:19:10 +00:00
- SEO friendly with links for sharing to social media
2021-08-14 03:54:17 +00:00
- RSS feeds
2021-08-14 00:50:40 +00:00
- Fathom Analytics and Google Analytics support
- Favicons support
- Comments support
- Advanced customisation using simple Tailwind colour definitions and styles
2021-10-21 00:13:11 +00:00
- Fully documented
- Regular updates with fixes and new features
---
## Documentation
Congo has [extensive documentation ](https://jpanther.github.io/congo/docs/ ) that covers all aspects of the theme. Be sure to [read the docs ](https://jpanther.github.io/congo/docs/ ) to learn more about how to use the theme and its features.
2021-08-14 00:50:40 +00:00
---
2021-08-11 05:28:33 +00:00
## Installation
2021-10-21 00:13:11 +00:00
Congo supports several installation methods - as a Hugo Module (easiest), a git submodule, or as a completely manual install.
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
Detailed instructions for each method can be found in the [Installation ](https://jpanther.github.io/congo/docs/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.
2021-08-19 04:40:57 +00:00
2021-10-21 00:13:11 +00:00
### Quick start using Hugo
2021-08-19 04:40:57 +00:00
2021-10-21 00:13:11 +00:00
> **Note:** Ensure you have **Go** and **Hugo** installed, and that you have created a new Hugo project before proceeding.
2021-08-19 04:40:57 +00:00
2021-10-21 00:13:11 +00:00
1. From your project directory, initialise Hugo Modules:
2021-08-19 04:40:57 +00:00
```shell
hugo mod init github.com/< username > /< repo-name >
```
2021-10-21 00:13:11 +00:00
2. Create `config/_default/module.toml` and add the following:
2021-08-19 04:40:57 +00:00
```toml
[[imports]]
path = "github.com/jpanther/congo"
```
2021-10-21 00:13:11 +00:00
3. Start your server using `hugo server` and the theme will be downloaded automatically.
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
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.
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
> **Note:** Do not overwrite the `module.toml` file you created above!
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
You will find these theme config files in the Hugo cache directory, or [download a copy ](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/jpanther/congo/tree/stable/config/_default ) from GitHub.
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
5. Follow the [Getting Started ](https://jpanther.github.io/congo/docs/getting-started/ ) instructions to configure your website.
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
### Installing theme updates
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
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.
2021-08-14 00:50:40 +00:00
2021-10-21 00:15:55 +00:00
Detailed [update instructions ](https://jpanther.github.io/congo/docs/installation/#installing-updates ) are available in the docs.
2021-08-14 00:50:40 +00:00
2021-08-16 07:19:10 +00:00
---
2021-08-11 05:28:33 +00:00
## Contributing
2021-10-21 00:13:11 +00:00
Congo is expected to evolve over time. I intend to keep adding features and making changes as required.
2021-08-11 05:28:33 +00:00
2021-08-19 01:49:20 +00:00
Feel free to get in touch with any issues or suggestions for new features you'd like to see.
2021-08-11 05:28:33 +00:00
2021-08-19 01:49:20 +00:00
- 🐛 **Bug reports & issues:** Use [GitHub Issues ](https://github.com/jpanther/congo/issues )
- 💡 **Ideas for new features:** Open a discussion on [GitHub Discussions ](https://github.com/jpanther/congo/discussions )
- 🙋♀️ **General questions:** Head to [GitHub Discussions ](https://github.com/jpanther/congo/discussions )
2021-08-11 05:28:33 +00:00
2021-10-21 00:13:11 +00:00
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 ](https://github.com/jpanther/congo/blob/dev/CONTRIBUTING.md ).
