marcel
/
congo
mirror of https://github.com/jpanther/congo.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
912 Commits
3 Branches
52 Tags
58 MiB
HTML 91.3%
CSS 6.9%
JavaScript 1.7%
Shell 0.1%
 
 
 
 
Go to file
dependabot[bot] 2755727f0f
📌 Bump rimraf from 4.1.3 to 4.1.4 
Bumps [rimraf](https://github.com/isaacs/rimraf) from 4.1.3 to 4.1.4.
- [Release notes](https://github.com/isaacs/rimraf/releases)
- [Changelog](https://github.com/isaacs/rimraf/blob/main/CHANGELOG.md)
- [Commits](https://github.com/isaacs/rimraf/compare/v4.1.3...v4.1.4)

---
updated-dependencies:
- dependency-name: rimraf
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2023-03-02 23:23:34 +00:00
.github 👷 Bump actions/stale from 6 to 7 2022-12-24 22:03:11 +00:00
archetypes 🚸 Add archetype for external articles 2022-01-25 13:12:14 +11:00
assets 🔨 Preparing release v2.5.2 2023-01-24 08:50:19 +11:00
config/_default ✨ Allow appearance switcher to be placed in menus 2023-01-17 12:58:04 +11:00
data 🎨 Sort JSON elements alphabetically 2023-01-13 12:20:30 +11:00
exampleSite correct typo and add site 2023-02-12 14:37:19 +01:00
i18n 🗄 chore: update `zh-TW` translation 2023-01-18 18:26:45 +08:00
images 📝 Complete documentation overhaul 2021-08-16 17:19:10 +10:00
layouts 🐛 Remove whitespace at EOF in render-link 2023-01-24 08:37:50 +11:00
static ⚡️ Improve Lighthouse scores 2022-01-12 12:20:04 +11:00
.gitignore 🙈 Clean up gitignore 2022-01-19 12:45:19 +11:00
.prettierrc 🔧 Add go bracket spacing to Prettier config 2022-01-19 11:53:17 +11:00
CHANGELOG.md 🔨 Preparing release v2.5.2 2023-01-24 08:50:19 +11:00
CONTRIBUTING.md 📝 Clean up readme and installation instructions 2021-10-21 11:13:11 +11:00
LICENSE 🎉 Initial commit 2021-08-11 15:28:33 +10:00
README.md 🍱 Upgrade to FontAwesome 6 icons 2022-03-09 16:13:36 +11:00
go.mod 🐛 Add v2 to go path 2022-02-03 14:53:57 +11:00
lighthouserc.js 👷 Update Lighthouse config 2022-01-20 14:06:28 +11:00
netlify.toml 👷 Update Netlify Hugo version 2023-01-20 10:17:47 +11:00
package-lock.json 📌 Bump rimraf from 4.1.3 to 4.1.4 2023-03-02 23:23:34 +00:00
package.json 📌 Bump rimraf from 4.1.3 to 4.1.4 2023-03-02 23:23:34 +00:00
release.sh 👷 Fix git version tags not being prefixed 2021-10-19 17:59:13 +11:00
tailwind.config.js 🔧 Remove opacity function from Tailwind config 2022-06-22 17:19:54 +10:00
theme.toml 🔧 Update theme metadata 2022-06-17 10:33:53 +10:00

README.md

Congo

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

  • 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 inlcuding 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 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

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/v2"

  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.