diff options
author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/github-markdown.css | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip |
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation.
Documentation source files are written in Markdown, and configured with a single YAML file.
* http://www.mkdocs.org/
* http://www.mkdocs.org/user-guide/configuration/
Ref. #312
* remove pandoc-generated HTML documentation
* move markdown doc to doc/md/,
* mkdocs.yml:
* generate HTML doc in doc/html
* add pages TOC/ordering
* use index.md as index page
* Makefile: remove execute permissions from generated files
* Makefile: rewrite htmlpages GFM to markdown conversion using sed:
awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks
* Add mkdocs.yml to .gitattributes, exclude this file from release archives
* Makefile: rename: htmldoc -> doc_html target
* run make doc: pull latest markdown documentation from wiki
* run make htmlpages: update html documentation
Diffstat (limited to 'doc/md/github-markdown.css')
-rw-r--r-- | doc/md/github-markdown.css | 287 |
1 files changed, 287 insertions, 0 deletions
diff --git a/doc/md/github-markdown.css b/doc/md/github-markdown.css new file mode 100644 index 00000000..581350ae --- /dev/null +++ b/doc/md/github-markdown.css | |||
@@ -0,0 +1,287 @@ | |||
1 | #local-sidebar { | ||
2 | width: 230px; | ||
3 | float: right; | ||
4 | position: relative; | ||
5 | z-index: 4; | ||
6 | background-color: #fff; | ||
7 | border: 1px solid #e2e2e2; | ||
8 | border-radius: 3px; | ||
9 | } | ||
10 | |||
11 | body { | ||
12 | font-family: Helvetica, arial, sans-serif; | ||
13 | font-size: 14px; | ||
14 | line-height: 1.6; | ||
15 | padding-top: 10px; | ||
16 | padding-bottom: 10px; | ||
17 | background-color: white; | ||
18 | padding: 10px 20%; } | ||
19 | |||
20 | body > *:first-child { | ||
21 | margin-top: 0 !important; } | ||
22 | body > *:last-child { | ||
23 | margin-bottom: 0 !important; } | ||
24 | |||
25 | a { | ||
26 | color: #4183C4; } | ||
27 | a.absent { | ||
28 | color: #cc0000; } | ||
29 | a.anchor { | ||
30 | display: block; | ||
31 | padding-left: 30px; | ||
32 | margin-left: -30px; | ||
33 | cursor: pointer; | ||
34 | position: absolute; | ||
35 | top: 0; | ||
36 | left: 0; | ||
37 | bottom: 0; } | ||
38 | |||
39 | h1, h2, h3, h4, h5, h6 { | ||
40 | margin: 20px 0 10px; | ||
41 | padding: 0; | ||
42 | font-weight: bold; | ||
43 | -webkit-font-smoothing: antialiased; | ||
44 | cursor: text; | ||
45 | position: relative; } | ||
46 | |||
47 | h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor { | ||
48 | background: url("../../images/modules/styleguide/para.png") no-repeat 10px center; | ||
49 | text-decoration: none; } | ||
50 | |||
51 | h1 tt, h1 code { | ||
52 | font-size: inherit; } | ||
53 | |||
54 | h2 tt, h2 code { | ||
55 | font-size: inherit; } | ||
56 | |||
57 | h3 tt, h3 code { | ||
58 | font-size: inherit; } | ||
59 | |||
60 | h4 tt, h4 code { | ||
61 | font-size: inherit; } | ||
62 | |||
63 | h5 tt, h5 code { | ||
64 | font-size: inherit; } | ||
65 | |||
66 | h6 tt, h6 code { | ||
67 | font-size: inherit; } | ||
68 | |||
69 | h1 { | ||
70 | font-size: 28px; | ||
71 | color: black; } | ||
72 | |||
73 | h2 { | ||
74 | font-size: 24px; | ||
75 | border-bottom: 1px solid #cccccc; | ||
76 | color: black; } | ||
77 | |||
78 | h3 { | ||
79 | font-size: 18px; } | ||
80 | |||
81 | h4 { | ||
82 | font-size: 16px; } | ||
83 | |||
84 | h5 { | ||
85 | font-size: 14px; } | ||
86 | |||
87 | h6 { | ||
88 | color: #777777; | ||
89 | font-size: 14px; } | ||
90 | |||
91 | p, blockquote, ol, dl, table, pre { | ||
92 | margin: 15px 0; } | ||
93 | |||
94 | hr { | ||
95 | background: transparent url("../../images/modules/pulls/dirty-shade.png") repeat-x 0 0; | ||
96 | border: 0 none; | ||
97 | color: #cccccc; | ||
98 | height: 4px; | ||
99 | padding: 0; } | ||
100 | |||
101 | body > h2:first-child { | ||
102 | margin-top: 0; | ||
103 | padding-top: 0; } | ||
104 | body > h1:first-child { | ||
105 | margin-top: 0; | ||
106 | padding-top: 0; } | ||
107 | body > h1:first-child + h2 { | ||
108 | margin-top: 0; | ||
109 | padding-top: 0; } | ||
110 | body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child { | ||
111 | margin-top: 0; | ||
112 | padding-top: 0; } | ||
113 | |||
114 | a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 { | ||
115 | margin-top: 0; | ||
116 | padding-top: 0; } | ||
117 | |||
118 | h1 p, h2 p, h3 p, h4 p, h5 p, h6 p { | ||
119 | margin-top: 0; } | ||
120 | |||
121 | li p.first { | ||
122 | display: inline-block; } | ||
123 | |||
124 | ul, ol { | ||
125 | padding-left: 30px; } | ||
126 | |||
127 | ul :first-child, ol :first-child { | ||
128 | margin-top: 0; } | ||
129 | |||
130 | ul :last-child, ol :last-child { | ||
131 | margin-bottom: 0; } | ||
132 | |||
133 | dl { | ||
134 | padding: 0; } | ||
135 | dl dt { | ||
136 | font-size: 14px; | ||
137 | font-weight: bold; | ||
138 | font-style: italic; | ||
139 | padding: 0; | ||
140 | margin: 15px 0 5px; } | ||
141 | dl dt:first-child { | ||
142 | padding: 0; } | ||
143 | dl dt > :first-child { | ||
144 | margin-top: 0; } | ||
145 | dl dt > :last-child { | ||
146 | margin-bottom: 0; } | ||
147 | dl dd { | ||
148 | margin: 0 0 15px; | ||
149 | padding: 0 15px; } | ||
150 | dl dd > :first-child { | ||
151 | margin-top: 0; } | ||
152 | dl dd > :last-child { | ||
153 | margin-bottom: 0; } | ||
154 | |||
155 | blockquote { | ||
156 | border-left: 4px solid #dddddd; | ||
157 | padding: 0 15px; | ||
158 | color: #777777; } | ||
159 | blockquote > :first-child { | ||
160 | margin-top: 0; } | ||
161 | blockquote > :last-child { | ||
162 | margin-bottom: 0; } | ||
163 | |||
164 | table { | ||
165 | padding: 0; } | ||
166 | table tr { | ||
167 | border-top: 1px solid #cccccc; | ||
168 | background-color: white; | ||
169 | margin: 0; | ||
170 | padding: 0; } | ||
171 | table tr:nth-child(2n) { | ||
172 | background-color: #f8f8f8; } | ||
173 | table tr th { | ||
174 | font-weight: bold; | ||
175 | border: 1px solid #cccccc; | ||
176 | text-align: left; | ||
177 | margin: 0; | ||
178 | padding: 6px 13px; } | ||
179 | table tr td { | ||
180 | border: 1px solid #cccccc; | ||
181 | text-align: left; | ||
182 | margin: 0; | ||
183 | padding: 6px 13px; } | ||
184 | table tr th :first-child, table tr td :first-child { | ||
185 | margin-top: 0; } | ||
186 | table tr th :last-child, table tr td :last-child { | ||
187 | margin-bottom: 0; } | ||
188 | |||
189 | img { | ||
190 | max-width: 100%; } | ||
191 | |||
192 | span.frame { | ||
193 | display: block; | ||
194 | overflow: hidden; } | ||
195 | span.frame > span { | ||
196 | border: 1px solid #dddddd; | ||
197 | display: block; | ||
198 | float: left; | ||
199 | overflow: hidden; | ||
200 | margin: 13px 0 0; | ||
201 | padding: 7px; | ||
202 | width: auto; } | ||
203 | span.frame span img { | ||
204 | display: block; | ||
205 | float: left; } | ||
206 | span.frame span span { | ||
207 | clear: both; | ||
208 | color: #333333; | ||
209 | display: block; | ||
210 | padding: 5px 0 0; } | ||
211 | span.align-center { | ||
212 | display: block; | ||
213 | overflow: hidden; | ||
214 | clear: both; } | ||
215 | span.align-center > span { | ||
216 | display: block; | ||
217 | overflow: hidden; | ||
218 | margin: 13px auto 0; | ||
219 | text-align: center; } | ||
220 | span.align-center span img { | ||
221 | margin: 0 auto; | ||
222 | text-align: center; } | ||
223 | span.align-right { | ||
224 | display: block; | ||
225 | overflow: hidden; | ||
226 | clear: both; } | ||
227 | span.align-right > span { | ||
228 | display: block; | ||
229 | overflow: hidden; | ||
230 | margin: 13px 0 0; | ||
231 | text-align: right; } | ||
232 | span.align-right span img { | ||
233 | margin: 0; | ||
234 | text-align: right; } | ||
235 | span.float-left { | ||
236 | display: block; | ||
237 | margin-right: 13px; | ||
238 | overflow: hidden; | ||
239 | float: left; } | ||
240 | span.float-left span { | ||
241 | margin: 13px 0 0; } | ||
242 | span.float-right { | ||
243 | display: block; | ||
244 | margin-left: 13px; | ||
245 | overflow: hidden; | ||
246 | float: right; } | ||
247 | span.float-right > span { | ||
248 | display: block; | ||
249 | overflow: hidden; | ||
250 | margin: 13px auto 0; | ||
251 | text-align: right; } | ||
252 | |||
253 | code, tt { | ||
254 | margin: 0 2px; | ||
255 | padding: 0 5px; | ||
256 | white-space: nowrap; | ||
257 | border: 1px solid #eaeaea; | ||
258 | background-color: #f8f8f8; | ||
259 | border-radius: 3px; } | ||
260 | |||
261 | pre code { | ||
262 | margin: 0; | ||
263 | padding: 0; | ||
264 | white-space: pre; | ||
265 | border: none; | ||
266 | background: transparent; } | ||
267 | |||
268 | .highlight pre { | ||
269 | background-color: #f8f8f8; | ||
270 | border: 1px solid #cccccc; | ||
271 | font-size: 13px; | ||
272 | line-height: 19px; | ||
273 | overflow: auto; | ||
274 | padding: 6px 10px; | ||
275 | border-radius: 3px; } | ||
276 | |||
277 | pre { | ||
278 | background-color: #f8f8f8; | ||
279 | border: 1px solid #cccccc; | ||
280 | font-size: 13px; | ||
281 | line-height: 19px; | ||
282 | overflow: auto; | ||
283 | padding: 6px 10px; | ||
284 | border-radius: 3px; } | ||
285 | pre code, pre tt { | ||
286 | background-color: transparent; | ||
287 | border: none; } | ||