cybercyst/carapace-bin
1
0
Fork 0
mirror of https://github.com/rsteube/carapace-bin.git synced 2025-05-05 15:32:53 +00:00
Code Issues Projects Releases Wiki Activity

doc: opengraph postprocessor

Browse Source
This commit is contained in:
rsteube 2024-12-15 13:59:34 +01:00
parent 4153ccc7a6
commit a5ad6f6384
4 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/go.yml vendored
View File

@ -81,6 +81,7 @@ jobs:
mdbook build docs
sh .github/badge.sh > docs/book/badge.svg
sh .github/macros-badge.sh > docs/book/macros-badge.svg
sh docs/postprocessor/opengraph.sh
- name: "push gh-pages"
if: github.ref == 'refs/heads/master'

2
docs/book.toml
View File

@ -4,7 +4,7 @@ language = "en"
multilingual = false
src = "src"
title = "carapace-bin"
description = "A multi-shell multi-command completion binary. Supports Bash, Elvish, Fish, Nushell, Oil, Powershell, Xonsh and Zsh."
description = "A multi-shell completion binary."
[output.html]
default-theme = "Latte"

10
docs/postprocessor/opengraph.sh Normal file
View File

@ -0,0 +1,10 @@
#!/bin/bash
set -e pipefail
cd "$(dirname "$(readlink -f "$0")")/../book/html/release_notes/"
ls *.html \
| sed 's/.html$//' \
| xargs -I'{}' \
sed --in-place \
'/<head>/a <meta property="og:image" content="https://carapace-sh.github.io/carapace-bin/release_notes/{}/banner.png" />' \
'{}.html'

2
docs/src/release_notes.md
View File

@ -3,6 +3,6 @@
Release notes contain _noteworthy_ changes between **minor** (`1.x`) releases.
> These aren't strictly pinned to **tags**.
> So a feature announced as `1.n` might already be present in a previous or added in a later **patch** (`1.x.x`) release.
> So a feature announced as `1.n` might already be present in a previous (`1.{n-1}.x`) or added in a later (`1.n.x`) **patch** release.
>
> See [releases](https://github.com/carapace-sh/carapace-bin/releases) for an exact changelog.