change expected port number; add docs about markdown description lists; various cleanup
This commit is contained in:
@@ -14,4 +14,7 @@ Command line use is very straight-forward, as there is only one valid way to cal
|
||||
docs2website <config file>
|
||||
```
|
||||
|
||||
The `<config file>` parameter should refer to a file containing [the configuration](./configuration.html) to build with.
|
||||
## Parameters
|
||||
|
||||
: `<config file>`
|
||||
: File path to the file containing [build configuration](./configuration.html)
|
||||
|
||||
@@ -13,7 +13,7 @@ The docs2website project is a static site generator primarily focused on technic
|
||||
- [Configuration](./configuration.html)
|
||||
- [Command Line Use](./command-line-use.html)
|
||||
- [Programatic Use](./programatic-use.html)
|
||||
- [Preview Built-in Color Themes](color-themes/preview.html)
|
||||
- [Preview Built-in Color Themes](../color-themes/preview.html)
|
||||
- [Source Code {:external-link:}](https://gitea.jbrumond.me/doc-utils/docs2website)
|
||||
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: doc-utils
|
||||
layout: main.html
|
||||
---
|
||||
|
||||
# doc-utils {#-}
|
||||
# doc-utils
|
||||
|
||||
Documentation for the doc-utils projects.
|
||||
|
||||
|
||||
@@ -81,6 +81,60 @@ function say_hello() {
|
||||
|
||||
|
||||
|
||||
## Definition / Description Lists {#dl}
|
||||
|
||||
Definition lists or description lists (`<dl>` elements) can be rendered using lines that being with a colon (`:`) character.
|
||||
|
||||
An unindented line starting with a colon is a `<dt>`, and an indented line starting with a colon is a `<dd>`. Indentation without a starting colon can be used to have multiple lines of content in either type of block. These lists can be nested.
|
||||
|
||||
Indentation in `<dl>` blocks must two consecutive spaces; Other indentation styles are not allowed.
|
||||
|
||||
```md
|
||||
: First Term
|
||||
: First Definition
|
||||
: Second Definition
|
||||
|
||||
: Second Term
|
||||
with multiple lines
|
||||
of content
|
||||
: Third Definition
|
||||
|
||||
: Nested List, First Term
|
||||
: Nested List, First Definition
|
||||
: Nested List Second Term
|
||||
: Nested List, First Definition
|
||||
with a _second_ line inside a definition, indicated by indenting again with no colon
|
||||
|
||||
: Fourth Definition
|
||||
|
||||
: Third Term
|
||||
: Fifth Definition
|
||||
```
|
||||
|
||||
!!! {.markdown-example-output}
|
||||
: First Term
|
||||
: First Definition
|
||||
: Second Definition
|
||||
|
||||
: Second Term
|
||||
with multiple lines
|
||||
of content
|
||||
: Third Definition
|
||||
|
||||
: Nested List, First Term
|
||||
: Nested List, First Definition
|
||||
: Nested List Second Term
|
||||
: Nested List, First Definition
|
||||
with a _second_ line inside a definition, indicated by indenting again with no colon
|
||||
|
||||
: Fourth Definition
|
||||
|
||||
: Third Term
|
||||
: Fifth Definition
|
||||
!!!
|
||||
|
||||
|
||||
|
||||
|
||||
## Feather Icons {#feather}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user