From 2ecd9bccdadab3b731de88cb387613f579629b25 Mon Sep 17 00:00:00 2001 From: Daniela Rus Morales Date: Tue, 20 Feb 2024 16:13:08 +0100 Subject: [PATCH] Update README --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 87c78f8..a46c9eb 100644 --- a/README.md +++ b/README.md @@ -14,28 +14,24 @@ Nefertiti is a theme for [Sphinx](https://www.sphinx-doc.org/en/master/) that fe ## Index filtering - +

-By default the **index** shows the content folded. Opening or closing items is remembered while browsing the documentation. +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 unvisible 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: -To quickly find items use the input filter. The filter will display items that could be unvisible within a folded item. - - - -In the 2nd sample image the user types `fo`, that matches `Fonts`, `Footer links` and `Footnotes`. Those three entries were all folded within their sections. While typing the index will show the entries that match the input field. +

## 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. -The Table of Contents, displayed on the right side of the page, 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):