[{"_1":2,"_169":-5,"_170":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_147":148},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_136":-5,"_137":11,"_138":21,"_139":11,"_140":-5,"_141":11,"_142":-5,"_143":144,"_145":91,"_146":-7},"canonicalUrl","https://hub.docker.com/r/macwinnie/md2rst/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","macwinnie","reponame","md2rst","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2021-11-09T17:53:20.698575Z","description","Image that supports building documentation from MarkDown within phpDocumentor ...","is_private","last_updated","2026-10-12T02:21:42.244395Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.oci.image.index.v1+json","name","pull_count",3066,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# md2rst\n\nThis repo holds the Dockerfile to support phpDocumentor and translate `md` (MarkDown) files into `rst` (reStructuredText) files.\n\n## environmental variables\n\n| variable name | default | description |\n| ------------- | ------- | ----------- |\n| `FROM_DIR` | `/data` | directory where the script reads sources from |\n| `TO_DIR` | `/data` | directory where the script writes transformed data to |\n| `DEBUG` | `FALSE` | should log messages be printed? |\n| `TOCED_INDEX` | `TRUE` | should index files (with table of content) be created if they do not exist and if they exist should a TOC be inserted? |\n| `TOC_ATTRS` | `{\"maxdepth\":\"3\",\"hidden\":\"\"}` | JSON representation of dictionary with [attributes for toctree inserted into index files](https://www.sphinx-doc.org/en/1.4.9/markup/toctree.html).

Special attributes:

`.named` (root level only) – if you want to define attributes at the dedicated path, you can put `path/to/depth` named dictionaries here.
`.leveled` (root level only) – you may define attributes by path depth level. `TO_DIR` defines level `0`.
`.prepend` – define with any (also empty) value to prepend the `index.rst` file by TOC instead of append it.

Special attributes override general ones and `.named` one overrides `.leveled` ones. `.named` and `.leveled` have their root (level `0`) in `TO_DIR`. |\n\n## example run command\n\nGiven an example data structure like that:\n\n```\n./md\n ├── amet.md\n ├── dolor\n │ ├── index.md\n │ └── sadipscing.md\n ├── lorem\n │ ├── index.md\n │ └── ipsum\n │ └── consetetur.md\n └── sit\n └── elitr.md\n```\n\n

Click for bash code to generate this structure ...

\n\n```sh\nmkdir -p md/lorem/ipsum \\\n md/dolor \\\n md/sit\n\ntouch md/amet.md \\\n md/lorem/index.md \\\n md/lorem/ipsum/consetetur.md \\\n md/dolor/sadipscing.md \\\n md/sit/elitr.md\n\ncat < md/dolor/index.md\n# Demo index\n\nThis index file is a first demonstration file.\nEOF\n\ncat < md/lorem/index.md\n# Demo index\n\nThis index file is a second demonstration file.\nEOF\n```\n\n

\n\nAnd running the docker image like that:\n\n```sh\nread -r -d '' TOCJSON <<- EOV\n {\n \".named\": {\n \"dolor\": {\n \".prepend\": \"\"\n },\n \"lorem\": {\n \"maxdepth\": \"1\"\n }\n },\n \".leveled\": {\n \"0\": {\n \"caption\": \"Table of contents\",\n \"maxdepth\": \"3\",\n \"hidden\": \"\"\n }\n },\n \"maxdepth\": \"3\",\n \"hidden\": \"\"\n }\nEOV\n\ndocker run --rm -t \\\n -v $(pwd)/md:/dataMd -e FROM_DIR=\"/dataMd\" \\\n -v $(pwd)/rst:/dataRst -e TO_DIR=\"/dataRst\" \\\n -e TOC_ATTRS=\"${TOCJSON}\" \\\n macwinnie/md2rst:latest\n```\n\nWill result in this file structure:\n\n```\n./rst\n ├── amet.rst\n ├── index.rst\n ├── dolor\n │ ├── index.rst\n │ └── sadipscing.rst\n ├── lorem\n │ ├── index.rst\n │ └── ipsum\n │ ├── consetetur.rst\n │ └── index.rst\n └── sit\n ├── elitr.rst\n └── index.rst\n```\n\n

Click to show generated index files ...

`rst/index.rst`\n\n```\n.. toctree::\n :caption: Table of contents\n :maxdepth: 3\n :hidden:\n\n amet\n dolor/index\n lorem/index\n sit/index\n```\n\n
`rst/dolor/index.rst`\n\n```\n.. toctree::\n\n sadipscing\n\nDemo index\n==========\n\nThis index file is a first demonstration file.\n```\n
`rst/lorem/index.rst`\n\n```\n\nDemo index\n==========\n\nThis index file is a second demonstration file.\n\n.. toctree::\n :maxdepth: 1\n\n ipsum/index\n```\n
`rst/lorem/ipsum/index.rst`\n\n```\n.. toctree::\n :maxdepth: 3\n :hidden:\n\n consetetur\n```\n
`rst/sit/index.rst`\n\n```\n.. toctree::\n :maxdepth: 3\n :hidden:\n\n elitr\n```\n

\n\nIf you want to work with the directory levels in a range, you could use e.g. `1..` to define attributes for all levels greater or equal than 1 or `2..3` to define attributes to only be used at 2nd and 3rd levels.","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",77341639063,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_50":125,"_126":94,"_127":33,"_128":56,"_57":129,"_130":131,"_132":110,"_133":125,"_134":66,"_135":21},"content_type","creator",1919880,"digest","sha256:c9e2d5b3c097eca9d919e2ab50bca467c922cd743fb0d854889691836134bfd9","full_size",423802217,"id",176546571,"images",[103,119],{"_104":105,"_95":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":98,"_63":66,"_118":-5},"architecture","amd64","sha256:244de55d556d7e2c9a843a13c334d0254736132995585305b31c52c89e738212","features","","last_pulled","2026-10-14T20:06:44.358477554Z","last_pushed","2026-10-12T02:21:40.440259928Z","os","linux","os_features","os_version","size","variant",{"_104":120,"_95":121,"_107":108,"_109":122,"_111":123,"_113":114,"_115":108,"_116":-5,"_117":124,"_63":66,"_118":-5},"arm64","sha256:e422d7a68fa60cdca18f416c81ac7be9cbfc8bd980b5dd5eecc5b0c261266f51","2026-10-14T20:06:44.33332071Z","2026-10-12T02:21:39.816533223Z",412645573,"2026-10-12T02:21:41.743078Z","last_updater","last_updater_username","media_type","latest","repository",15785126,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":149,"_156":157,"_143":167,"_168":11},{"_40":150,"_42":151,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":152,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":153,"_79":11,"_80":155,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":154},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_158":64,"_159":-5,"_160":-5,"_161":162},"count","next","previous","results",[163],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":164,"_50":125,"_126":94,"_127":33,"_128":56,"_57":129,"_130":131,"_132":110,"_133":125,"_134":66,"_135":21},[165,166],{"_104":105,"_95":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":98,"_63":66,"_118":-5},{"_104":120,"_95":121,"_107":108,"_109":122,"_111":123,"_113":114,"_115":108,"_116":-5,"_117":124,"_63":66,"_118":-5},[],"canDeleteTags","actionData","errors"]

Digest	OS/ARCH	Compressed size
244de55d556d	linux/amd64	404.17 MB
e422d7a68fa6	linux/arm64	393.53 MB

macwinnie/md2rst

Tags for macwinnie/md2rst