REST Frontend: Use fences for code blocks
@@ -167,10 +167,12 @@ The headline always refers to the `type` field of the element.
The element type `link` for example would be an object like the following
with some extra attributes explained below:
+```
{
"type": "link",
... other attributes ...
}
+```
It is possible to add additional attributes not used by the system without breaking anything.
For example use `dev-comment` to leave some development notes, e.g. decision information.
@@ -189,12 +191,14 @@ This field type supports following attributes:
Example:
+```json
{
"name": "Documentation",
"type": "submenu",
"ref": "docs",
"children": []
}
+```
#### parsereadme
@@ -228,6 +232,7 @@ This field type support following attributes:
Example:
+```json
{
"name": "Plugins",
"type": "parsereadme",
@@ -246,6 +251,7 @@ Example:
}
}
}
+```
#### listdirs
@@ -265,6 +271,7 @@ This field type supports following attributes:
Example:
+```json
{
"name": "Tools",
"type": "listdirs",
@@ -274,6 +281,7 @@ Example:
"target_file": ["README.md", "README", "readme.md", "readme"]
}
}
+```
#### listfiles
@@ -293,6 +301,7 @@ This field type supports following attributes:
Example:
+```json
{
"name": "Manpages",
"type": "listfiles",
@@ -302,6 +311,7 @@ Example:
"blacklist": ["CMakeLists.txt"]
}
}
+```
#### staticlist
@@ -318,12 +328,14 @@ This field type supports following attributes:
Example:
+```json
{
"name": "Getting started",
"type": "staticlist",
"ref": "getstarted",
"children": []
}
+```
#### staticref
@@ -338,6 +350,7 @@ This field type support following attributes:
Example:
+```json
{
"name": "Tutorials",
"type": "staticref",
@@ -345,6 +358,7 @@ Example:
"path": "tutorials"
}
}
+```
#### staticfile
@@ -359,6 +373,7 @@ This field type support following attributes:
Example:
+```json
{
"name": "Installation",
"type": "staticfile",
@@ -366,6 +381,7 @@ Example:
"path": "doc/INSTALL.md"
}
}
+```
#### link
@@ -381,6 +397,7 @@ This field type support following attributes:
Example:
+```json
{
"name": "Build Server",
"type": "link",
@@ -389,6 +406,7 @@ Example:
"path": "https://build.libelektra.org/"
}
}
+```
## Development
