mirror of https://github.com/jpanther/congo.git
96 lines
4.3 KiB
Markdown
96 lines
4.3 KiB
Markdown
# Congo
|
|
|
|
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.
|
|
|
|
🌏 [Demo site](https://jpanther.github.io/congo/)
|
|
📑 [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)
|
|
|
|
|
|
|
|
## 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 (auto-switching based upon browser)
|
|
- 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
|
|
- 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](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.
|
|
|
|
---
|
|
|
|
## 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](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.
|
|
|
|
### 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:
|
|
|
|
```shell
|
|
hugo mod init github.com/<username>/<repo-name>
|
|
```
|
|
|
|
2. Create `config/_default/module.toml` and add the following:
|
|
|
|
```toml
|
|
[[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](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/jpanther/congo/tree/stable/config/_default) from GitHub.
|
|
|
|
5. Follow the [Getting Started](https://jpanther.github.io/congo/docs/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](https://jpanther.github.io/congo/docs/installation/#installing-updates) 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.
|
|
|
|
- 🐛 **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)
|
|
|
|
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).
|