Skip to content

Commit f5b7106

Browse files
authored
Enable use of HTML in docs (#1900)
Fix alignment documentation: - while it renders fine on the web, it's stripped from man pages. Inline HTML renders fine in some cases, but tables don't. There's no unified (remark) plugin that works well with headless tables pandoc supports as well, so the only way to achieve a similar effect is to leave header cells empty. Signed-off-by: Tin Švagelj <tin.svagelj@live.com>
1 parent a03f0bc commit f5b7106

File tree

6 files changed

+59
-840
lines changed

6 files changed

+59
-840
lines changed

doc/CMakeLists.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ if(BUILD_DOCS)
2525
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
2626
SOURCES config_settings.yaml variables.yaml lua.yaml man.md.j2
2727
)
28+
set(pandoc_mode markdown-markdown_in_html_blocks+raw_html)
2829
add_custom_target(conky.1
2930
ALL
30-
COMMAND ${APP_PANDOC} --standalone -f markdown+raw_html -t man ${CMAKE_CURRENT_BINARY_DIR}/man.md > ${CMAKE_CURRENT_BINARY_DIR}/conky.1
31+
COMMAND ${APP_PANDOC} --standalone -f ${pandoc_mode} -t man ${CMAKE_CURRENT_BINARY_DIR}/man.md > ${CMAKE_CURRENT_BINARY_DIR}/conky.1
3132
SOURCES config_settings.yaml variables.yaml lua.yaml man.md.j2
3233
)
3334
add_dependencies(conky.1 man.md)

doc/config_settings.yaml

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,11 @@ values:
2929
desc: |-
3030
Aligned position on screen, may be `none` or one of:
3131
32-
<table>
33-
<tr>
34-
<td><code>top_left</code> (<em>or</em> <code>tl</code>)</td>
35-
<td><code>top_middle</code> (<em>or</em> <code>tm</code>)</td>
36-
<td><code>top_right</code> (<em>or</em> <code>tr</code>)</td>
37-
</tr>
38-
<tr>
39-
<td><code>middle_left</code> (<em>or</em> <code>ml</code>)</td>
40-
<td><code>middle_middle</code> (<em>or</em> <code>mm</code>)</td>
41-
<td><code>middle_right</code> (<em>or</em> <code>mr</code>)</td>
42-
</tr>
43-
<tr>
44-
<td><code>bottom_left</code> (<em>or</em> <code>bl</code>)</td>
45-
<td><code>bottom_middle</code> (<em>or</em> <code>bm</code>)</td>
46-
<td><code>bottom_right</code> (<em>or</em> <code>br</code>)</td>
47-
</tr>
48-
</table>
32+
| | | |
33+
|:----------------------|:-----------------------:|-----------------------:|
34+
|`top_left` (or `tl`) | `top_middle` (or `tm`) | `top_right` (or `tr`)|
35+
|`middle_left` (or `ml`)|`middle_middle` (or `mm`)|`middle_right` (or `mr`)|
36+
|`bottom_left` (or `bl`)|`bottom_middle` (or `bm`)|`bottom_right` (or `br`)|
4937
5038
In case of `panel` and `dock` windows, it might make more sense to use one
5139
of the following aliases:

0 commit comments

Comments
 (0)