{"id":98426,"date":"2026-06-05T18:37:13","date_gmt":"2026-06-05T15:37:13","guid":{"rendered":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/"},"modified":"2026-06-05T18:37:13","modified_gmt":"2026-06-05T15:37:13","slug":"markdownmanual","status":"publish","type":"mod","link":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/","title":{"rendered":"Markdown Manual"},"content":{"rendered":"<p><strong>MarkdownManual<\/strong> is a library mod enabling in-game manuals with content defined in <em>Markdown<\/em> documents. It is intended to be used by mod developers to provide in-game documentation of their mods in a simple manner. The mod provides a simple default manual look, but can be re-styled easily, or completely embedded into existing UI. <strong>This mod adds no player-facing content on its own.<\/strong><\/p>\n<p>For an example of how to use this library, see TIS-3D, which uses this for its in-game manual. For the required setup in code, please see the Manuals class. For content definition of the manual, please see the doc directory. But the short of it is: register a new manual with the manuals registry, register content for the new manual, register an item to make the manual available to players. Content documents are <em>Markdown<\/em> documents that may have links to other content documents. Images and blocks\/items can be embedded using <em>Markdown<\/em> style image references (for example <code>![Tooltip](block:minecraft:furnace)<\/code>).<\/p>\n<p>Here are some example screenshots, demonstrating how flexible the styling of the default manual UI is. Same content three times with different skins:<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/cdn.modrinth.com\/data\/nPQ9xkPg\/images\/92c27c9804cb518b652ae17f554f827fce9d8f85.png\" alt=\"Default UI.\" width=\"800\" height=\"450\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/cdn.modrinth.com\/data\/nPQ9xkPg\/images\/db28a090d7b3d243c8f49ff71238b63c15677fc5.png\" alt=\"Custom UI.\" width=\"800\" height=\"450\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/cdn.modrinth.com\/data\/nPQ9xkPg\/images\/dfda3f77cc960012dcac2c96c2ee4c4b37093f2f.png\" alt=\"Custom dark UI.\" width=\"800\" height=\"450\" \/><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Library mod for creating in-game manuals.<\/p>\n","protected":false},"featured_media":98427,"template":"","meta":{"_minecraft_slug":"markdownmanual","_minecraft_project_id":"nPQ9xkPg","_minecraft_author":"Sangar","_minecraft_license":"MIT","_minecraft_downloads":64039,"_minecraft_follows":11,"_minecraft_client_side":"required","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"markdownmanual.zip","_minecraft_size_bytes":3245316,"_minecraft_version_count":30,"_minecraft_updated_at":"2026-05-16T04:06:27.844828Z","_minecraft_date_created":"2022-05-20T21:52:46.345309Z","_minecraft_date_modified":"2024-04-15T21:43:01.049500Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/markdownmanual","_minecraft_icon_attachment_id":98427,"_minecraft_imported_at":"2026-06-05T15:37:14+00:00","_minecraft_import_hash":"0421f41728407212692d1bf196ac89e7","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,104,873,158],"mod_loader":[99,106,160],"minecraft_version":[53,54,56,57,36,60,94],"class_list":["post-98426","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-forge","mod_category-library","mod_category-neoforge","mod_loader-fabric","mod_loader-forge","mod_loader-neoforge","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-4"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.6 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Markdown Manual - Minecraft<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Markdown Manual - Minecraft\" \/>\n<meta property=\"og:description\" content=\"Library mod for creating in-game manuals.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/\" \/>\n<meta property=\"og:site_name\" content=\"Minecraft\" \/>\n<meta property=\"og:image\" content=\"https:\/\/cdn.modrinth.com\/data\/nPQ9xkPg\/images\/92c27c9804cb518b652ae17f554f827fce9d8f85.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/\",\"url\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/\",\"name\":\"Markdown Manual - Minecraft\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/wp-content\\\/uploads\\\/2026\\\/06\\\/markdownmanual-icon-icon.png\",\"datePublished\":\"2026-06-05T15:37:13+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/#primaryimage\",\"url\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/wp-content\\\/uploads\\\/2026\\\/06\\\/markdownmanual-icon-icon.png\",\"contentUrl\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/wp-content\\\/uploads\\\/2026\\\/06\\\/markdownmanual-icon-icon.png\",\"width\":400,\"height\":400},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/markdownmanual\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Mods\",\"item\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/mods\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Markdown Manual\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/#website\",\"url\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/\",\"name\":\"Minecraft\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/vpesports.com\\\/minecraft\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Markdown Manual - Minecraft","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/","og_locale":"en_US","og_type":"article","og_title":"Markdown Manual - Minecraft","og_description":"Library mod for creating in-game manuals.","og_url":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/","og_site_name":"Minecraft","og_image":[{"url":"https:\/\/cdn.modrinth.com\/data\/nPQ9xkPg\/images\/92c27c9804cb518b652ae17f554f827fce9d8f85.png","type":"","width":"","height":""}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/","url":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/","name":"Markdown Manual - Minecraft","isPartOf":{"@id":"https:\/\/vpesports.com\/minecraft\/#website"},"primaryImageOfPage":{"@id":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/#primaryimage"},"image":{"@id":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/#primaryimage"},"thumbnailUrl":"https:\/\/vpesports.com\/minecraft\/wp-content\/uploads\/2026\/06\/markdownmanual-icon-icon.png","datePublished":"2026-06-05T15:37:13+00:00","breadcrumb":{"@id":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/#primaryimage","url":"https:\/\/vpesports.com\/minecraft\/wp-content\/uploads\/2026\/06\/markdownmanual-icon-icon.png","contentUrl":"https:\/\/vpesports.com\/minecraft\/wp-content\/uploads\/2026\/06\/markdownmanual-icon-icon.png","width":400,"height":400},{"@type":"BreadcrumbList","@id":"https:\/\/vpesports.com\/minecraft\/mods\/markdownmanual\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/vpesports.com\/minecraft\/"},{"@type":"ListItem","position":2,"name":"Mods","item":"https:\/\/vpesports.com\/minecraft\/mods\/"},{"@type":"ListItem","position":3,"name":"Markdown Manual"}]},{"@type":"WebSite","@id":"https:\/\/vpesports.com\/minecraft\/#website","url":"https:\/\/vpesports.com\/minecraft\/","name":"Minecraft","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/vpesports.com\/minecraft\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod\/98426","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod"}],"about":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/types\/mod"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/media\/98427"}],"wp:attachment":[{"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/media?parent=98426"}],"wp:term":[{"taxonomy":"mod_category","embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod_category?post=98426"},{"taxonomy":"mod_loader","embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/mod_loader?post=98426"},{"taxonomy":"minecraft_version","embeddable":true,"href":"https:\/\/vpesports.com\/minecraft\/wp-json\/wp\/v2\/minecraft_version?post=98426"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}