The Vanilla framework theme for documentation, style guides and APIs
Shell CSS HTML JavaScript Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
_jekyll
docs
examples/patterns
gulp
js
scss
.env
.gitignore
.install_dependencies.sh
.npmignore
.sass-lint.yml
.spelling
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE
README.md
_config.yml
gulpfile.js
index.html
package.json
run
yarn.lock

README.md

This codebase is no longer supported by the Canonical web team

All themes are being migrated to Vanilla framework itself. Therefore, any amendments or additions to this theme should be submitted to Vanilla framework. https://github.com/vanilla-framework/vanilla-framework


Vanilla Docs Theme

A Sass theme for documentation websites, based on vanilla-framework.

Local development

First, install Docker. Then run one of:

./run build  # Build the CSS
./run watch  # Auto-build the CSS when Sass files change
./run test   # Check the Sass files for syntax & style errors
./run clean  # Clean up generated files

Using a local version of vanilla-framework

You can use the ./run script to use NPM modules from a local folder on a one-time basis, instead of the modules declared in package.json.

This mechanism will allow you to, for example, use a local version of vanilla-framework:

./run --node-module $HOME/project/vanilla-framework watch  # Build CSS dynamically, using a local version of vanilla-framework