[{"_1":2,"_163":-5,"_164":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_132":-5,"_133":11,"_134":17,"_135":11,"_136":-5,"_137":11,"_138":-5,"_139":140},"canonicalUrl","https://hub.docker.com/r/macwinnie/md2rst/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","macwinnie","reponame","md2rst","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2021-11-09T17:53:20.698575Z","description","Image that supports building documentation from MarkDown within phpDocumentor ...","is_private","last_updated","2026-09-21T01:04:06.160922Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.oci.image.index.v1+json","name","pull_count",2896,"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",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",76370855323,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_46":121,"_122":90,"_123":29,"_124":52,"_53":125,"_126":127,"_128":106,"_129":121,"_130":62,"_131":17},"content_type","creator",1919880,"digest","sha256:ef918cf09f91df4378affe5b608628f241214da0cff438dcf2959be6ef457808","full_size",423020720,"id",176546571,"images",[99,115],{"_100":101,"_91":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":104,"_112":-5,"_113":94,"_59":62,"_114":-5},"architecture","amd64","sha256:f079ffcf04af39826fdd800d9f8dcf49c71d6b78823d91c19e4b7a594ceeab34","features","","last_pulled","2026-09-23T17:26:32.309391413Z","last_pushed","2026-09-21T01:04:03.199513871Z","os","linux","os_features","os_version","size","variant",{"_100":116,"_91":117,"_103":104,"_105":118,"_107":119,"_109":110,"_111":104,"_112":-5,"_113":120,"_59":62,"_114":-5},"arm64","sha256:8486ae6216ed517afdf6b6d883cba8c7992bae806f9e873ea7f445702a23df23","2026-09-21T01:29:03.612929962Z","2026-09-21T01:04:03.736849127Z",411863659,"2026-09-21T01:04:05.291345Z","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",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":143,"_150":151,"_139":161,"_162":11},{"_36":144,"_38":145,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":146,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":147,"_75":11,"_76":149,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":148},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_152":60,"_153":-5,"_154":-5,"_155":156},"count","next","previous","results",[157],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":158,"_46":121,"_122":90,"_123":29,"_124":52,"_53":125,"_126":127,"_128":106,"_129":121,"_130":62,"_131":17},[159,160],{"_100":101,"_91":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":104,"_112":-5,"_113":94,"_59":62,"_114":-5},{"_100":116,"_91":117,"_103":104,"_105":118,"_107":119,"_109":110,"_111":104,"_112":-5,"_113":120,"_59":62,"_114":-5},[],"canDeleteTags","actionData","errors"]

Digest	OS/ARCH	Compressed size
f079ffcf04af	linux/amd64	403.42 MB
8486ae6216ed	linux/arm64	392.78 MB

macwinnie/md2rst

Tags for macwinnie/md2rst