diff --git a/README.md b/README.md index df13235..4bae8c8 100644 --- a/README.md +++ b/README.md @@ -23,24 +23,24 @@ See it in action in [sphinx-themes.org](https://sphinx-themes.org/#theme-sphinx- ## Index filtering -
+ By default the **index** shows the content folded. Opening or closing items is remembered while browsing the documentation. To quickly find items use the input filter. The filter will display items that could be invisible within a folded item. When the user types in the input field, let us say `fo`, the index gets filtered with all the entries that match those two characters. So the index will display three matches: `Fonts`, `Footer links` and `Footnotes`. Those three entries were all folded within their sections: - + ## The TOC on the right side The Table of Contents, displayed on the right side, spans itself to the right border of the browser to display long items, improving readability. - + ## Other features Nefertiti for Sphinx comes with the following color sets. Change between them using the attribute `display` of the `html_theme_options` setting. - + In order to be compliant with [EU's GDPR](https://gdpr.eu/), Nefertiti for Sphinx comes bundled with a group of fonts licensed for free distribution. Adding more fonts is explained in the [User's Guide](https://sphinx-nefertiti.readthedocs.io/en/latest/users-guide/customization/fonts.html#adding-fonts): diff --git a/docs/source/static/img/colorsets.png b/docs/source/static/img/colorsets.png new file mode 100644 index 0000000..215dd2a Binary files /dev/null and b/docs/source/static/img/colorsets.png differ diff --git a/docs/source/static/img/index-filtering-1.png b/docs/source/static/img/index-filtering-1.png new file mode 100644 index 0000000..887277d Binary files /dev/null and b/docs/source/static/img/index-filtering-1.png differ diff --git a/docs/source/static/img/index-filtering-2.png b/docs/source/static/img/index-filtering-2.png new file mode 100644 index 0000000..f21227d Binary files /dev/null and b/docs/source/static/img/index-filtering-2.png differ diff --git a/docs/source/static/img/toc.png b/docs/source/static/img/toc.png new file mode 100644 index 0000000..e9fe922 Binary files /dev/null and b/docs/source/static/img/toc.png differ