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

Compare commits

base: doc-utils:daac8a316c91516b19cbcfc7e01139211b32c1b4
Branches Tags
doc-utils:master
..
compare: doc-utils:d36f119365279cd53cb80fcb22dfca0f7b9e7531
Branches Tags
doc-utils:master

No commits in common. "daac8a316c91516b19cbcfc7e01139211b32c1b4" and "d36f119365279cd53cb80fcb22dfca0f7b9e7531" have entirely different histories.
daac8a316c ... d36f119365

9 changed files with 146 additions and 202 deletions
Show Stats Expand all files Collapse all files

234
.drone.yml
View File

@ -1,133 +1,133 @@
# --- ---
# kind: pipeline kind: pipeline
# type: kubernetes type: kubernetes
# name: build name: build
# trigger: trigger:
# event: [ push ] event: [ push ]
# branch: [ master ] branch: [ master ]
# platform: platform:
# os: linux os: linux
# arch: arm64 arch: arm64
# node_selector: node_selector:
# kubernetes.io/os: linux kubernetes.io/os: linux
# kubernetes.io/arch: arm64 kubernetes.io/arch: arm64
# steps: steps:
# - name: build-website - name: build-website
# image: gitea.home.jbrumond.me/doc-utils/utils:0.1.1 image: gitea.home.jbrumond.me/doc-utils/utils:0.1.1
# commands: commands:
# - docs2website config.yaml - docs2website config.yaml
# - name: build-docker - name: build-docker
# image: plugins/docker image: plugins/docker
# settings: settings:
# registry: https://gitea.home.jbrumond.me registry: https://gitea.home.jbrumond.me
# username: drone username: drone
# password: password:
# from_secret: gitea-jbrumond-me-password from_secret: gitea-jbrumond-me-password
# repo: gitea.home.jbrumond.me/doc-utils/docs repo: gitea.home.jbrumond.me/doc-utils/docs
# cache_from: gitea.home.jbrumond.me/doc-utils/docs:ci cache_from: gitea.home.jbrumond.me/doc-utils/docs:ci
# tags: tags:
# - ci - ci
# --- ---
# kind: pipeline kind: pipeline
# type: kubernetes type: kubernetes
# name: deploy-stg name: deploy-stg
# trigger: trigger:
# event: [ promote ] event: [ promote ]
# target: [ stg ] target: [ stg ]
# platform: platform:
# os: linux os: linux
# arch: arm64 arch: arm64
# node_selector: node_selector:
# kubernetes.io/os: linux kubernetes.io/os: linux
# kubernetes.io/arch: arm64 kubernetes.io/arch: arm64
# steps: steps:
# - name: build-website - name: build-website
# image: gitea.home.jbrumond.me/doc-utils/utils:0.1.1 image: gitea.home.jbrumond.me/doc-utils/utils:0.1.1
# commands: commands:
# - docs2website config.yaml - docs2website config.yaml
# - name: build-and-publish - name: build-and-publish
# image: plugins/docker image: plugins/docker
# settings: settings:
# registry: https://gitea.home.jbrumond.me registry: https://gitea.home.jbrumond.me
# username: drone username: drone
# password: password:
# from_secret: gitea-jbrumond-me-password from_secret: gitea-jbrumond-me-password
# repo: gitea.home.jbrumond.me/doc-utils/docs repo: gitea.home.jbrumond.me/doc-utils/docs
# cache_from: gitea.home.jbrumond.me/doc-utils/docs:ci cache_from: gitea.home.jbrumond.me/doc-utils/docs:ci
# build_args: build_args:
# - OS=linux - OS=linux
# - ARCH=arm64 - ARCH=arm64
# tags: tags:
# - stg - stg
# - name: deploy-stg - name: deploy-stg
# image: gitea.home.jbrumond.me/images/kubectl:1.24 image: gitea.home.jbrumond.me/images/kubectl:1.24
# pull: always pull: always
# environment: environment:
# KUBERNETES_SERVER: https://nephthys:6443 KUBERNETES_SERVER: https://nephthys:6443
# KUBERNETES_TOKEN: KUBERNETES_TOKEN:
# from_secret: kubernetes-web-ns-service-account-token from_secret: kubernetes-web-ns-service-account-token
# KUBERNETES_CERT: KUBERNETES_CERT:
# from_secret: kubernetes-web-ns-service-account-cert from_secret: kubernetes-web-ns-service-account-cert
# commands: commands:
# - /bin/kubectl-setup - /bin/kubectl-setup
# - kubectl -n web set image "deployment/doc-utils-stg-deploy" "doc-utils-stg=gitea.home.jbrumond.me/doc-utils/docs:stg" - kubectl -n web set image "deployment/doc-utils-stg-deploy" "doc-utils-stg=gitea.home.jbrumond.me/doc-utils/docs:stg"
# - kubectl -n web rollout restart "deployment/doc-utils-stg-deploy" - kubectl -n web rollout restart "deployment/doc-utils-stg-deploy"
# - kubectl -n web rollout status "deployment/doc-utils-stg-deploy" - kubectl -n web rollout status "deployment/doc-utils-stg-deploy"
# --- ---
# kind: pipeline kind: pipeline
# type: kubernetes type: kubernetes
# name: deploy-prod name: deploy-prod
# trigger: trigger:
# event: [ promote ] event: [ promote ]
# target: [ prod ] target: [ prod ]
# steps: steps:
# - name: tag-image - name: tag-image
# image: gitea.home.jbrumond.me/images/docker image: gitea.home.jbrumond.me/images/docker
# pull: always pull: always
# volumes: volumes:
# - name: dockersock - name: dockersock
# path: /var/run/ path: /var/run/
# environment: environment:
# DOCKER_REGISTRY: https://gitea.home.jbrumond.me DOCKER_REGISTRY: https://gitea.home.jbrumond.me
# DOCKER_USER: drone DOCKER_USER: drone
# DOCKER_PASS: DOCKER_PASS:
# from_secret: gitea-jbrumond-me-password from_secret: gitea-jbrumond-me-password
# commands: commands:
# - /bin/docker-setup - /bin/docker-setup
# - docker pull gitea.home.jbrumond.me/doc-utils/docs:stg - docker pull gitea.home.jbrumond.me/doc-utils/docs:stg
# - docker tag gitea.home.jbrumond.me/doc-utils/docs:stg gitea.home.jbrumond.me/doc-utils/docs:prod - docker tag gitea.home.jbrumond.me/doc-utils/docs:stg gitea.home.jbrumond.me/doc-utils/docs:prod
# - docker push gitea.home.jbrumond.me/doc-utils/docs:prod - docker push gitea.home.jbrumond.me/doc-utils/docs:prod
# - name: deploy-prod - name: deploy-prod
# image: gitea.home.jbrumond.me/images/kubectl:1.24 image: gitea.home.jbrumond.me/images/kubectl:1.24
# pull: always pull: always
# environment: environment:
# KUBERNETES_SERVER: https://nephthys:6443 KUBERNETES_SERVER: https://nephthys:6443
# KUBERNETES_TOKEN: KUBERNETES_TOKEN:
# from_secret: kubernetes-web-ns-service-account-token from_secret: kubernetes-web-ns-service-account-token
# KUBERNETES_CERT: KUBERNETES_CERT:
# from_secret: kubernetes-web-ns-service-account-cert from_secret: kubernetes-web-ns-service-account-cert
# commands: commands:
# - /bin/kubectl-setup - /bin/kubectl-setup
# - kubectl -n web set image "deployment/doc-utils-prod-deploy" "doc-utils-prod=gitea.home.jbrumond.me/doc-utils/docs:prod" - kubectl -n web set image "deployment/doc-utils-prod-deploy" "doc-utils-prod=gitea.home.jbrumond.me/doc-utils/docs:prod"
# - kubectl -n web rollout restart "deployment/doc-utils-prod-deploy" - kubectl -n web rollout restart "deployment/doc-utils-prod-deploy"
# - kubectl -n web rollout status "deployment/doc-utils-prod-deploy" - kubectl -n web rollout status "deployment/doc-utils-prod-deploy"
# volumes: volumes:
# - name: dockersock - name: dockersock
# host: host:
# path: /var/run/ path: /var/run/

1
Dockerfile
View File

@ -7,7 +7,6 @@ WORKDIR /workspace
# build website from source files # build website from source files
COPY docs layouts partials config.yaml metadata.json /workspace/ COPY docs layouts partials config.yaml metadata.json /workspace/
RUN mkdir /workspace/www
RUN docs2website config.yaml RUN docs2website config.yaml

2
config.yaml
View File

@ -1,7 +1,7 @@
metadata: ./metadata.json metadata: ./metadata.json
base_url: http://localhost:46137 base_url: http://localhost:8000
# Input Configuration (where your documents are) # Input Configuration (where your documents are)
input: input:

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

@ -14,7 +14,4 @@ Command line use is very straight-forward, as there is only one valid way to cal
docs2website <config file> docs2website <config file>
``` ```
## Parameters The `<config file>` parameter should refer to a file containing [the configuration](./configuration.html) to build with.
: `<config file>`
: File path to the file containing [build configuration](./configuration.html)

2
docs/docs2website/index.md
View File

@ -13,7 +13,7 @@ The docs2website project is a static site generator primarily focused on technic
- [Configuration](./configuration.html) - [Configuration](./configuration.html)
- [Command Line Use](./command-line-use.html) - [Command Line Use](./command-line-use.html)
- [Programatic Use](./programatic-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) - [Source Code {:external-link:}](https://gitea.jbrumond.me/doc-utils/docs2website)

2
docs/index.md
View File

@ -3,7 +3,7 @@ title: doc-utils
layout: main.html layout: main.html
--- ---
# doc-utils # doc-utils {#-}
Documentation for the doc-utils projects. Documentation for the doc-utils projects.

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

@ -81,60 +81,6 @@ 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} ## Feather Icons {#feather}

2
layouts/preview-color-themes.html
View File

@ -122,6 +122,7 @@
</script> </script>
</header> </header>
<div id="root">
{{> breadcrumb.html }} {{> breadcrumb.html }}
<main> <main>
@ -132,6 +133,7 @@
<p class="left">Built with docs2website at <time datetime="{{ build_time.iso }}">{{ build_time.rfc2822 }}</time></p> <p class="left">Built with docs2website at <time datetime="{{ build_time.iso }}">{{ build_time.rfc2822 }}</time></p>
<p class="right">Copyright 2023 James Brumond</p> <p class="right">Copyright 2023 James Brumond</p>
</footer> </footer>
</div>
</body> </body>
</html> </html>

46
metadata.json
View File

@ -1,22 +1,17 @@
{ {
"last_build": { "last_build": {
"time": "2023-05-27T18:14:11.014-07:00", "time": "2023-05-21T14:05:46.078-07:00",
"config_hash": "iZVIBu7zTewWsPUbEDMgC+ROqW2Q9n0cmgGuBh93jjvm/M2B3QjsdN6cYsSZ0yO4xx5Sk2wrcOkpQJp1Urq0Fg==" "config_hash": "nMNkbiTmRQIzHx34srMn7f92meJx0AxbIEpTROsRZAehGNcOwfdEEajqLWNTH4lTdll82uyf7C4P95PVANcNAA=="
}, },
"files": { "files": {
"/_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/structure.css": { "/_assets/structure.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "XtOPnd/zOEAr0DByWuvGfJyTHsdDIXTiZny5g2M2gItpdw/Ce8jaJ1hCMC72AIjkelYl1icrsqAfjNs6dtnn+A==", "last_build_hash": "XtOPnd/zOEAr0DByWuvGfJyTHsdDIXTiZny5g2M2gItpdw/Ce8jaJ1hCMC72AIjkelYl1icrsqAfjNs6dtnn+A==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00" "last_updated_time": "2023-05-19T00:06:52.103-07:00"
}, },
"/_assets/forms-inputs.css": { "/_assets/theme-animation.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "vKON+tNIef2LVqhNv6IlMaHZW7gr40F7lbd9mLWYg9k0Kqrn1Nyon1Nf3t63hjNq/V6IAeV7+9svHCJqIiGj5g==", "last_build_hash": "wG/o3ApyPe2u15mZwpy5E+y5Koz5KZuhO2gyAZURxJiuX3qid7FBfpbIrhWDYEwc29R4mUIzuc2pyaBqSbW7dQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00" "last_updated_time": "2023-05-19T00:06:52.103-07:00"
}, },
"/_assets/prism.css": { "/_assets/prism.css": {
@ -24,6 +19,11 @@
"last_build_hash": "wULo4ZHx6x9XHCZVV0v1Jp9dZ/tP2UiGgp3S61FJsebGoWzQIty/DF2Oyoo5cuVn+3Sg21P5clcacbF9SL04nw==", "last_build_hash": "wULo4ZHx6x9XHCZVV0v1Jp9dZ/tP2UiGgp3S61FJsebGoWzQIty/DF2Oyoo5cuVn+3Sg21P5clcacbF9SL04nw==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00" "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": { "/_assets/figures.css": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "GWqAs7DM3p2pZe37WHjRTBvPs/ft77X7v8hLb6AjU3nwEoSwgqyhvXnHSycmfXKAiQj9745tHnnpVU7gSbfS4Q==", "last_build_hash": "GWqAs7DM3p2pZe37WHjRTBvPs/ft77X7v8hLb6AjU3nwEoSwgqyhvXnHSycmfXKAiQj9745tHnnpVU7gSbfS4Q==",
@ -109,20 +109,20 @@
"last_build_hash": "Y0Gct7zFDfLxzXqRph3RjfZ7OjGu5s1cac/R4E1dG9XZiyDOiFYl6EA1EqCfM6qhBSoxcpIYNFP9+TXxo09GFw==", "last_build_hash": "Y0Gct7zFDfLxzXqRph3RjfZ7OjGu5s1cac/R4E1dG9XZiyDOiFYl6EA1EqCfM6qhBSoxcpIYNFP9+TXxo09GFw==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00" "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": "oGqQtPmVdLea18qkpFrA6XayZd6IFrlesgoo9bxzgx+ibbMK4cJ//jsQyPGRc6QuW2daJZS2gnPo4QygHh65vA==",
"last_updated_time": "2023-05-27T17:50:24.808-07:00"
},
"/docs2website/configuration.md": { "/docs2website/configuration.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "JrZ6FQGKils7nBmTtoBYvWoqe4AcFcggKQryAou4dZHbFUjLpUNk2mtZ1w3Q3cKRVLF+maLbFirOARAJbAbtwA==", "last_build_hash": "JrZ6FQGKils7nBmTtoBYvWoqe4AcFcggKQryAou4dZHbFUjLpUNk2mtZ1w3Q3cKRVLF+maLbFirOARAJbAbtwA==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00" "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": { "/docs2website/command-line-use.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "8eN9+TPZCdHz8zvZFRHZOIKOTkc3jGt/vaXTmlJNwKMYVw14eQB5MYn/DwEDUkg5X5vtAKNO6knlfdsyv5ODuA==", "last_build_hash": "3wbDdc/xVE3jbepPs0YrMToj76lrmuO+W/K1GvOAcZdichO9fmQ38ZmxfWTYc3JZSrhhasBo6rgkhEAL6TsndQ==",
"last_updated_time": "2023-05-27T17:48:44.437-07:00" "last_updated_time": "2023-05-19T00:06:52.103-07:00"
}, },
"/docs2website/building-from-source.md": { "/docs2website/building-from-source.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
@ -136,24 +136,24 @@
}, },
"/index.md": { "/index.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "7/5Kwma++r3MFm7KET9N4E2+f5Fbm/LPZoZLIakt6Tj68WnjQ0ygx1kmOuLaqhq5hlFtyvUmqUWVfvt4QhT3+A==", "last_build_hash": "q8n6caIA/k02lNP6jj1PwwSwIEVc+esAAd822KwkT8fMsZ2zhP+rUhOKChmM5ogRo1bCtrCmUDwaI92tCzDb5A==",
"last_updated_time": "2023-05-27T17:55:56.863-07:00" "last_updated_time": "2023-05-19T00:06:52.103-07:00"
}, },
"/docs2website/programatic-use.md": { "/docs2website/programatic-use.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "oy6eFcHsBwyhv8hI10jbmi392GGBgo5MsR68qP8wN7xu0ny+7BDUcJyp2KK28wwASnDd/zSOSgEx/9rmxG/O6w==", "last_build_hash": "oy6eFcHsBwyhv8hI10jbmi392GGBgo5MsR68qP8wN7xu0ny+7BDUcJyp2KK28wwASnDd/zSOSgEx/9rmxG/O6w==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00" "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": { "/color-themes/preview.md": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "zMiA4rvAFVXAI2fx6VCFXavfkZSuVxO7bH5hxIU79Tup8Q6lOjXrzT9CPsHYBuNajVDwZIPZ126fKiwM6TSNFQ==", "last_build_hash": "zMiA4rvAFVXAI2fx6VCFXavfkZSuVxO7bH5hxIU79Tup8Q6lOjXrzT9CPsHYBuNajVDwZIPZ126fKiwM6TSNFQ==",
"last_updated_time": "2023-05-19T00:06:52.103-07:00" "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": "i/quZAVVMVDaTsq44d4eezoddkUsRCdydU609LkbMqEt1397zHsix2e1AMM4D+Lgzxxk6JIhqX1fSOO/1+3VKw==",
"last_updated_time": "2023-05-27T18:14:11.014-07:00"
},
"/color-themes/schema/v1.yaml": { "/color-themes/schema/v1.yaml": {
"first_seen_time": "2023-05-19T00:06:52.103-07:00", "first_seen_time": "2023-05-19T00:06:52.103-07:00",
"last_build_hash": "MyQRY4hyW8/rFpWp7UukN+0rFWvO1Sr5z26i7v7u6jeBA15iJpgOZQRf8znaXDqTZgEp1YRtJ8WOAT7YlZqisQ==", "last_build_hash": "MyQRY4hyW8/rFpWp7UukN+0rFWvO1Sr5z26i7v7u6jeBA15iJpgOZQRf8znaXDqTZgEp1YRtJ8WOAT7YlZqisQ==",