diff options
| author | Serghei Iakovlev <egrep@protonmail.ch> | 2024-09-26 21:37:16 +0200 |
|---|---|---|
| committer | Serghei Iakovlev <git@serghei.pl> | 2024-09-26 21:40:28 +0200 |
| commit | d342dcd1a5ac29364320fa27ffac56b590f64d3e (patch) | |
| tree | e04692bf8940133799ecdf422ef219487e241d91 /exampleSite/content/documentation/index.md | |
| parent | f00eb2b552317597462a09e024217533af8c3115 (diff) | |
| download | gohugo-theme-ed-d342dcd1a5ac29364320fa27ffac56b590f64d3e.tar.gz | |
Add docs regarding styling theme
Diffstat (limited to 'exampleSite/content/documentation/index.md')
| -rw-r--r-- | exampleSite/content/documentation/index.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/exampleSite/content/documentation/index.md b/exampleSite/content/documentation/index.md index 06d012f..90f849c 100644 --- a/exampleSite/content/documentation/index.md +++ b/exampleSite/content/documentation/index.md @@ -328,6 +328,39 @@ The internal links pointing to the right sections in your document are generated --- +## Styling Theme + +To change the main color accents of the theme, such as the headers, links, and text logo, you can use the `colorScheme` configuration parameter, as shown below: + +~~~ yaml +params: + colorScheme: magenta +~~~ + +The demo site uses a feature that splits configuration into separate files, so if your project follows the same structure, the `colorScheme` parameter should be located in the `params.yaml` file, simply at the root, like this: + +~~~ yaml +colorScheme: blue +~~~ + +The currently supported colors are: red, orange, magenta, cyan, blue, and brown. + +If no value is provided, or if you remove the `colorScheme` parameter altogether, the theme defaults to red. + +At the moment, the theme does not support arbitrary changes to fonts, custom colors, or other visual elements beyond those predefined by the theme. However, the theme provides a way for you to add your own custom styles to your project. + +To do this, create a `layouts/partials` directory in your project, and inside it, add a file named `custom-head.html`. You can now define any custom styles within this file. For example: + +~~~ html +<style> + html { + font-family: "PT Sans", Helvetica, Arial, sans-serif; + } +</style> +~~~ + +This allows you to override or extend the theme’s default styles with your own customizations. + ## Comments Ed theme now supports adding a comments system to your site, enhancing interactive engagement. Currently, the theme supports integration with {{< link src="https://giscus.app/" class="external" target="_blank" hreflang="en" rel="noopener noreferrer" >}}giscus{{< /link >}}. |
