Compare commits
9 Commits
v0.6.0
...
e169778c82
Author | SHA1 | Date | |
---|---|---|---|
e169778c82 | |||
c838bfe815 | |||
e81a5def47 | |||
18884c640d | |||
ee2256bfb2 | |||
82d79c520a | |||
c30ae2ac3e | |||
fc738597ff | |||
aebef21eb4 |
@ -1,15 +1,11 @@
|
|||||||
steps:
|
steps:
|
||||||
build:
|
build:
|
||||||
image: klakegg/hugo:ext-debian-ci
|
image: hugomods/hugo:ci
|
||||||
commands:
|
commands:
|
||||||
- git submodule foreach 'git fetch origin; git checkout $(git describe --tags `git rev-list --tags --max-count=1`);'
|
- git submodule foreach 'git fetch origin; git checkout $(git describe --tags `git rev-list --tags --max-count=1`);'
|
||||||
- cd docs
|
- cd docs
|
||||||
- hugo mod get -u ./...
|
- hugo mod get -u ./...
|
||||||
- hugo
|
- hugo
|
||||||
when:
|
|
||||||
- event: push
|
|
||||||
branch: master
|
|
||||||
path: "docs/*"
|
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
image: codingkoopa/git-rsync-openssh
|
image: codingkoopa/git-rsync-openssh
|
||||||
@ -28,7 +24,5 @@ steps:
|
|||||||
- rsync -atv --delete --progress vangen/ backy@backy.cybershell.xyz:vangen-go
|
- rsync -atv --delete --progress vangen/ backy@backy.cybershell.xyz:vangen-go
|
||||||
secrets: [ ssh_host_key, ssh_deploy_key, ssh_passphrase ]
|
secrets: [ ssh_host_key, ssh_deploy_key, ssh_passphrase ]
|
||||||
|
|
||||||
when:
|
when:
|
||||||
- event: push
|
- branch: master
|
||||||
branch: master
|
|
||||||
path: "docs/*"
|
|
@ -6,6 +6,11 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
|
|||||||
and is generated by [Changie](https://github.com/miniscruff/changie).
|
and is generated by [Changie](https://github.com/miniscruff/changie).
|
||||||
|
|
||||||
|
|
||||||
|
## v0.6.0 - 2025-01-04
|
||||||
|
### Added
|
||||||
|
* Command Type Package - allows one to perform package operations [docs](https://backy.cybershell.xyz/config/packages/)
|
||||||
|
* Exec subcommand `host` allows for parallel execution of commands on hosts. [See docs](https://backy.cybershell.xyz/cli/exec)
|
||||||
|
|
||||||
## v0.5.0 - 2024-11-19
|
## v0.5.0 - 2024-11-19
|
||||||
### Added
|
### Added
|
||||||
* Lists can now go in a file. See docs for more information.
|
* Lists can now go in a file. See docs for more information.
|
||||||
|
137
docs/config.toml
137
docs/config.toml
@ -1,137 +0,0 @@
|
|||||||
baseURL = 'http://backy.cybershell.xyz/'
|
|
||||||
languageCode = 'en-us'
|
|
||||||
title = 'A tool for commands'
|
|
||||||
|
|
||||||
# Change the default theme to be use when building the site with Hugo
|
|
||||||
theme = [ "hugo-theme-relearn", "plausible-hugo"] # Add this theme to your already existing other themes
|
|
||||||
|
|
||||||
# For search functionality
|
|
||||||
[outputs]
|
|
||||||
home = [ "HTML", "RSS", "PRINT"]
|
|
||||||
|
|
||||||
[module]
|
|
||||||
[[module.imports]]
|
|
||||||
path = "github.com/divinerites/plausible-hugo"
|
|
||||||
|
|
||||||
[params]
|
|
||||||
# This controls whether submenus will be expanded (true), or collapsed (false) in the
|
|
||||||
# menu; if no setting is given, the first menu level is set to false, all others to true;
|
|
||||||
# this can be overridden in the pages frontmatter
|
|
||||||
alwaysopen = false
|
|
||||||
# Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.
|
|
||||||
# Useful to give opportunity to people to create merge request for your doc.
|
|
||||||
# See the config.toml file from this documentation site to have an example.
|
|
||||||
editURL = ""
|
|
||||||
# Description of the site, will be used in meta information
|
|
||||||
description = ""
|
|
||||||
# Shows a checkmark for visited pages on the menu
|
|
||||||
showVisitedLinks = false
|
|
||||||
# Disable search function. It will hide search bar
|
|
||||||
disableSearch = false
|
|
||||||
# Disable search in hidden pages, otherwise they will be shown in search box
|
|
||||||
disableSearchHiddenPages = false
|
|
||||||
# Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines
|
|
||||||
disableSeoHiddenPages = false
|
|
||||||
# Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden
|
|
||||||
disableTagHiddenPages = false
|
|
||||||
# Javascript and CSS cache are automatically busted when new version of site is generated.
|
|
||||||
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
|
|
||||||
disableAssetsBusting = false
|
|
||||||
# Set this to true if you want to disable generation for generator version meta tags of hugo and the theme;
|
|
||||||
# don't forget to also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into your home page
|
|
||||||
disableGeneratorVersion = false
|
|
||||||
# Set this to true to disable copy-to-clipboard button for inline code.
|
|
||||||
disableInlineCopyToClipBoard = false
|
|
||||||
# A title for shortcuts in menu is set by default. Set this to true to disable it.
|
|
||||||
disableShortcutsTitle = false
|
|
||||||
# If set to false, a Home button will appear below the search bar on the menu.
|
|
||||||
# It is redirecting to the landing page of the current language if specified. (Default is "/")
|
|
||||||
disableLandingPageButton = true
|
|
||||||
# When using mulitlingual website, disable the switch language button.
|
|
||||||
disableLanguageSwitchingButton = false
|
|
||||||
# Hide breadcrumbs in the header and only show the current page title
|
|
||||||
disableBreadcrumb = true
|
|
||||||
# If set to true, hide table of contents menu in the header of all pages
|
|
||||||
disableToc = false
|
|
||||||
# If set to false, load the MathJax module on every page regardless if a MathJax shortcode is present
|
|
||||||
math = true
|
|
||||||
# Specifies the remote location of the MathJax js
|
|
||||||
customMathJaxURL = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
|
|
||||||
# Initialization parameter for MathJax, see MathJax documentation
|
|
||||||
mathJaxInitialize = "{}"
|
|
||||||
# If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present
|
|
||||||
mermaid = true
|
|
||||||
# Specifies the remote location of the Mermaid js
|
|
||||||
customMermaidURL = "https://unpkg.com/mermaid/dist/mermaid.min.js"
|
|
||||||
# Initialization parameter for Mermaid, see Mermaid documentation
|
|
||||||
mermaidInitialize = "{ \"theme\": \"default\" }"
|
|
||||||
# If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present
|
|
||||||
disableSwagger = false
|
|
||||||
# Specifies the remote location of the RapiDoc js
|
|
||||||
customSwaggerURL = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
|
|
||||||
# Initialization parameter for Swagger, see RapiDoc documentation
|
|
||||||
swaggerInitialize = "{ \"theme\": \"light\" }"
|
|
||||||
# Hide Next and Previous page buttons normally displayed full height beside content
|
|
||||||
disableNextPrev = true
|
|
||||||
# Order sections in menu by "weight" or "title". Default to "weight";
|
|
||||||
# this can be overridden in the pages frontmatter
|
|
||||||
ordersectionsby = "weight"
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
auto = []
|
|
||||||
identifier = 'relearn-auto'
|
|
||||||
name = 'Relearn Light/Dark'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
identifier = 'relearn-light'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
identifier = 'relearn-dark'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
identifier = 'relearn-bright'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
auto = ['zen-light', 'zen-dark']
|
|
||||||
identifier = 'zen-auto'
|
|
||||||
name = 'Zen Light/Dark'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
identifier = 'zen-light'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
identifier = 'zen-dark'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
auto = ['learn', 'neon']
|
|
||||||
identifier = 'retro-auto'
|
|
||||||
name = 'Retro Learn/Neon'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
identifier = 'neon'
|
|
||||||
|
|
||||||
[[params.themeVariant]]
|
|
||||||
identifier = 'learn'
|
|
||||||
# Change the title separator. Default to "::".
|
|
||||||
titleSeparator = "-"
|
|
||||||
# If set to true, the menu in the sidebar will be displayed in a collapsible tree view. Although the functionality works with old browsers (IE11), the display of the expander icons is limited to modern browsers
|
|
||||||
collapsibleMenu = true
|
|
||||||
# If a single page can contain content in multiple languages, add those here
|
|
||||||
additionalContentLanguage = [ "en" ]
|
|
||||||
# If set to true, no index.html will be appended to prettyURLs; this will cause pages not
|
|
||||||
# to be servable from the file system
|
|
||||||
disableExplicitIndexURLs = false
|
|
||||||
# For external links you can define how they are opened in your browser; this setting will only be applied to the content area but not the shortcut menu
|
|
||||||
externalLinkTarget = "_blank"
|
|
||||||
# Author of the site, will be used in meta information
|
|
||||||
[params.author]
|
|
||||||
name = "Andrew Woodlee"
|
|
||||||
|
|
||||||
|
|
||||||
[params.plausible]
|
|
||||||
enable = true # Whether to enable plausible tracking
|
|
||||||
domain = "backy.cybershell.xyz" # Plausible "domain" name/id in your dashboard
|
|
||||||
outbound_link = true
|
|
||||||
gitstar = false
|
|
||||||
selfhosted_domain = "stats.andrewnw.com" # Self-hosted plausible domain
|
|
||||||
|
|
78
docs/config.yaml
Normal file
78
docs/config.yaml
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
baseURL: https://backy.cybershell.xyz/
|
||||||
|
languageCode: en-us
|
||||||
|
title: A tool for commands
|
||||||
|
theme:
|
||||||
|
- hugo-theme-relearn
|
||||||
|
- plausible-hugo
|
||||||
|
outputs:
|
||||||
|
home:
|
||||||
|
- HTML
|
||||||
|
- RSS
|
||||||
|
- PRINT
|
||||||
|
module:
|
||||||
|
imports:
|
||||||
|
- path: github.com/divinerites/plausible-hugo
|
||||||
|
- path: github.com/McShelby/hugo-theme-relearn
|
||||||
|
params:
|
||||||
|
themeVariant:
|
||||||
|
- auto: []
|
||||||
|
identifier: relearn-auto
|
||||||
|
name: Relearn Light/Dark
|
||||||
|
- identifier: relearn-light
|
||||||
|
- identifier: relearn-dark
|
||||||
|
- identifier: relearn-bright
|
||||||
|
- auto:
|
||||||
|
- zen-light
|
||||||
|
- zen-dark
|
||||||
|
identifier: zen-auto
|
||||||
|
name: Zen Light/Dark
|
||||||
|
- identifier: zen-light
|
||||||
|
- identifier: zen-dark
|
||||||
|
- auto:
|
||||||
|
- learn
|
||||||
|
- neon
|
||||||
|
identifier: retro-auto
|
||||||
|
name: Retro Learn/Neon
|
||||||
|
- identifier: neon
|
||||||
|
- identifier: learn
|
||||||
|
plausible:
|
||||||
|
enable: true
|
||||||
|
domain: backy.cybershell.xyz
|
||||||
|
outbound_link: true
|
||||||
|
gitstar: false
|
||||||
|
selfhosted_domain: stats.andrewnw.com
|
||||||
|
author:
|
||||||
|
name: Andrew Woodlee
|
||||||
|
alwaysopen: false
|
||||||
|
editURL: ""
|
||||||
|
description: ""
|
||||||
|
showVisitedLinks: false
|
||||||
|
disableSearch: false
|
||||||
|
disableSearchHiddenPages: false
|
||||||
|
disableSeoHiddenPages: false
|
||||||
|
disableTagHiddenPages: false
|
||||||
|
disableAssetsBusting: false
|
||||||
|
disableGeneratorVersion: false
|
||||||
|
disableInlineCopyToClipBoard: false
|
||||||
|
disableShortcutsTitle: false
|
||||||
|
disableLandingPageButton: true
|
||||||
|
disableLanguageSwitchingButton: false
|
||||||
|
disableBreadcrumb: true
|
||||||
|
disableToc: false
|
||||||
|
math: true
|
||||||
|
customMathJaxURL: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
|
||||||
|
mathJaxInitialize: "{}"
|
||||||
|
mermaid: true
|
||||||
|
customMermaidURL: https://unpkg.com/mermaid/dist/mermaid.min.js
|
||||||
|
mermaidInitialize: '{ "theme": "default" }'
|
||||||
|
disableSwagger: false
|
||||||
|
customSwaggerURL: https://unpkg.com/rapidoc/dist/rapidoc-min.js
|
||||||
|
swaggerInitialize: '{ "theme": "light" }'
|
||||||
|
disableNextPrev: true
|
||||||
|
ordersectionsby: weight
|
||||||
|
titleSeparator: "-"
|
||||||
|
collapsibleMenu: true
|
||||||
|
additionalContentLanguage:
|
||||||
|
- en
|
||||||
|
disableExplicitIndexURLs: false
|
||||||
|
externalLinkTarget: _blank
|
@ -17,6 +17,10 @@ Feel free to open a [PR](https://git.andrewnw.xyz/CyberShell/backy/pulls), raise
|
|||||||
|
|
||||||
- Allows easy configuration of executable commands
|
- Allows easy configuration of executable commands
|
||||||
|
|
||||||
|
- Allows for running package operations
|
||||||
|
|
||||||
|
- Allows configuring failure, success, and final hooks
|
||||||
|
|
||||||
- Allows for commands to be run on many hosts over SSH
|
- Allows for commands to be run on many hosts over SSH
|
||||||
|
|
||||||
- Commands can be grouped in list to run in specific order
|
- Commands can be grouped in list to run in specific order
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
title: Exec
|
title: Exec
|
||||||
---
|
---
|
||||||
|
|
||||||
The `exec` subcommand can do somethings that the configuration file can't do yet. The command `exec host` can execute commands on many hosts.
|
The `exec` subcommand can do some things that the configuration file can't do yet. The command `exec host` can execute commands on many hosts.
|
||||||
|
|
||||||
`exec host` takes the following arguments:
|
`exec host` takes the following arguments:
|
||||||
|
|
||||||
|
@ -3,6 +3,6 @@ module git.andrewnw.xyz/CyberShell/backy/docs
|
|||||||
go 1.19
|
go 1.19
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d // indirect
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa // indirect
|
||||||
github.com/divinerites/plausible-hugo v1.21.1 // indirect
|
github.com/divinerites/plausible-hugo v1.21.1 // indirect
|
||||||
)
|
)
|
||||||
|
@ -1,4 +1,10 @@
|
|||||||
github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d h1:weq1mrQ/qNAvGrNgvZVL1K8adbT3bswZf2ABLr/LCIA=
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d h1:weq1mrQ/qNAvGrNgvZVL1K8adbT3bswZf2ABLr/LCIA=
|
||||||
github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
|
||||||
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20241210183303-16d4de84becf h1:bMx4kwM7Q+dAzvSOWs3XWZ25o+n4mI0GPHqzbzeWb3M=
|
||||||
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20241210183303-16d4de84becf/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
|
||||||
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20250102210630-dd0597ffa4b2 h1:sWaC1/dL65v3iRvblEAaBLpKC5TIT0R9JASk1hZNET8=
|
||||||
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20250102210630-dd0597ffa4b2/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
|
||||||
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa h1:G+OnMEzK4XOzbbcf1SmaGyOYJ0h5idp/IJdguWs8ioU=
|
||||||
|
github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
|
||||||
github.com/divinerites/plausible-hugo v1.21.1 h1:ZTWwjhZ0PmLMacCVGlcGiYFEZW7VaYE767tchDskOug=
|
github.com/divinerites/plausible-hugo v1.21.1 h1:ZTWwjhZ0PmLMacCVGlcGiYFEZW7VaYE767tchDskOug=
|
||||||
github.com/divinerites/plausible-hugo v1.21.1/go.mod h1:cxr+YB3FUwbLon8KCs4pV4Ankbkq6lJxTQUpNb5KqPo=
|
github.com/divinerites/plausible-hugo v1.21.1/go.mod h1:cxr+YB3FUwbLon8KCs4pV4Ankbkq6lJxTQUpNb5KqPo=
|
||||||
|
1
docs/themes/hugo-theme-relearn
vendored
Submodule
1
docs/themes/hugo-theme-relearn
vendored
Submodule
Submodule docs/themes/hugo-theme-relearn added at 80e448e5bd
Reference in New Issue
Block a user