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

updates to breadcrumbs; start working on deploy setup

Browse Source
This commit is contained in:
James Brumond
2023-05-13 21:11:59 -07:00
parent 9391a42718
commit 9437d80106
19 changed files with 402 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/_assets/base.css
View File

@@ -257,8 +257,6 @@ body[data-color-transition-enabled] :is(
padding: 1rem;
padding-block-end: 5rem;
z-index: 1;
max-width: 100rem;
margin-inline: auto;
}
@media screen and (min-width: 60rem) {
@@ -273,6 +271,12 @@ body[data-color-transition-enabled] :is(
}
}
#root > nav,
#root > main {
max-width: 100rem;
margin-inline: auto;
}
@@ -1148,10 +1152,12 @@ figure[data-size='small'] svg {
figure[data-size='medium'] svg {
max-width: 60rem;
max-height: min(40rem, 50vw);
margin-block-start: 4rem;
}
figure[data-size='large'] svg {
max-height: min(60rem, 80vw);
margin-block-start: 6rem;
}
/* figure[data-lang].big {

16
docs/_assets/colors.css
View File

@@ -20,3 +20,19 @@ body[data-color-scheme='dark'] {
{{> .themes/Minimal Light }}
}
}
/* todo: switch from having 2 themes (above) to 4 themes (below) */
@media (prefers-contrast: no-preference) {
/* todo: default themes */
}
@media (prefers-contrast: more) {
/* todo: high contrast themes */
}
@media (prefers-contrast: less) {
/* todo: low contrast themes */
}

6
docs/color-themes/index.md
View File

@@ -1,12 +1,10 @@
---
title: Color Themes | doc-utils
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
---
///
[doc-utils](index.html)
///
# Color Themes {#/}
_todo_

8
docs/docs2website/building-from-source.md
View File

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

8
docs/docs2website/command-line-use.md
View File

@@ -1,13 +1,11 @@
---
title: Command Line Use | docs2website
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[docs2website](docs2website/index.html)'
---
///
[doc-utils](index.html)
[docs2website](docs2website/index.html)
///
# Command Line Use {#/}
Command line use is very straight-forward, as there is only one valid way to call the command:

8
docs/docs2website/configuration.md
View File

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

6
docs/docs2website/index.md
View File

@@ -1,12 +1,10 @@
---
title: docs2website
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
---
///
[doc-utils](index.html)
///
# docs2website {#/}
The [docs2website] project is a static site generator primarily focused on technical writing and documentation.

8
docs/docs2website/programatic-use.md
View File

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

4
docs/index.md
View File

@@ -3,7 +3,7 @@ title: doc-utils
layout: main.html
---
# doc-utils {#/}
# doc-utils {#-}
Documentation for the doc-utils projects.
@@ -57,7 +57,7 @@ ETC: box "Etc..." same \
dashed
MD: box "Markdown" same as JSCH \
at 2.5 east of CSBOM \
at 3 east of CSBOM \
color yellow fill yellow
HTML: box "HTML Fragments" same \

8
docs/markdown2html/building-from-source.md
View File

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

6
docs/markdown2html/index.md
View File

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

32
docs/markdown2html/markdown-format.md
View File

@@ -1,13 +1,11 @@
---
title: Markdown Format | markdown2html | doc-utils
layout: main.html
breadcrumb:
- '[doc-utils](index.html)'
- '[markdown2html](markdown2html/index.html)'
---
///
[doc-utils](index.html)
[markdown2html](markdown2html/index.html)
///
# Markdown Format {#/}
This document describes the extensions added on top of [Marked {:external-link:}](https://marked.js.org/) by [markdown2html].
@@ -211,30 +209,6 @@ _todo_
## Breadcrumb Navigation
_todo_
```md
///
[Foo](#foo)
[Bar](#bar)
[Baz](#baz)
///
```
!!! {.markdown-example-output}
///
[Foo](#foo)
[Bar](#bar)
[Baz](#baz)
///
!!!
## Sample Output