From 0c007d39867172944d99431057b23e0dbef407d6 Mon Sep 17 00:00:00 2001 From: Generosa Litton Date: Tue, 8 Apr 2025 11:50:25 -0500 Subject: [PATCH 1/2] re-downloaded relearn, updated readme with instructions for re-downloading relearn --- README.md | 24 ++++++++++++++++-------- themes/hugo-theme-relearn | 2 +- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 381a82a..b3f43bf 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,11 @@ This is the source repository for the MyDecisive documentation. The documentatio The quick way to get started: -1. Clone this repository with Git. -2. Install Hugo (extended edition). -3. Test changes locally by building and loading the site with Hugo. -4. Create a PR to get your changes reviewed before they're merged. +1. Clone this repository with Git. +2. Re-download the Relearn theme (see [Update the Theme](#update-the-theme)) +3. Install Hugo (extended edition). +4. Test changes locally by building and loading the site with Hugo. +5. Create a PR to get your changes reviewed before they're merged. Depending on what you intend to do (beyond just documentation and plain CSS), the Hugo documentation has more information on other resources you may need. @@ -19,20 +20,20 @@ These are the most relevant directories and files: - `hugo.toml` - the main config file - `assets/css` - css files to override theme styles; theme files are copied here and updated; never edit the original as it'll be overwritten with a theme update -- `layouts/partial/logo.html` - HTML to override theme layouts, with `logo.html` being the custom logo for the header +- `layouts/partial/logo.html` - HTML to override theme layouts, with `logo.html` being the custom logo for the header - `static/images` - stores site images - `themes` - stores Relearn theme files; imports the theme via git module - `content` - the Markdown and image files forming the site; site structure follows the directory structure (see Hugo docs for more info) ## Work with Style -Custom css files are stored in `assets/css`. When making a change to a value, add a note in the associated comment to indicate that it's a MyDecisive custom value. An example: +Custom css files are stored in `assets/css`. When making a change to a value, add a note in the associated comment to indicate that it's a MyDecisive custom value. An example: ``` assets/css/theme-relearn-dark.css: --PRIMARY-color: rgba(19, 19, 19, 1); /* brand primary color; this is the color used in the element surrounding the search box in the upper left; set to MyDecisive black */ ... assets/css/theme-relearn-dark.css: --SECONDARY-color: rgba(176, 98, 194, 1); /* brand secondary color; used for links; using MyDecisive brand light purple */ -``` +``` These comments in these examples indicate that the color values were changed from the default. @@ -40,7 +41,14 @@ These comments in these examples indicate that the color values were changed fro The Hugo [Relearn theme](https://github.com/McShelby/hugo-theme-relearn) is installed as a git module. See the theme website for more info on versions. -To update it to the latest version, run: +If you cloned this repo, the Relearn theme will need to be re-downloaded. Run: + +``` +git module init +git submodule update --remote --merge +``` + +To update it Relearn to the latest version, run: ``` git submodule update --remote --merge diff --git a/themes/hugo-theme-relearn b/themes/hugo-theme-relearn index bc0011f..d375e4a 160000 --- a/themes/hugo-theme-relearn +++ b/themes/hugo-theme-relearn @@ -1 +1 @@ -Subproject commit bc0011fc05abbd9f079145b753dab4fa6b823077 +Subproject commit d375e4a5a4e060b8b487b6bafea57e4a66173b66 From 7fdac5ceb8706d1fa2f44b7f449a72fcb069bc46 Mon Sep 17 00:00:00 2001 From: Generosa Litton Date: Wed, 9 Apr 2025 19:15:42 -0500 Subject: [PATCH 2/2] updated readme to include instructions for re-downloading the relearn theme submodule --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b3f43bf..f5acde7 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This is the source repository for the MyDecisive documentation. The documentatio The quick way to get started: 1. Clone this repository with Git. -2. Re-download the Relearn theme (see [Update the Theme](#update-the-theme)) +2. Re-download the Relearn theme (see instructions in [Update the Theme](#update-the-theme)) 3. Install Hugo (extended edition). 4. Test changes locally by building and loading the site with Hugo. 5. Create a PR to get your changes reviewed before they're merged.