1
+ ---
1
2
title : Home
3
+ ---
2
4
3
5
# MkDocs Bootstrap Theme
4
6
5
7
This project provides legacy [ MkDocs] themes based on the 1.0.x version of the
6
8
` mkdocs ` theme for the different Bootstrap 2 themes provided by the
7
9
[ Bootswatch] project.
8
10
9
-
10
11
## Installation & Usage
11
12
12
13
Install the collection of themes with pip, which is hopefully how you
13
14
installed MkDocs.
14
15
15
16
pip install mkdocs-bootswatch-classic
16
17
17
-
18
18
After installation is complete, edit your [ mkdocs.yml] config file and set the
19
19
[ theme] to one of the following Bootwatch themes included. The full list is as
20
20
follows:
21
21
22
- - [ mkdocs-classic] ( #mkdocs )
23
- - [ amelia-classic] ( #amelia )
24
- - [ bootstrap-classic] ( #bootstrap )
25
- - [ cerulean-classic] ( #cerulean )
26
- - [ cosmo-classic] ( #cosmo )
27
- - [ cyborg-classic] ( #cyborg )
28
- - [ flatly-classic] ( #flatly )
29
- - [ journal-classic] ( #journal )
30
- - [ readable-classic] ( #readable )
31
- - [ simplex-classic] ( #simplex )
32
- - [ slate-classic] ( #slate )
33
- - [ spacelab-classic] ( #spacelab )
34
- - [ united-classic] ( #united )
35
- - [ yeti-classic] ( #yeti )
22
+ - [ mkdocs-classic] ( #mkdocs )
23
+ - [ amelia-classic] ( #amelia )
24
+ - [ bootstrap-classic] ( #bootstrap )
25
+ - [ cerulean-classic] ( #cerulean )
26
+ - [ cosmo-classic] ( #cosmo )
27
+ - [ cyborg-classic] ( #cyborg )
28
+ - [ flatly-classic] ( #flatly )
29
+ - [ journal-classic] ( #journal )
30
+ - [ readable-classic] ( #readable )
31
+ - [ simplex-classic] ( #simplex )
32
+ - [ slate-classic] ( #slate )
33
+ - [ spacelab-classic] ( #spacelab )
34
+ - [ united-classic] ( #united )
35
+ - [ yeti-classic] ( #yeti )
36
36
37
37
For example:
38
38
@@ -53,45 +53,59 @@ This [documentation] is rendered with the Bootswatch [Flatly](#flatly) theme.
53
53
Previews of the other themes can be seen below.
54
54
55
55
### MkDocs
56
+
56
57
![ MkDocs] ( screenshots/mkdocs.png )
57
58
58
59
### Amelia
60
+
59
61
![ Amelia] ( screenshots/amelia.png )
60
62
61
63
### Bootstrap
64
+
62
65
![ Bootstrap] ( screenshots/bootstrap.png )
63
66
64
67
### Cerulean
68
+
65
69
![ Cerulean] ( screenshots/cerulean.png )
66
70
67
71
### Cosmo
72
+
68
73
![ Cosmo] ( screenshots/cosmo.png )
69
74
70
75
### Cyborg
76
+
71
77
![ Cyborg] ( screenshots/cyborg.png )
72
78
73
79
### Flatly
80
+
74
81
![ Flatly] ( screenshots/flatly.png )
75
82
76
83
### Journal
84
+
77
85
![ Journal] ( screenshots/journal.png )
78
86
79
87
### Readable
88
+
80
89
![ Readable] ( screenshots/readable.png )
81
90
82
91
### Simplex
92
+
83
93
![ Simplex] ( screenshots/simplex.png )
84
94
85
95
### Slate
96
+
86
97
![ Slate] ( screenshots/slate.png )
87
98
88
99
### Spacelab
100
+
89
101
![ Spacelab] ( screenshots/spacelab.png )
90
102
91
103
### United
104
+
92
105
![ United] ( screenshots/united.png )
93
106
94
107
### Yeti
108
+
95
109
![ Yeti] ( screenshots/yeti.png )
96
110
97
111
[ Mkdocs ] : http://www.mkdocs.org
0 commit comments