You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-15Lines changed: 16 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,19 @@
10
10
11
11
</div>
12
12
13
-
**Doxygen Awesome** is a custom **CSS theme for Doxygen HTML-documentation** with lots of customization parameters.
13
+
**Doxygen Awesome** is a custom CSS theme for Doxygen HTMLdocumentation with lots of customization parameters.
14
14
15
15
## Motivation
16
16
17
-
I really like how the Doxygen HTML-documentation is structured! But IMHO it looks a bit outdated.
17
+
I really like how the Doxygen HTMLdocumentation is structured! But IMHO it looks a bit outdated.
18
18
19
19
This theme is an attempt to update the visuals of Doxygen without changing its overall layout too much.
20
20
21
21
## Features
22
22
23
23
- 🌈 Clean, modern design
24
-
- 🚀 Heavily customizable by adjusting CSS-variables
25
-
- 🧩 No changes to the HTML structure of Doxygen required
24
+
- 🚀 Heavily customizable by adjusting CSSvariables
25
+
- 🧩 No changes to the HTML structure of Doxygen are required
26
26
- 📱 Improved mobile usability
27
27
- 🌘 Dark mode support!
28
28
- 🥇 Works best with **doxygen 1.9.1** - **1.9.4** and **1.9.6** - **1.9.8**
@@ -49,13 +49,12 @@ This can be done in several ways:
49
49
- manually copying the files
50
50
- adding the project as a Git submodule
51
51
- adding the project as a npm/xpm dependency
52
-
- installing the theme systemwide
52
+
- installing the theme system-wide
53
53
54
54
All theme files are located in the root of this repository and start with the prefix `doxygen-awesome-`. You may not need all of them. Follow the install instructions to figure out what files are required for your setup.
55
55
56
56
### Git submodule
57
-
58
-
For projects which use git, add the repository as a submodule and check out the desired release:
57
+
For projects that use git, add the repository as a submodule and check out the desired release:
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`.
83
+
You can even install the theme system-wide by running `make install`.
84
+
The files will be installed to `/usr/local/share/` by default,
85
+
but you can customize the install location with `make PREFIX=/my/custom/path install`.
85
86
86
87
### Choosing a layout
87
88
88
-
There is two layout options. Choose one of them and configure Doxygen accordingly:
89
+
There are two layout options. Choose one of them and configure Doxygen accordingly:
For dark-mode overrides you have to choose where to put them, depending on whether the dark-mode toggle extension is installed or not:
29
+
For dark-mode overrides, you have to choose where to put them, depending on whether the dark-mode toggle extension is installed or not:
30
30
31
31
<divclass="tabbed">
32
32
@@ -90,11 +90,11 @@ If you miss a configuration option or find a bug, please consider [opening an is
90
90
91
91
The theme overrides most colors with the `--primary-color-*` variables.
92
92
93
-
But there isa few small images and graphics that the theme cannot adjust or replace. To make these blend in better with
93
+
But there area few small images and graphics that the theme cannot adjust or replace. To make these blend in better with
94
94
the rest, it is recommended to adjust the [doxygen color settings](https://www.doxygen.nl/manual/customize.html#minor_tweaks_colors)
95
-
to something that matches the chosen color-scheme.
95
+
to something that matches the chosen colorscheme.
96
96
97
-
For the default color-scheme, these values work out quite well:
97
+
For the default colorscheme, these values work out quite well:
98
98
99
99
```
100
100
# Doxyfile
@@ -105,7 +105,7 @@ HTML_COLORSTYLE_GAMMA = 113
105
105
106
106
## Share your customizations
107
107
108
-
If you customized the theme with custom colors, spacings, font-sizes, etc. and you want to share your creation with others, you can to this [here](https://github.com/jothepro/doxygen-awesome-css/discussions/13).
108
+
If you have customized the theme with custom colors, spacings, font-sizes, etc. and you want to share your creation with others, you can do this [here](https://github.com/jothepro/doxygen-awesome-css/discussions/13).
109
109
110
110
I am always curious to learn about how you made the theme look even better!
Copy file name to clipboardExpand all lines: docs/extensions.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
On top of the base theme provided by `doxygen-awesome.css`, this repository comes with Javascript extensions that require additional setup steps to get them running.
6
6
7
-
The extensions require customizations in the header HTML-template.
7
+
The extensions require customizations in the header HTMLtemplate.
8
8
This is how you can create the default template with Doxygen:
9
9
10
10
1. Create default header template:
@@ -24,7 +24,8 @@ This is how you can create the default template with Doxygen:
24
24
Adds a button next to the search bar to enable and disable the dark theme variant manually:
Works for all headlines and for many documentation section titles.
@@ -146,13 +149,14 @@ All customizations must be applied before calling `DoxygenAwesomeParagraphLink.i
146
149
147
150
## Interactive TOC {#extension-toc}
148
151
149
-
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.
152
+
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.
150
153
151
-
On small screens the extension hides the TOC by default. The user can open it manually when needed:
154
+
On small screens, the extension hides the TOC by default. The user can open it manually when needed:
Copy file name to clipboardExpand all lines: docs/tricks.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
## Diagrams with Graphviz {#tricks-graphviz}
6
6
7
-
To get the bestlooking class diagrams for your documentation, generate them with Graphviz as vector graphics with transparent background:
7
+
To get the best-looking class diagrams for your documentation, generate them with Graphviz as vector graphics with transparent background:
8
8
9
9
```
10
10
# Doxyfile
@@ -13,7 +13,7 @@ DOT_IMAGE_FORMAT = svg
13
13
DOT_TRANSPARENT = YES
14
14
```
15
15
16
-
In case `INTERACTIVE_SVG = YES` is set in the Doxyfile, all user-defined dotgraphs must be wrapped with the `interactive_dotgraph` CSS class in order for them to be rendered correctly:
16
+
In case `INTERACTIVE_SVG = YES` is set in the Doxyfile, all user-defined dotgraphs must be wrapped with the `interactive_dotgraph` CSS class for them to be rendered correctly:
17
17
18
18
```md
19
19
<div class="interactive_dotgraph">
@@ -28,13 +28,13 @@ In case `INTERACTIVE_SVG = YES` is set in the Doxyfile, all user-defined dotgrap
28
28
## Disable Dark Mode {#tricks-darkmode}
29
29
30
30
If you don't want the theme to automatically switch to dark mode depending on the browser preference,
31
-
you can disable dark mode by adding the `light-mode` class to the html-tag in the header template:
31
+
you can disable dark mode by adding the `light-mode` class to the HTML tag in the header template:
0 commit comments