SassDoc's site.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data
_includes
_layouts
_sass
about
annotations
assets
brand-guidelines
broccoli
changelog
configuration
contributing
customising-the-view
data-interface
extending-sassdoc
extra-tools
file-level-annotations
frequently-asked-questions
gallery
getting-started
grunt
gulp
node
sassdocify
theme-gallery
theme-generator
upgrading
using-your-own-theme
utils
webpack
.gitignore
CNAME
CONTRIBUTING.md
Makefile
README.md
_config.yml
favicon.png
github-btn.html
index.md
make.js
package.json

README.md

SassDoc

Uncompiled source code from the Jekyll powered official SassDoc site.

Preview jekyll serve

Local preview on port 4000 (http://0.0.0.0:4000 or http://localhost:4000 depending on setups).

Building

make

Make everything (all the below).

make changelog

Update changelog/index.md from https://raw.githubusercontent.com/SassDoc/sassdoc/master.

make preview

Make an up to date preview of the default theme in assets/image/preview-image.png.

make themes

Do everything needed for the theme gallery to work:

  1. In theme-gallery, fetch all the themes defined in themes.mk, render them in preview and generate thumbnails in thumbs.
  2. Generate _data/themes.yml from the package.json of each theme previously downloaded.

To update the themes, run make update && make themes (this shouldn't do anything if no theme was updated).