Adobe Coral Spectrum hugo theme

Hugo theme using Adobe coral-spectrum Web Components following Spectrum design patterns.

Usage

See exampleSite for a sample docs website.

A live demo is available at: https://opensource.adobe.com/hugo-spectrum/

Maintainers Notice

Test exampleSite using local theme

Run the site using the local theme, i.e. --theme hugo-spectrum which is mapped to local theme folder and not github remote module.

./docs-local.sh

Update coral-spectrum version

This theme is using adobe/coral-spectrum Web Components.

To upgrade coral-spectrum follow these steps:

set -e
#get the package tarball url
wget `npm view @adobe/coral-spectrum dist.tarball`
tar xzvf coral-spectrum-*.tgz
cp package/dist/css/coral.min.css static/css/coral.min.css
cp package/dist/js/coral.min.js* static/js/
cp package/dist/resources/spectrum-* static/resources/
rm -rf coral-spectrum-*.tgz package

# commit to git
git add .
git commit

See also https://github.com/adobe/coral-spectrum/#using-coral-spectrum for full details.

Update mermaid version

This theme has support for Mermaid diagrams. To upgrade mermaid follow these steps:

set -e
#get the package tarball url
wget `npm view mermaid dist.tarball`
tar xzvf mermaid-*.tgz
cp package/dist/mermaid.min.js* static/js/
rm -rf mermaid-*.tgz package

# commit to git
git add .
git commit

Update markdeep version

This theme has support for Markdeep diagrams. To upgrade markdeep follow these steps:

set -e
#get js
wget https://casual-effects.com/markdeep/latest/markdeep.min.js -O static/js/markdeep.min.js

# commit to git
git add .
git commit

Update stork version

This theme has support for Stork search. To upgrade Stork follow these steps:

set -e

# update version and run
./download-stork.sh 

# commit to git
git add .
git commit

Update KaTeX version

This theme has support for MathJax math typesetting. To upgrade MathJax follow these steps:

set -e
#get the package tarball url
wget `npm view mathjax dist.tarball`
tar xzvf mathjax-*.tgz
cp package/es5/tex-svg-full.js static/js/mathjax-tex-svg-full.js
rm -rf mathjax-*.tgz package

# commit to git
git add .
git commit

Update exampleSite demo site

Run publish-to-gh-pages.sh

Acknowledgments

Docsy inspired layout for this theme. Overleaf examples for LaTeX

Theme built with:

• Spectrum CSS open-source implementation of Spectrum, Adobe’s design system.
• Coral Spectrum JavaScript library of Web Components following Spectrum design patterns.
• Markdeep diagrams
• Mermaid a Javascript based diagramming and charting tool
• Fusejs a lightweight fuzzy-search in JavaScript
• Swagger UI UI for visualizing APIs written in OpenAPI Specification
• klakegg/hugo minimal Docker images for Hugo with batteries included
• Stork Impossibly fast web search, made for static sites
• mark.js JavaScript keyword highlighter
• MathJax Beautiful and accessible math in all browsers
• Zalando Tech Radar JS library for generating tech radar visualisation.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.