doc-utils/docs
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
James Brumond
2023-05-21 14:36:08 -07:00
parent 244585daba
commit 52a9a52abc
16 changed files with 237 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/color-themes/index.md
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)

4
docs/color-themes/preview.md
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

4
docs/color-themes/schema/v1.yaml
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

4
docs/docs2website/building-from-source.md
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 {#/}

8
docs/docs2website/command-line-use.md
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.

6
docs/docs2website/configuration.md
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_

15
docs/docs2website/index.md
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

6
docs/docs2website/programatic-use.md
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_

26
docs/index.md
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

4
docs/markdown2html/building-from-source.md
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 {#/}

8
docs/markdown2html/index.md
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)

36
docs/markdown2html/markdown-format.md
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