Skip to content

Updated README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

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.

Expand All @@ -19,28 +20,35 @@ 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.

## Update the Theme

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
Expand Down
2 changes: 1 addition & 1 deletion themes/hugo-theme-relearn