https://github.com/pforret/mkdox
create and run Mkdocs Material websites using Docker image
https://github.com/pforret/mkdox
bashew docker mkdocs mkdocs-material
Last synced: 19 days ago
JSON representation
create and run Mkdocs Material websites using Docker image
- Host: GitHub
- URL: https://github.com/pforret/mkdox
- Owner: pforret
- License: mit
- Created: 2024-01-09T09:14:40.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-17T22:12:34.000Z (4 months ago)
- Last Synced: 2025-03-24T13:36:08.810Z (about 1 month ago)
- Topics: bashew, docker, mkdocs, mkdocs-material
- Language: Shell
- Homepage:
- Size: 835 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.basher.it/package/)
# pforret/mkdox
Convenient bash wrapper for Mkdocs Material projects via Docker
## 🔥 Usage
```
Program : mkdox by [email protected]
Version : v0.5.7 (Dec 7 09:44:11 2024)
Purpose : easy wrapper for Material Mkdocs in Docker mode
Usage : mkdox [-h] [-q] [-v] [-f] [-G] [-I] [-Q] [-R] [-T] [-X] [-l ] [-t ] [-D ] [-E ] [-H ] [-L ] [-P ] [-S ]
Flags, options and parameters:
-h|--help : [flag] show usage [default: off]
-q|--quiet : [flag] no output [default: off]
-v|--verbose : [flag] also show debug messages [default: off]
-f|--force : [flag] do not ask for confirmation (always yes) [default: off]
-G|--GITPUSH : [flag] push to git after commit [default: off]
-I|--INDEX : [flag] build index.md if index.pre/.post present (for mkdox build) [default: off]
-Q|--SHORT : [flag] include short contents of page (for mkdox toc) [default: off]
-R|--RECURSIVE : [flag] also list subfolders (for mkdox toc) [default: off]
-T|--TREE : [flag] list as tree (for mkdox toc) [default: off]
-X|--EXPORT : [flag] export to PDF (for mkdox build) [default: off]
-l|--log_dir > : [option] folder for log files [default: /Users/pforret/log/mkdox]
-t|--tmp_dir > : [option] folder for temp files [default: /tmp/mkdox]
-D|--DOCKER > : [option] docker image to use [default: pforret/mkdox-material-derived]
-E|--TITLE > : [option] set site title
-H|--HISTORY > : [option] days to take into account for mkdox recent [default: 7]
-L|--LENGTH > : [option] max commit message length [default: 99]
-P|--PORT > : [option] http port for serve [default: 8000]
-S|--SECS > : [option] seconds to wait for launching a browser [default: 10]
: [choice] action to perform [options: new,serve,post,images,build,recent,toc,check,env,update]
: [parameter] input folder name (optional)
: [parameter] output file name (optional)
@github.com:pforret/mkdox.git
### TIPS & EXAMPLES
* use mkdox new to create new Mkdocs Material project
mkdox new
* use mkdox build to create static HTML site in _site folder
mkdox build
* use mkdox serve to start local website server (for preview)
mkdox serve
* use mkdox images to list all images in a folder into a .md file
mkdox images docs/some/folder docs/some/folder/images.md
* use mkdox toc to create Table Of Contents for all Markdown files in folder
mkdox toc faq/services
mkdox -R toc . index
* use mkdox recent to quickly list all pages changed in last N days
mkdox recent >> changes.md
mkdox -H 2 recent | sed 's|* |\• |' >> changes.md
* use mkdox check to check if this script is ready to execute and what values the options/flags are
mkdox check
* use mkdox env to generate an example .env file
mkdox env > .env
* use mkdox update to update to the latest version
mkdox update
* >>> bash script created with pforret/bashew
* >>> for bash development, also check out pforret/setver and pforret/progressbar
```
## ⚡️ Examples
```bash
# create new Mkdocs Material project in folder 'Intranet'
> mkdox new Intranet
# serve Mkdocs project on http://localhost:8800
> mkdox -P 8800 serve
# build all HTML pages in /site
> mkdox build
# create table of contents
> mkdox toc
* [Changelog](CHANGELOG.md)
* [Contributor Covenant Code Of Conduct](CODE_OF_CONDUCT.md)
* [Contributing](CONTRIBUTING.md)
* [Pforret Mkdox](README.md)
# list all subpages in tree structure
> mkdox -R -T toc
* [ ] [Changelog](CHANGELOG.md)
* [ ] [Contributor Covenant Code Of Conduct](CODE_OF_CONDUCT.md)
* [ ] [Contributing](CONTRIBUTING.md)
* [ ] [Pforret Mkdox](README.md)
* [ ] [→ → Markdown Extensions](temp/docs/extensions.md)
* [ ] [→ → Welcome To Mkdocs](temp/docs/index.md)
* [ ] [→ → Installed Plugins](temp/docs/plugins.md)
* [ ] [→ → Markdown Extensions](templates/docs/extensions.md)
* [ ] [→ → {site Name}](templates/docs/index.md)
* [ ] [→ → Installed Plugins](templates/docs/plugins.md)
# list all recently changed pages
> mkdox -H 3 -R recent
* [Pforret Mkdox](README.md)
```
## 🚀 Installation
with [basher](https://github.com/basherpm/basher)
$ basher install pforret/mkdox
or with `git`
$ git clone https://github.com/pforret/mkdox.git
$ cd mkdox
## Stargazers over time
[](https://starchart.cc/pforret/mkdox)
## 📝 Acknowledgements
* script created with [bashew](https://github.com/pforret/bashew)
[](https://squidfunk.github.io/mkdocs-material/)
© 2024 Peter Forret - [blog.forret.com](https://blog.forret.com)