SassDoc Default Theme

This is SassDoc's default theme which means this is the theme that will be used when running SassDoc without a custom theme.

This theme uses Nunjucks as a template engine.

Because this is likely to be the most used theme of all, it is not as simple as a theme can get. For instance, there is quite a bit of logic in both index.js and the templates. Fortunately, you don't have to deal with that at all.

Customising the view

There are some possibilites to customise the theme's view. Essentially what's being displayed, what's not, and what are the project informations to be displayed in the header and footer.

To learn how to customise the theme's view, please read the documentation on SassDoc's site. Fear not! It's all about creating a configuration file. No big deal.

sassdoc-theme-default change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

unreleased

[2.8.6 - 2024-04-06

Fixed

• Add item.group to the item heading link. [#118].

2.8.5 - 2022-04-19

Fixed

• Support group in @see URL. [#116], [SassDoc/sassdoc#567] and [SassDoc/sassdoc#465].

2.8.4 - 2021-12-22

Fixed

• Multiple @return types annotations <code> escaping due to Nunjucks migration.

2.8.3 - 2019-07-19

Fixed

• Fix parameter annotations <code> escaping due to Nunjucks migration.

2.8.2 - 2019-05-08

Fixed

• Fix invalid condition for displaying alias items in sidebar.

2.8.1 - 2019-04-22

Fixed

• Fix a remaining raw Swig filter after replacement.

2.8.0 - 2019-04-22

Changed

• Template engine replacement.
  Swap Swig per Nunjucks. [#104]
  This should be transparent for end users.

2.7.0 - 2019-04-10

Added

• Add group description display.