updates for docs2website changes
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
James Brumond 2023-05-21 14:36:08 -07:00
parent 244585daba
commit 52a9a52abc
Signed by: james
GPG Key ID: E8F2FC44BAA3357A
16 changed files with 237 additions and 70 deletions

View File

@ -1,4 +1,8 @@
metadata: ./metadata.json
base_url: http://localhost:8000
# Input Configuration (where your documents are)
input:
# The root directory for where to find input file. All other
@ -89,11 +93,10 @@ output:
# only passed from one step to the other, unless this flag is set.
include_intermediate_markdown: false
sitemap: true
# Markdown-to-HTML Configuration
markdown:
#
base_url: /
#
custom_elements:
tag_names:

View File

@ -2,17 +2,17 @@
title: Color Themes | doc-utils
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[doc-utils](../)'
---
# Color Themes {#/}
_todo_
- [Preview Color Themes](color-themes/preview.html)
- [Preview Color Themes](./preview.html)
## JSON Schema
- [HTML Webpage](color-themes/schema/v1.html)
- [JSON](color-themes/schema/v1.json)
- [Yaml](color-themes/schema/v1.yaml)
- [HTML Webpage](./schema/v1.html)
- [JSON](./schema/v1.json)
- [Yaml](./schema/v1.yaml)

View File

@ -2,8 +2,8 @@
title: Preview Color Themes | doc-utils
layout: preview-color-themes.html
breadcrumb:
- '[doc-utils](index.html)'
- '[color-themes](color-themes/index.html)'
- '[doc-utils](../)'
- '[color-themes](./)'
---
# Sample Content

View File

@ -2,8 +2,8 @@
title: Color Theme Schema | doc-utils
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[color-themes](color-themes/index.html)'
- '[doc-utils](../../)'
- '[color-themes](../)'
---
$schema: http://json-schema.org/draft-07/schema
$id: https://doc-utils.jbrumond.me/color-themes/schema/v1.json

View File

@ -2,8 +2,8 @@
title: Building From Source | docs2website
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[docs2website](docs2website/index.html)'
- '[doc-utils](../)'
- '[docs2website](./)'
---
# Building From Source {#/}

View File

@ -2,11 +2,11 @@
title: Command Line Use | docs2website
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[docs2website](docs2website/index.html)'
- '[doc-utils](../)'
- '[docs2website](./)'
---
# Command Line Use {#/}
# Command Line Use
Command line use is very straight-forward, as there is only one valid way to call the command:
@ -14,4 +14,4 @@ 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](docs2website/configuration.html) to build with.
The `<config file>` parameter should refer to a file containing [the configuration](./configuration.html) to build with.

View File

@ -2,12 +2,12 @@
title: Configuration | docs2website
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[docs2website](docs2website/index.html)'
- '[doc-utils](../)'
- '[docs2website](./)'
---
# Configuration {#/}
# Configuration
_todo_

View File

@ -2,21 +2,20 @@
title: docs2website
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[doc-utils](../)'
---
# docs2website {#/}
# docs2website
The [docs2website] project is a static site generator primarily focused on technical writing and documentation.
The docs2website project is a static site generator primarily focused on technical writing and documentation.
- [Building From Source](docs2website/building-from-source.html)
- [Configuration](docs2website/configuration.html)
- [Command Line Use](docs2website/command-line-use.html)
- [Programatic Use](docs2website/programatic-use.html)
- [Building From Source](./building-from-source.html)
- [Configuration](./configuration.html)
- [Command Line Use](./command-line-use.html)
- [Programatic Use](./programatic-use.html)
- [Preview Built-in Color Themes](color-themes/preview.html)
- [Source Code {:external-link:}](https://gitea.jbrumond.me/doc-utils/docs2website)
[docs2website]: docs2website/index.html

View File

@ -2,11 +2,11 @@
title: Programatic Use | docs2website
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[docs2website](docs2website/index.html)'
- '[doc-utils](../)'
- '[docs2website](./)'
---
# Programatic Use {#/}
# Programatic Use
_todo_

View File

@ -121,16 +121,16 @@ arrow from ASSET .e to 0.1 east of WEB .sw \
<!-- Link Details -->
[docs2website]: docs2website/index.html
[color-themes]: color-themes/index.html
[markdown2html]: markdown2html/index.html
[openapi2markdown]: openapi2markdown/index.html
[jsonschema2markdown]: jsonschema2markdown/index.html
[asyncapi2markdown]: asyncapi2markdown/index.html
[cyclonedxsbom2markdown]: cyclonedxsbom2markdown/index.html
[spdxsbom2markdown]: spdxsbom2markdown/index.html
[ld2markdown]: ld2markdown/index.html
[xsdschema2markdown]: xsdschema2markdown/index.html
[avroschema2markdown]: avroschema2markdown/index.html
[ts2markdown]: ts2markdown/index.html
[Markdown Format]: markdown2html/markdown-format.html
[docs2website]: ./docs2website/index.html
[color-themes]: ./color-themes/index.html
[markdown2html]: ./markdown2html/index.html
[openapi2markdown]: ./openapi2markdown/index.html
[jsonschema2markdown]: ./jsonschema2markdown/index.html
[asyncapi2markdown]: ./asyncapi2markdown/index.html
[cyclonedxsbom2markdown]: ./cyclonedxsbom2markdown/index.html
[spdxsbom2markdown]: ./spdxsbom2markdown/index.html
[ld2markdown]: ./ld2markdown/index.html
[xsdschema2markdown]: ./xsdschema2markdown/index.html
[avroschema2markdown]: ./avroschema2markdown/index.html
[ts2markdown]: ./ts2markdown/index.html
[Markdown Format]: ./markdown2html/markdown-format.html

View File

@ -2,8 +2,8 @@
title: Building From Source | markdown2html
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[markdown2html](markdown2html/index.html)'
- '[doc-utils](../)'
- '[markdown2html](./)'
---
# Building From Source {#/}

View File

@ -2,7 +2,7 @@
title: markdown2html | doc-utils
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[doc-utils](../)'
---
# markdown2html {#/}
@ -10,7 +10,7 @@ breadcrumb:
_todo_
- [Source Code {:external-link:}](https://gitea.jbrumond.me/doc-utils/markdown2html)
- [Building From Source](markdown2html/building-from-source.html)
- [Command Line Use](markdown2html/command-line-use.html)
- [Markdown Format](markdown2html/markdown-format.html)
- [Building From Source](./building-from-source.html)
- [Command Line Use](./command-line-use.html)
- [Markdown Format](./markdown-format.html)

View File

@ -2,20 +2,20 @@
title: Markdown Format | markdown2html | doc-utils
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[markdown2html](markdown2html/index.html)'
- '[doc-utils](../)'
- '[markdown2html](./)'
---
# Markdown Format {#/}
# Markdown Format
This document describes the extensions added on top of [Marked {:external-link:}](https://marked.js.org/) by [markdown2html].
<outline-inline content-root="#root > main"></outline-inline>
<outline-inline content-root="body > main"></outline-inline>
## KaTeX
## KaTeX {#katex}
Math typesetting can be done using [KaTeX {:external-link:}](https://katex.org/), wrapped in a back-tick-fenced block.
@ -45,7 +45,7 @@ $x$ to the second power is written as $x^2$
## Prism Highlighting
## Prism Highlighting {#prism}
[Prism {:external-link:}](https://prismjs.com/) is used to provide syntax highlighting for 290+ languages.
@ -82,7 +82,7 @@ function say_hello() {
## Feather Icons
## Feather Icons {#feather}
[Feather Icons {:external-link:}](https://feathericons.com/) can be rendered using tokens that look like `{:icon-name:}`.
@ -97,7 +97,7 @@ function say_hello() {
## Highlighting
## Highlighting {#highlight}
Text can be highlighted with the [`<mark>` tag {:external-link:}](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark) by wrapping it in double equals signs (`==`):
@ -115,7 +115,7 @@ This is some ==highlighted text==.
## Pikchr Diagrams
## Pikchr Diagrams {#pikchr}
[Pikchr {:external-link:}](https://pikchr.org/home/doc/trunk/homepage.md) can be used to render diagrams, which is also written using fenced blocks.
@ -171,7 +171,7 @@ The following color names are mapped to CSS variables to enable theming:
## nomnoml Diagrams
## nomnoml Diagrams {#nomnoml}
_todo_
@ -179,7 +179,7 @@ _todo_
## Bytefield Diagrams
## Bytefield Diagrams {#bytefield}
_todo_
@ -187,21 +187,21 @@ _todo_
## QR Codes
## QR Codes {#qr-codes}
_todo_
## Footnotes
## Footnotes {#footnotes}
_todo_
## Vega Charts
## Vega Charts {#vega}
_todo_
@ -210,7 +210,7 @@ _todo_
## Sample Output
## Sample Output {#samp}
Fenced blocks with the `samp` "language" tag output contents in a [`<samp>` {:external-link:}](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/samp) tag rather than the typical `<code>` tag, to more semantically markup output examples from code.
@ -250,7 +250,7 @@ This is another line of sample output
## Attribute Annotations
## Attribute Annotations {#attribute-annotations}
Some markdown elements allow for attributes to be appended in a curly-brace (`{ }`) wrapped block.
@ -272,6 +272,6 @@ The braces contain a space-delimeted list attributes to assign to the rendered a
[docs2website]: docs2website/index.html
[markdown2html]: markdown2html/index.html
[docs2website]: ../docs2website
[markdown2html]: ../markdown2html

View File

@ -3,6 +3,7 @@
<head>
<meta charset="UTF-8">
<title>{{ page.title }}</title>
<base href="{{{ page_url }}}">
<link rel="stylesheet" href="/_vendor/open-sans/open-sans-v34.css">
<link rel="stylesheet" href="/_vendor/katex/katex.min.css">
<link rel="stylesheet" href="/_assets/colors.css">
@ -20,7 +21,7 @@
<color-scheme-toggle-button></color-scheme-toggle-button>
{{# page.outline_button }}
<outline-button content-root="#root"></outline-button>
<outline-button content-root="body > main"></outline-button>
{{/ page.outline_button }}
{{> breadcrumb.html }}

View File

@ -3,6 +3,7 @@
<head>
<meta charset="UTF-8">
<title>{{ page.title }}</title>
<base href="{{{ page_url }}}">
<link rel="stylesheet" href="/_vendor/open-sans/open-sans-v34.css">
<link rel="stylesheet" href="/_vendor/katex/katex.min.css">
<link rel="stylesheet" href="/_assets/colors.css">

163
metadata.json Normal file
View File

@ -0,0 +1,163 @@
{
"last_build": {
"time": "2023-05-21T14:05:46.078-07:00",
"config_hash": "nMNkbiTmRQIzHx34srMn7f92meJx0AxbIEpTROsRZAehGNcOwfdEEajqLWNTH4lTdll82uyf7C4P95PVANcNAA=="
},
"files": {
"/_assets/structure.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "XtOPnd/zOEAr0DByWuvGfJyTHsdDIXTiZny5g2M2gItpdw/Ce8jaJ1hCMC72AIjkelYl1icrsqAfjNs6dtnn+A==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/theme-animation.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "wG/o3ApyPe2u15mZwpy5E+y5Koz5KZuhO2gyAZURxJiuX3qid7FBfpbIrhWDYEwc29R4mUIzuc2pyaBqSbW7dQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/prism.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "wULo4ZHx6x9XHCZVV0v1Jp9dZ/tP2UiGgp3S61FJsebGoWzQIty/DF2Oyoo5cuVn+3Sg21P5clcacbF9SL04nw==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/forms-inputs.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "vKON+tNIef2LVqhNv6IlMaHZW7gr40F7lbd9mLWYg9k0Kqrn1Nyon1Nf3t63hjNq/V6IAeV7+9svHCJqIiGj5g==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/figures.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "GWqAs7DM3p2pZe37WHjRTBvPs/ft77X7v8hLb6AjU3nwEoSwgqyhvXnHSycmfXKAiQj9745tHnnpVU7gSbfS4Q==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/extras.js": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "NH5RPkRjdvMpOm4QppT7blGPGdNK5b2J+cQ6Wsv22cmDfm3b7Tc9GeZn4qd5D+fTSoGoESNarEnN+sRV1ihrRA==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/colors.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "UteDx72dZXzdJcv/IO6dluhgiN9ddwTn1GDGek4F7cYPRYQv/RDD4cuI97/Yxf+89ykpoKcmHHqt6Tudxi1H8A==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/color-theme-preview.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "ggmN8fAn+W3ejVa+WjwgwCrqe/TD2lr3kmG77TUHrwDAuE8wOeWEmPV/YzhD9f57eYIA+ZHypp9s797CDjpbpA==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/breadcrumb.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "B3ajZA+BTRFIWfk6CA/Sa71n8MFp5GPB9TWsNLi0VrIV+N0hWiAJvSvnhV2BgHzRXooT1WWotLne7hgDi5qJcw==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_vendor/open-sans/open-sans-v34.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "8rNJHIlE33r84MLmf+pOCU68Lr1iZYUeFIpZ8d2xB4U3cEV/W1ejc/JStY/MXCxLSOURx5KdULaKiP1klKGoAQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_vendor/katex/katex.min.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "G8UulHEU5NrUOPdTBqGubYTPM7ttKLTY4rpzmVV0lgFx7aqKQivvpB3kGvvF3WNZjSV+kNxeEmg+m43Sbn9wAQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_vendor/katex/katex.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "U3FqiwZ1AZSmgLDvcjpJgtHKo2LibkSWmvXoxbKERaah573tk+GBT5bfxbB4mO4MzHweDHLVu3mPcF8EdrSHcg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_assets/typography.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "MxHis3f2M1SNxIKgeMVpqsKRS418LnFe3CuBjU6HE7hUn37SqE4ZSblZ0FL9CMNxaxdp+2Tpl35u5amSUWzsfg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/jsonschema2markdown/index.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/jsonschema2markdown/command-line-use.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/jsonschema2markdown/building-from-source.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_vendor/open-sans/readme.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "7fKSfAEAtZANkDic2ipTMW09A71bUJ10446GjrI9AAsDhsFEC0PhvQw5qFaci0CjTcL69EaqX2HzzHDE5KWmZg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/_vendor/katex/readme.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "EDosujqvo0rTZ0BnpWuGYrYT8CbyGUJs8/g/jCW0125ObETU/rNdCm9QCMuj+3oyrPKp3CrzalBRT18Rn9L7HA==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/jsonschema2markdown/programatic-use.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/markdown2html/index.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "IVJ7BVd9RqXGiZjl+57k9itDrZy6WIG/TjvkK/r7DqkIzlCIbABtyZfmdjVoFgdliJwSAwnMTFikbKqUV5w5zQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/markdown2html/building-from-source.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "Y0Gct7zFDfLxzXqRph3RjfZ7OjGu5s1cac/R4E1dG9XZiyDOiFYl6EA1EqCfM6qhBSoxcpIYNFP9+TXxo09GFw==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/docs2website/configuration.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "JrZ6FQGKils7nBmTtoBYvWoqe4AcFcggKQryAou4dZHbFUjLpUNk2mtZ1w3Q3cKRVLF+maLbFirOARAJbAbtwA==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/docs2website/index.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "U2kuTS/Nhdb0ybWkwr9b/tzHC4YWaBhfyW/dR1Ff3sBw4A4c6TBkigEv11xiQxFeWPODfT9QJoJm0fgF3zkQFg==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/docs2website/command-line-use.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "3wbDdc/xVE3jbepPs0YrMToj76lrmuO+W/K1GvOAcZdichO9fmQ38ZmxfWTYc3JZSrhhasBo6rgkhEAL6TsndQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/docs2website/building-from-source.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "nR+ORQrII8uVXBbNEZGWLTSR7lDW8faZlVK50WjZd9esf47rofpLoHSBABf77OKvFlrPD3RWyKVwIQaWC+U9VA==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/color-themes/index.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "WoozL+tkFJEEa628Snmjm80dzFv+zD/IwtPrAtXZY5537XCPi+B/gsW2zUBTUeCVoNb3JZQ8IWS7Pb9AQSdP3w==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/index.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "q8n6caIA/k02lNP6jj1PwwSwIEVc+esAAd822KwkT8fMsZ2zhP+rUhOKChmM5ogRo1bCtrCmUDwaI92tCzDb5A==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/docs2website/programatic-use.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "oy6eFcHsBwyhv8hI10jbmi392GGBgo5MsR68qP8wN7xu0ny+7BDUcJyp2KK28wwASnDd/zSOSgEx/9rmxG/O6w==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/markdown2html/markdown-format.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "v93fInLvyGUltDLds4BIbqFKplwm7wXDEN+eNY+hu93jzzsH7bZy6imdCghadsMoiQlkgBnn2Z28f71su65rBw==",
"last_updated_time": "2023-05-21T14:05:46.078-07:00"
},
"/color-themes/preview.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "zMiA4rvAFVXAI2fx6VCFXavfkZSuVxO7bH5hxIU79Tup8Q6lOjXrzT9CPsHYBuNajVDwZIPZ126fKiwM6TSNFQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
},
"/color-themes/schema/v1.yaml": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "MyQRY4hyW8/rFpWp7UukN+0rFWvO1Sr5z26i7v7u6jeBA15iJpgOZQRf8znaXDqTZgEp1YRtJ8WOAT7YlZqisQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00"
}
}
}