Skip to content

Commit a7f7891

Browse files
committed
preparing v2.2.0 release
- update version reference in README - add header labels in documentation for easier linking
1 parent 40069d1 commit a7f7891

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ To use the theme in your documentation, copy the required CSS and JS files from
4747
```bash
4848
git submodule add https://github.com/jothepro/doxygen-awesome-css.git
4949
cd doxygen-awesome-css
50-
git checkout v2.1.0
50+
git checkout v2.2.0
5151
```
5252

5353
You can even install the theme system-wide by running `make install`. The files will be installed to `/usr/local/share/` by default, but you can customize the install location with `make PREFIX=/my/custom/path install`.

docs/extensions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This is how you can create the default template with Doxygen:
1919

2020
[More details on header customization](https://www.doxygen.nl/manual/customize.html#minor_tweaks_header_css)
2121

22-
## Dark Mode Toggle
22+
## Dark Mode Toggle {#extension-dark-mode-toggle}
2323

2424
Adds a button next to the search bar to enable and disable the dark theme variant manually:
2525

@@ -63,7 +63,7 @@ DoxygenAwesomeDarkModeToggle.darkModeIcon = `<svg xmlns="http://www.w3.org/2000/
6363
All customizations must be applied before calling `DoxygenAwesomeDarkModeToggle.init()`!
6464
6565
66-
## Fragment Copy Button
66+
## Fragment Copy Button {#extension-copy-button}
6767
6868
Shows a copy button when the user hovers over a code fragment:
6969
@@ -103,7 +103,7 @@ DoxygenAwesomeFragmentCopyButton.successIcon = `<svg ...>`
103103

104104
All customizations must be applied before calling `DoxygenAwesomeDarkModeToggle.init()`!
105105
106-
## Paragraph Linking
106+
## Paragraph Linking {#extension-para}
107107
108108
Provides a button on hover behind every headline to allow easy creation of a permanent link to the headline:
109109
@@ -144,7 +144,7 @@ DoxygenAwesomeParagraphLink.icon = "¶"
144144

145145
All customizations must be applied before calling `DoxygenAwesomeParagraphLink.init()`!
146146
147-
## Interactive TOC
147+
## Interactive TOC {#extension-toc}
148148
149149
On large screens the Table of Contents (TOC) is anchored on the top right of the page. This extension visualizes the reading progress by dynamically highlighting the currently active section.
150150
@@ -184,7 +184,7 @@ Hiding the TOC on small screens can be disabled. It is still interactive and can
184184
DoxygenAwesomeInteractiveToc.hideMobileMenu = false
185185
```
186186

187-
## Tabs
187+
## Tabs {#extension-tabs}
188188

189189
@note Experimental feature! Please report bugs [here](https://github.com/jothepro/doxygen-awesome-css/issues).
190190

docs/tricks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[TOC]
44

5-
## Diagrams with Graphviz
5+
## Diagrams with Graphviz {#tricks-graphviz}
66

77
To get the best looking class diagrams for your documentation, generate them with Graphviz as vector graphics with transparent background:
88

@@ -25,7 +25,7 @@ In case `INTERACTIVE_SVG = YES` is set in the Doxyfile, all user-defined dotgrap
2525

2626
@note Both the default overflow scrolling behavior in this theme and the interactive editor enabled by `INTERACTIVE_SVG` are unsatisfying workarounds IMHO. Consider designing your graphs to be narrow enough to fit the page to avoid scrolling.
2727

28-
## Disable Dark Mode
28+
## Disable Dark Mode {#tricks-darkmode}
2929

3030
If you don't want the theme to automatically switch to dark mode depending on the browser preference,
3131
you can disable dark mode by adding the `light-mode` class to the html-tag in the header template:
@@ -43,7 +43,7 @@ The same can be done to always enable dark-mode:
4343

4444
@warning This only works if you don't use the dark-mode toggle extension.
4545

46-
## Choosing Sidebar Width
46+
## Choosing Sidebar Width {#tricks-sidebar}
4747

4848
If you have enabled the sidebar-only theme variant, make sure to carefully choose a proper width for your sidebar.
4949
It should be wide enough to hold the icon, project title and version number. If the content is too wide, it will be
@@ -63,7 +63,7 @@ The chosen width should also be set in the Doxyfile:
6363
TREEVIEW_WIDTH = 335
6464
```
6565

66-
## Formatting Tables
66+
## Formatting Tables {#tricks-tables}
6767

6868
By default tables in this theme are left-aligned and as wide as required to fit their content.
6969
Those properties can be changed for individual tables.

0 commit comments

Comments
 (0)