Skip to content

Add embed tool for embedding files in markdown #587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −8
Open

Add embed tool for embedding files in markdown #587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ MDBOOK_BIN := $(TOOLS_BIN_DIR)/mdbook
export PATH := $(PATH):$(TOOLS_BIN_DIR)

## ------------------------------------
## Resolve placeholders as tags
## mdbook plugins
## ------------------------------------
RELEASETAGS := $(TOOLS_BIN_DIR)/mdbook-releasetags
$(RELEASETAGS): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go build -tags=tools -o $(TOOLS_BIN_DIR)/mdbook-releasetags ./releasetags

.PHONY: releasetags
releasetags: $(RELEASETAGS)
Comment on lines -21 to -22
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the phony for releasetags since it seemed unnecessary to me. We were not using it anywhere so the only thing it could be used for is to manually build the binary releasetags.

MDBOOK_EMBED := $(TOOLS_BIN_DIR)/mdbook-embed
$(MDBOOK_EMBED): $(TOOLS_DIR)/go.mod
cd $(TOOLS_DIR); go build -tags=tools -o $(TOOLS_BIN_DIR)/mdbook-embed sigs.k8s.io/cluster-api/hack/tools/mdbook/embed

## ------------------------------------
## Documentation tooling for Netlify
Expand All @@ -32,7 +33,7 @@ $(MDBOOK_BIN): # Download the binary
curl -L $(MDBOOK_RELEASE_URL) | tar xvz -C $(TOOLS_BIN_DIR)

.PHONY: netlify-build
netlify-build: $(RELEASETAGS) $(MDBOOK_BIN)
netlify-build: $(MDBOOK_EMBED) $(RELEASETAGS) $(MDBOOK_BIN)
$(MDBOOK_BIN) build $(SOURCE_PATH)


Expand Down
8 changes: 5 additions & 3 deletions docs/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ARG BUILD_IMAGE=docker.io/golang:1.21.9@sha256:7d0dcbe5807b1ad7272a598fbf9d7af15b5e2bed4fd6c4c2b5b3684df0b317dd
ARG BUILD_IMAGE=docker.io/golang:1.25.3@sha256:6ea52a02734dd15e943286b048278da1e04eca196a564578d718c7720433dbbe
FROM $BUILD_IMAGE AS builder
WORKDIR /workspace

Expand All @@ -21,11 +21,13 @@ COPY hack/tools/releasetags/ releasetags/
ARG ARCH=amd64
RUN CGO_ENABLED=0 GOOS=linux GOARCH=${ARCH} \
go build -tags=tools -a -ldflags '-extldflags "-static"' \
-o mdbook-releasetags ./releasetags
-o mdbook-releasetags ./releasetags && \
go build -tags=tools -a -ldflags '-extldflags "-static"' \
-o mdbook-embed sigs.k8s.io/cluster-api/hack/tools/mdbook/embed
ARG MDBOOK_RELEASE_URL="https://github.com/rust-lang/mdBook/releases/download/v0.4.52/mdbook-v0.4.52-x86_64-unknown-linux-gnu.tar.gz"
RUN curl -L "${MDBOOK_RELEASE_URL}" \
| tar xvz -C /workspace

FROM netlify/build:noble
WORKDIR /workdir
COPY --from=builder /workspace/mdbook-releasetags /workspace/mdbook /usr/bin/
COPY --from=builder /workspace/mdbook* /usr/bin/
3 changes: 3 additions & 0 deletions docs/user-guide/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ title = "Metal³ user-guide"

[preprocessor.releasetags]

[preprocessor.embed]
command = "mdbook-embed"

[output.html]
git-repository-url = "https://github.com/metal3-io/"
smart-punctuation = true
6 changes: 5 additions & 1 deletion hack/tools/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
module metal3-io/metal3-docs/hack/tools

go 1.21
go 1.24.0

require (
github.com/blang/semver v3.5.1+incompatible
sigs.k8s.io/kubebuilder/docs/book/utils v0.0.0-20240216033807-8afeb403549f
)

require sigs.k8s.io/cluster-api/hack/tools v0.0.0-20251020054008-0978f70c29b1 // indirect

tool sigs.k8s.io/cluster-api/hack/tools/mdbook/embed
2 changes: 2 additions & 0 deletions hack/tools/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
github.com/blang/semver v3.5.1+incompatible h1:cQNTCjp13qL8KC3Nbxr/y2Bqb63oX6wdnnjpJbkM4JQ=
github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk=
sigs.k8s.io/cluster-api/hack/tools v0.0.0-20251020054008-0978f70c29b1 h1:FxcZZdIxGOHIgl4ETvsuSYR3eKozMZTKCarNRI/Ix74=
sigs.k8s.io/cluster-api/hack/tools v0.0.0-20251020054008-0978f70c29b1/go.mod h1:l26LNezuh0r/oQ492SQqIGpTCxkmSwymKnvXjCPz6hE=
sigs.k8s.io/kubebuilder/docs/book/utils v0.0.0-20240216033807-8afeb403549f h1:0rbnCuTF/IIxfwoJR/p7zTB5+AA0RaBwB0lqjBUs/28=
sigs.k8s.io/kubebuilder/docs/book/utils v0.0.0-20240216033807-8afeb403549f/go.mod h1:4CGoZGcqb7Bes5d0qgb4SIHqk+XjUfoxesbbTmpVl6s=