README.md

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://git.corp.adobe.com/pages/reef/hugo-spectrum

Maintainers Notice

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://opensource.adobe.com/coral-spectrum/dist/documentation/manual/manual.html#consuming for full details.

Update spectrum-css-grid version

This theme is using Spectrum CSS Grid. To upgrade spectrum-css-grid follow these steps:

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

# commit to git
git add .
git commit

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 exampleSite demo site

When updating hugo theme in this repository make sure you:

1. Update the exampleSite theme version:

   cd exampleSite
   git submodule update --remote --merge
   git commit themes/hugo-spectrum -m "Updated theme in exampleSite"
   git push

2. Generate and publish exampleSite in gh-pages branch

   Run publish-to-gh-pages.sh

Acknowledgments

Docsy inspired layout for this theme.

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

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.