Styling improvements to documentation (#6425)
* Changed mkdocs theme * Added custom styles for various elements * Moved to different syntax highlighting plugin * Added a README for the docs/ folder to direct people to the docs site * Change highlight theme
Joel Hans committed
Jul 15, 2019 at 07:50 UTC
cbb0528d32576d146920cfdbc3964644a39c5d11
3 files changed
+36
-1
docs/README.md
new
+7
@@ -0,0 +1,7 @@
1
+# Read documentation on https://docs.netdata.cloud
2
+
3
+Welcome to the Netdata documentation! While you can read Netdata documentation here, or throughout the Netdata repository, our intention is that these pages are read on [docs.netdata.cloud](https://docs.netdata.cloud).
4
+
5
+Links between documentation pages will work fine here, but the formatting may not be perfect, as our documentation site uses a few extra Markdown features that GitHub doesn't support natively. Other things might be missing or look less than perfect.
6
+
7
+Now get out there and build an exceptional infrastructure.
\ No newline at end of file
docs/generator/buildyaml.sh
+6
-1
@@ -68,6 +68,9 @@ extra:
68
link: "https://www.facebook.com/linuxnetdata/"
69
theme:
70
name: "material"
71
+ palette:
72
+ primary: "blue grey"
73
+ accent: "light green"
74
custom_dir: custom/themes/material
75
favicon: custom/img/favicon.ico
76
language: '${language}'
@@ -86,7 +89,6 @@ markdown_extensions:
89
- footnotes
90
- tables
91
- admonition
89
- - codehilite
92
- meta
93
- sane_lists
94
- smarty
@@ -100,6 +102,9 @@ markdown_extensions:
102
- pymdownx.caret
103
- pymdownx.critic
104
- pymdownx.details
105
+ - pymdownx.highlight:
106
+ pygments_style: manni
107
+ noclasses: true
108
- pymdownx.inlinehilite
109
- pymdownx.magiclink
110
- pymdownx.mark
docs/generator/custom/css/netdata.css
+23
@@ -5,3 +5,26 @@
5
.md-typeset {
6
font-size: .75rem
7
}
8
+
9
+/* Hide the label at the top of the navigation menu. Does nothing. */
10
+.md-nav__title {
11
+ display: none;
12
+}
13
+
14
+/* Change the language selector dropdown to match new color. */
15
+.md-header-nav select#sel {
16
+ background-color: rgba(0,0,0,.26) !important;
17
+ padding: 3px;
18
+ margin-left: 5px;
19
+ margin-right: 20px;
20
+}
21
+
22
+/* Add some whitespace to the bottom of each doc. */
23
+.md-content {
24
+ margin-bottom: 6rem;
25
+}
26
+
27
+/* Make sure inline code in tables doesn't break. */
28
+.md-typeset__table code {
29
+ word-break: normal;
30
+}
\ No newline at end of file