lflxp/docker-mdbook

A set of tool for mdbook.

Shell

`docker-mdbook` (Alpine)

A set of tool for mdbook.

Package	Version
mdbook	0.4.36
mdbook-toc	0.14.1
mdbook-mermaid	0.12.6
mdbook-plantuml	0.8.0

`GIT`

https://github.com/allfunc/docker-mdbook

`Docker hub`

Docker Image: allfunc/mdbook
https://hub.docker.com/r/allfunc/mdbook

Usage

create SUMMARY.md file with such content.

# Summary

-   [Chapter 1](./chapter_1.md)

Copy bin/preview.sh to same folder.
- or download https://raw.githubusercontent.com/allfunc/docker-mdbook/main/bin/preview.sh
- chmod +x preview.sh
Run following command

./preview.sh start

Curl Example

curl https://raw.githubusercontent.com/allfunc/docker-mdbook/main/bin/preview.sh | bash -s -- start

import HTML

create any folder (such as public) inside src folder

<div data-import="/public/import-demo.html"></div>

sample md file
- https://raw.githubusercontent.com/allfunc/docker-mdbook/main/mdbook-demo/src/importDemo_2.md
sample public folder (could be any)
- https://github.com/allfunc/docker-mdbook/tree/main/mdbook-demo/src/public
sample import HTML file
- https://github.com/allfunc/docker-mdbook/blob/main/mdbook-demo/src/public/import-demo.html

APP

mdbook

mdbook-toc

mdbook-mermaid

mdbook-plantuml

update docker image

docker pull allfunc/mdbook

Troubleshooting

docker run --rm allfunc/mdbook -V

docker run -p 3888:3888 -e PORT=3888 \
    -u $(id -u):$(id -g) \
    -v $(pwd):/mdbook/src \
    --name mdbook \
    --rm allfunc/mdbook

Official Doc

SUMMARY.md
- https://rust-lang.github.io/mdBook/format/summary.html
Render
- https://rust-lang.github.io/mdBook/format/configuration/renderers.html

MIT 2023