marcel
/
congo
mirror of https://github.com/jpanther/congo.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

🩹 Standardise project URLs to be lowercase

pull/2/head
James Panther 2021-08-19 09:36:00 +10:00
parent 3450e8f9c5
commit f023dbe71f
No known key found for this signature in database
GPG Key ID: D36F789E45745D17
11 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/gh-pages.yml vendored
View File

@ -24,7 +24,7 @@ jobs:
- name: Build - name: Build
working-directory: ./exampleSite working-directory: ./exampleSite
run: hugo --minify --themesDir ../.. --baseURL https://jpanther.github.io/Congo/ run: hugo --minify --themesDir ../.. --baseURL https://jpanther.github.io/congo/
- name: Deploy - name: Deploy
uses: peaceiris/actions-gh-pages@v3 uses: peaceiris/actions-gh-pages@v3

12
CHANGELOG.md
View File

@ -8,6 +8,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
--- ---
## [Unreleased]
### Changed
- Standardised all project URLs to be lowercase
## [1.1.0] - 2020-08-18 ## [1.1.0] - 2020-08-18
### Added ### Added
@ -53,6 +59,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Advanced customisation using simple Tailwind colour definitions and styles - Advanced customisation using simple Tailwind colour definitions and styles
- Fully documented - Fully documented
[unreleased]: https://github.com/jpanther/Congo/compare/v1.1.0...HEAD [unreleased]: https://github.com/jpanther/congo/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/jpanther/Congo/compare/v1.0.0...v1.1.0 [1.1.0]: https://github.com/jpanther/congo/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/jpanther/Congo/releases/tag/v1.0.0 [1.0.0]: https://github.com/jpanther/congo/releases/tag/v1.0.0

16
README.md
View File

@ -2,10 +2,10 @@
Congo is designed to be a fast, lightweight theme for Hugo. It's based upon Tailwind CSS with a clean and minimalist design. Congo is designed to be a fast, lightweight theme for Hugo. It's based upon Tailwind CSS with a clean and minimalist design.
🌏 [Demo site](https://jpanther.github.io/Congo/) 🌏 [Demo site](https://jpanther.github.io/congo/)
📑 [Theme documentation](https://jpanther.github.io/Congo/docs/) 📑 [Theme documentation](https://jpanther.github.io/congo/docs/)
![Screenshot](https://raw.githubusercontent.com/jpanther/Congo/stable/images/screenshot.png) ![Screenshot](https://raw.githubusercontent.com/jpanther/congo/stable/images/screenshot.png)
## Features ## Features
@ -26,13 +26,13 @@ Congo is designed to be a fast, lightweight theme for Hugo. It's based upon Tail
- Favicons support - Favicons support
- Comments support - Comments support
- Advanced customisation using simple Tailwind colour definitions and styles - Advanced customisation using simple Tailwind colour definitions and styles
- [Fully documented](https://jpanther.github.io/Congo/docs/) - [Fully documented](https://jpanther.github.io/congo/docs/)
--- ---
## Installation ## Installation
This is a simplified set of instructions and assumes a basic understanding of building Hugo sites and installing themes. For detailed instructions, refer to the full [theme documentation](https://jpanther.github.io/Congo/docs/). This is a simplified set of instructions and assumes a basic understanding of building Hugo sites and installing themes. For detailed instructions, refer to the full [theme documentation](https://jpanther.github.io/congo/docs/).
There are a couple of ways to install the Congo theme into your Hugo website. The git method is the easiest to keep the theme up-to-date, but you can also download and install manually if you don't have git available. There are a couple of ways to install the Congo theme into your Hugo website. The git method is the easiest to keep the theme up-to-date, but you can also download and install manually if you don't have git available.
@ -43,12 +43,12 @@ Change into the directory for your Hugo website, initialise a new repository and
```bash ```bash
cd mywebsite cd mywebsite
git init git init
git submodule add -b stable https://github.com/jpanther/Congo.git themes/congo git submodule add -b stable https://github.com/jpanther/congo.git themes/congo
``` ```
### Install manually ### Install manually
Download the latest release of the theme from: [https://github.com/jpanther/Congo/releases](https://github.com/jpanther/Congo/releases) Download the latest release of the theme from: [https://github.com/jpanther/congo/releases](https://github.com/jpanther/congo/releases)
Extract the archive, rename the folder to `congo` and move it to the `themes/` directory inside your Hugo project. Extract the archive, rename the folder to `congo` and move it to the `themes/` directory inside your Hugo project.
@ -60,7 +60,7 @@ You're now all set up to use Congo. From here you can add some content and start
## Configuration ## Configuration
For all the theme options and detailed configuration instructions, refer to the [Congo docs](https://jpanther.github.io/Congo/docs/). For all the theme options and detailed configuration instructions, refer to the [Congo docs](https://jpanther.github.io/congo/docs/).
A few things you need to set for a new installation: A few things you need to set for a new installation:

2
config/_default/config.toml
View File

@ -1,6 +1,6 @@
# -- Site Configuration -- # -- Site Configuration --
# Refer to the theme docs for more details about each of these parameters. # Refer to the theme docs for more details about each of these parameters.
# https://jpanther.github.io/Congo/docs/getting-started/ # https://jpanther.github.io/congo/docs/getting-started/
theme = "congo" theme = "congo"

2
config/_default/params.toml
View File

@ -3,7 +3,7 @@
# customise the display of your website. # customise the display of your website.
# #
# Refer to the theme docs for more details about each of these parameters. # Refer to the theme docs for more details about each of these parameters.
# https://jpanther.github.io/Congo/docs/configuration/#theme-parameters # https://jpanther.github.io/congo/docs/configuration/#theme-parameters
# description = "My awesome website" # description = "My awesome website"
# mainSections = ["section1", "section2"] # mainSections = ["section1", "section2"]

6
exampleSite/config.toml
View File

@ -4,10 +4,10 @@
# as it does not contain all the required theme settings! # as it does not contain all the required theme settings!
# #
# Refer to the theme docs for configuration instructions if you're unsure. # Refer to the theme docs for configuration instructions if you're unsure.
# https://jpanther.github.io/Congo/docs/ # https://jpanther.github.io/congo/docs/
# -------------------------------------------------------------------------- # --------------------------------------------------------------------------
baseURL = "https://jpanther.github.io/Congo/" baseURL = "https://jpanther.github.io/congo/"
theme = "Congo" theme = "Congo"
languageCode = "en-AU" languageCode = "en-AU"
defaultContentLanguage = "en" defaultContentLanguage = "en"
@ -54,7 +54,7 @@ relativeURLs = true
# weight = 30 # weight = 30
[[menu.main]] [[menu.main]]
name = "GitHub" name = "GitHub"
url = "https://github.com/jpanther/Congo" url = "https://github.com/jpanther/congo"
weight = 40 weight = 40
[markup.goldmark] [markup.goldmark]

2
exampleSite/content/_index.md
View File

@ -24,6 +24,6 @@ A simple, lightweight theme for Hugo built with Tailwind CSS.
This is a demo site built entirely using Congo. It also contains a complete set of [theme documentation](/docs/). Congo is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts. This is a demo site built entirely using Congo. It also contains a complete set of [theme documentation](/docs/). Congo is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts.
Explore the [sample pages](/samples/) to get a feel for what Congo can do. If you like what you see, check out the project on [Github](https://github.com/jpanther/Congo) or read the [Installation guide](/docs/installation/) to get started. Explore the [sample pages](/samples/) to get a feel for what Congo can do. If you like what you see, check out the project on [Github](https://github.com/jpanther/congo) or read the [Installation guide](/docs/installation/) to get started.
{{< figure src="mountains.jpg" caption="Photo by [Anna Scarfiello](https://unsplash.com/@little_anne?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText)." >}} {{< figure src="mountains.jpg" caption="Photo by [Anna Scarfiello](https://unsplash.com/@little_anne?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText)." >}}

4
exampleSite/content/docs/installation.md
View File

@ -34,7 +34,7 @@ Change into the directory for your Hugo website, initialise a new repository and
```bash ```bash
cd mywebsite cd mywebsite
git init git init
git submodule add -b stable https://github.com/jpanther/Congo.git themes/congo git submodule add -b stable https://github.com/jpanther/congo.git themes/congo
``` ```
{{< alert >}} {{< alert >}}
@ -45,7 +45,7 @@ git submodule add -b stable https://github.com/jpanther/Congo.git themes/congo
Download the latest release of the theme. Download the latest release of the theme.
{{< button href="https://github.com/jpanther/Congo/releases" target="_blank" >}}Download from Github{{< /button >}} {{< button href="https://github.com/jpanther/congo/releases" target="_blank" >}}Download from Github{{< /button >}}
Extract the archive, rename the folder to `congo` and move it to the `themes/` directory inside your your `mywebsite` folder. Extract the archive, rename the folder to `congo` and move it to the `themes/` directory inside your your `mywebsite` folder.

2
exampleSite/content/users.md
View File

@ -17,4 +17,4 @@ Real websites that are built with Congo.
| Website | Details | | Website | Details |
| ------- | ------- | | ------- | ------- |
**Congo user?** To add your site to this list, [submit a pull request](https://github.com/jpanther/Congo/blob/dev/exampleSite/content/users.md). **Congo user?** To add your site to this list, [submit a pull request](https://github.com/jpanther/congo/blob/dev/exampleSite/content/users.md).

8
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "hugo-congo-theme", "name": "hugo-congo-theme",
"version": "1.0.0", "version": "1.1.1",
"description": "Congo theme for Hugo", "description": "Congo theme for Hugo",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
@ -10,7 +10,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/jpanther/Congo.git" "url": "git+https://github.com/jpanther/congo.git"
}, },
"keywords": [ "keywords": [
"hugo", "hugo",
@ -21,9 +21,9 @@
"author": "James Panther", "author": "James Panther",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/jpanther/Congo/issues" "url": "https://github.com/jpanther/congo/issues"
}, },
"homepage": "https://github.com/jpanther/Congo#readme", "homepage": "https://github.com/jpanther/congo#readme",
"devDependencies": { "devDependencies": {
"@tailwindcss/typography": "^0.4.1", "@tailwindcss/typography": "^0.4.1",
"prettier": "^2.3.2", "prettier": "^2.3.2",

8
theme.toml
View File

@ -1,14 +1,14 @@
# Congo theme for Hugo # Congo theme for Hugo
name = "Congo" name = "congo"
license = "MIT" license = "MIT"
licenselink = "https://github.com/jpanther/Congo/blob/master/LICENSE" licenselink = "https://github.com/jpanther/congo/blob/master/LICENSE"
description = "A simple, lightweight theme for Hugo built with Tailwind CSS." description = "A simple, lightweight theme for Hugo built with Tailwind CSS."
min_version = "0.86.1" min_version = "0.86.1"
homepage = "https://github.com/jpanther/Congo/" homepage = "https://github.com/jpanther/congo/"
demosite = "https://jpanther.github.io/Congo/" demosite = "https://jpanther.github.io/congo/"
tags = ["blog", "minimal", "responsive", "dark mode", "dark", "light", "tailwind", "personal"] tags = ["blog", "minimal", "responsive", "dark mode", "dark", "light", "tailwind", "personal"]
features = ["syntax higlighting", "dark mode", "emoji"] features = ["syntax higlighting", "dark mode", "emoji"]