{"id":20217533,"url":"https://github.com/pforret/mkdox","last_synced_at":"2025-04-10T15:43:55.790Z","repository":{"id":216268937,"uuid":"740885305","full_name":"pforret/mkdox","owner":"pforret","description":"create and run Mkdocs Material websites using Docker image","archived":false,"fork":false,"pushed_at":"2024-12-17T22:12:34.000Z","size":855,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T13:36:08.810Z","etag":null,"topics":["bashew","docker","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pforret.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-09T09:14:40.000Z","updated_at":"2024-12-17T22:12:35.000Z","dependencies_parsed_at":"2024-03-09T13:24:01.002Z","dependency_job_id":"5fcb5029-3c05-47ca-8be4-18665a641b64","html_url":"https://github.com/pforret/mkdox","commit_stats":null,"previous_names":["pforret/mkdox"],"tags_count":51,"template":false,"template_full_name":"pforret/bashew","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fmkdox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fmkdox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fmkdox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fmkdox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pforret","download_url":"https://codeload.github.com/pforret/mkdox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248243498,"owners_count":21071054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bashew","docker","mkdocs","mkdocs-material"],"created_at":"2024-11-14T06:34:29.461Z","updated_at":"2025-04-10T15:43:55.776Z","avatar_url":"https://github.com/pforret.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"![bash_unit CI](https://github.com/pforret/mkdox/workflows/bash_unit%20CI/badge.svg)\n![Shellcheck CI](https://github.com/pforret/mkdox/workflows/Shellcheck%20CI/badge.svg)\n![GH Language](https://img.shields.io/github/languages/top/pforret/mkdox)\n![GH stars](https://img.shields.io/github/stars/pforret/mkdox)\n![GH tag](https://img.shields.io/github/v/tag/pforret/mkdox)\n![GH License](https://img.shields.io/github/license/pforret/mkdox)\n[![basher install](https://img.shields.io/badge/basher-install-white?logo=gnu-bash\u0026style=flat)](https://www.basher.it/package/)\n\n# pforret/mkdox\n\n![](assets/unsplash.documents.jpg)\n\nConvenient bash wrapper for Mkdocs Material projects via Docker\n\n## 🔥 Usage\n\n```\nProgram : mkdox  by peter@forret.com\nVersion : v0.5.7 (Dec  7 09:44:11 2024)\nPurpose : easy wrapper for Material Mkdocs in Docker mode\nUsage   : mkdox [-h] [-q] [-v] [-f] [-G] [-I] [-Q] [-R] [-T] [-X] [-l \u003clog_dir\u003e] [-t \u003ctmp_dir\u003e] [-D \u003cDOCKER\u003e] [-E \u003cTITLE\u003e] [-H \u003cHISTORY\u003e] [-L \u003cLENGTH\u003e] [-P \u003cPORT\u003e] [-S \u003cSECS\u003e] \u003caction\u003e \u003cinput?\u003e \u003coutput?\u003e\nFlags, options and parameters:\n    -h|--help        : [flag] show usage [default: off]\n    -q|--quiet       : [flag] no output [default: off]\n    -v|--verbose     : [flag] also show debug messages [default: off]\n    -f|--force       : [flag] do not ask for confirmation (always yes) [default: off]\n    -G|--GITPUSH     : [flag] push to git after commit [default: off]\n    -I|--INDEX       : [flag] build index.md if index.pre/.post present (for mkdox build) [default: off]\n    -Q|--SHORT       : [flag] include short contents of page (for mkdox toc) [default: off]\n    -R|--RECURSIVE   : [flag] also list subfolders (for mkdox toc) [default: off]\n    -T|--TREE        : [flag] list as tree (for mkdox toc) [default: off]\n    -X|--EXPORT      : [flag] export to PDF (for mkdox build) [default: off]\n    -l|--log_dir \u003c?\u003e : [option] folder for log files   [default: /Users/pforret/log/mkdox]\n    -t|--tmp_dir \u003c?\u003e : [option] folder for temp files  [default: /tmp/mkdox]\n    -D|--DOCKER \u003c?\u003e  : [option] docker image to use  [default: pforret/mkdox-material-derived]\n    -E|--TITLE \u003c?\u003e   : [option] set site title\n    -H|--HISTORY \u003c?\u003e : [option] days to take into account for mkdox recent  [default: 7]\n    -L|--LENGTH \u003c?\u003e  : [option] max commit message length  [default: 99]\n    -P|--PORT \u003c?\u003e    : [option] http port for serve  [default: 8000]\n    -S|--SECS \u003c?\u003e    : [option] seconds to wait for launching a browser  [default: 10]\n    \u003caction\u003e         : [choice] action to perform  [options: new,serve,post,images,build,recent,toc,check,env,update]\n    \u003cinput\u003e          : [parameter] input folder name (optional)\n    \u003coutput\u003e         : [parameter] output file name (optional)\n                                  @github.com:pforret/mkdox.git                                             \n### TIPS \u0026 EXAMPLES\n* use mkdox new to create new Mkdocs Material project\n  mkdox new \u003cname\u003e\n* use mkdox build to create static HTML site in _site folder\n  mkdox build\n* use mkdox serve to start local website server (for preview)\n  mkdox serve\n* use mkdox images to list all images in a folder into a .md file\n  mkdox images docs/some/folder docs/some/folder/images.md\n* use mkdox toc \u003cfolder\u003e \u003cfile\u003e to create Table Of Contents for all Markdown files in folder\n  mkdox toc faq/services\n  mkdox -R toc . index\n* use mkdox recent to quickly list all pages changed in last N days\n  mkdox recent \u003e\u003e changes.md\n  mkdox -H 2 recent | sed 's|* |\\\u0026bull; |' \u003e\u003e changes.md\n* use mkdox check to check if this script is ready to execute and what values the options/flags are\n  mkdox check\n* use mkdox env to generate an example .env file\n  mkdox env \u003e .env\n* use mkdox update to update to the latest version\n  mkdox update\n* \u003e\u003e\u003e bash script created with pforret/bashew\n* \u003e\u003e\u003e for bash development, also check out pforret/setver and pforret/progressbar\n```\n\n## ⚡️ Examples\n\n```bash\n# create new Mkdocs Material project in folder 'Intranet'\n\u003e mkdox new Intranet\n\n# serve Mkdocs project on http://localhost:8800\n\u003e mkdox -P 8800 serve\n\n# build all HTML pages in /site\n\u003e mkdox build\n\n# create table of contents\n\u003e mkdox toc\n* [Changelog](CHANGELOG.md)\n* [Contributor Covenant Code Of Conduct](CODE_OF_CONDUCT.md)\n* [Contributing](CONTRIBUTING.md)\n* [Pforret Mkdox](README.md)\n\n# list all subpages in tree structure\n\u003e mkdox -R -T toc\n* [ ] [Changelog](CHANGELOG.md)\n* [ ] [Contributor Covenant Code Of Conduct](CODE_OF_CONDUCT.md)\n* [ ] [Contributing](CONTRIBUTING.md)\n* [ ] [Pforret Mkdox](README.md)\n* [ ] [\u0026rarr; \u0026rarr; Markdown Extensions](temp/docs/extensions.md)\n* [ ] [\u0026rarr; \u0026rarr; Welcome To Mkdocs](temp/docs/index.md)\n* [ ] [\u0026rarr; \u0026rarr; Installed Plugins](temp/docs/plugins.md)\n* [ ] [\u0026rarr; \u0026rarr; Markdown Extensions](templates/docs/extensions.md)\n* [ ] [\u0026rarr; \u0026rarr; {site Name}](templates/docs/index.md)\n* [ ] [\u0026rarr; \u0026rarr; Installed Plugins](templates/docs/plugins.md)\n\n# list all recently changed pages\n\u003e mkdox -H 3 -R recent\n* [Pforret Mkdox](README.md)\n\n\n```\n\n## 🚀 Installation\n\nwith [basher](https://github.com/basherpm/basher)\n\n\t$ basher install pforret/mkdox\n\nor with `git`\n\n\t$ git clone https://github.com/pforret/mkdox.git\n\t$ cd mkdox\n\n## Stargazers over time \n\n[![Stargazers over time](https://starchart.cc/pforret/mkdox.svg?variant=adaptive)](https://starchart.cc/pforret/mkdox)\n\n\n## 📝 Acknowledgements\n\n* script created with [bashew](https://github.com/pforret/bashew)\n\n[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge\u0026logo=MaterialForMkDocs\u0026logoColor=white)](https://squidfunk.github.io/mkdocs-material/)\n\n\u0026copy; 2024 Peter Forret - [blog.forret.com](https://blog.forret.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpforret%2Fmkdox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpforret%2Fmkdox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpforret%2Fmkdox/lists"}