-
Notifications
You must be signed in to change notification settings - Fork 0
WIP: Refactor Out Deprecations #1
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
7a1ff10
be1c989
af8922b
df453be
d699190
16b1e19
874a52b
5d18501
12bc8e8
920c281
b838e3c
e173cf9
f428c61
02a4897
5b895ef
ca40ae5
32e6012
7abb9c1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,14 +58,14 @@ For more details, see [HonKit's documentation](https://honkit.netlify.app/). | |
|
|
||
| ## Docker support | ||
|
|
||
| Honkit provide docker image at [honkit/honkit](https://hub.docker.com/r/honkit/honkit). | ||
| Honkit provide docker image at [ghcr.io/honkit/honkit](https://github.com/honkit/honkit/pkgs/container/honkit). | ||
|
|
||
| This docker image includes built-in dependencies for PDF/epub. | ||
|
|
||
| ``` | ||
| docker pull honkit/honkit | ||
| docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit build | ||
| docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit pdf | ||
| docker pull ghcr.io/honkit/honkit | ||
| docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit build | ||
| docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit pdf | ||
| ``` | ||
|
Comment on lines
65
to
69
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add a language to the fenced command block. The fenced block is missing a language marker, which triggers markdownlint (MD040). 🧩 Proposed fix-```
+```bash
docker pull ghcr.io/honkit/honkit
docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit build
docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit pdfVerify each finding against current code. Fix only still-valid issues, skip the In |
||
|
|
||
| For more details, see [docker/](./docker/). | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,28 @@ | ||
| # Docker Container | ||
|
|
||
| - https://hub.docker.com/r/honkit/honkit | ||
| - https://github.com/honkit/honkit/pkgs/container/honkit | ||
|
|
||
| ## Installation | ||
|
|
||
| docker pull honkit/honkit | ||
| docker pull ghcr.io/honkit/honkit | ||
|
|
||
| ## Usage | ||
|
|
||
| Show help | ||
|
|
||
| $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit --help | ||
| $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit --help | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove leading These lines trigger MD014; dropping prompt symbols keeps docs lint-clean without changing meaning. 🧹 Proposed fix- $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit --help
+ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit --help
- $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit build
+ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit build
- $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit pdf
+ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit pdf
- $ docker run -it --init -p 4000:4000 -v `pwd`:`pwd` -w `pwd` --rm ghcr.io/honkit/honkit honkit serve
+ docker run -it --init -p 4000:4000 -v `pwd`:`pwd` -w `pwd` --rm ghcr.io/honkit/honkit honkit serveAlso applies to: 17-17, 21-21, 25-25 🧰 Tools🪛 markdownlint-cli2 (0.22.1)[warning] 13-13: Dollar signs used before commands without showing output (MD014, commands-show-output) 🤖 Prompt for AI Agents |
||
|
|
||
| Build | ||
|
|
||
| $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit build | ||
| $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit build | ||
|
|
||
| PDF build | ||
|
|
||
| $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit pdf | ||
| $ docker run -v `pwd`:`pwd` -w `pwd` --rm -it ghcr.io/honkit/honkit honkit pdf | ||
|
|
||
| Serve on port 4000 | ||
|
|
||
| $ docker run -it --init -p 4000:4000 -v `pwd`:`pwd` -w `pwd` --rm honkit/honkit honkit serve | ||
| $ docker run -it --init -p 4000:4000 -v `pwd`:`pwd` -w `pwd` --rm ghcr.io/honkit/honkit honkit serve | ||
|
|
||
| ## Tips | ||
|
|
||
|
|
@@ -31,7 +31,7 @@ Serve on port 4000 | |
| You can create new image includes custom font based on honkit image. | ||
|
|
||
| ``` | ||
| FROM honkit/honkit:latest | ||
| FROM ghcr.io/honkit/honkit:latest | ||
| LABEL maintainer="your@example.com" | ||
|
|
||
| # Install fonts | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix subject-verb agreement in the Docker support sentence.
Line 61 should read “HonKit provides …” for correct user-facing grammar.
✏️ Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents