Markdown Manual

<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> <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 <a href="https://github.com/MightyPirates/TIS-3D/blob/master-MC1.16.5-forge/src/main/java/li/cil/tis3d/client/manual/Manuals.java">the Manuals class</a>. For content definition of the manual, please see <a href="https://github.com/MightyPirates/TIS-3D/tree/master-MC1.16.5-forge/src/main/resources/assets/tis3d/doc/en_us">the doc directory</a>. 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></code>).</p> <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> <p><img src="https://cdn.modrinth.com/data/nPQ9xkPg/images/92c27c9804cb518b652ae17f554f827fce9d8f85.png" alt="Default UI." width="800" height="450" /></p> <p><img src="https://cdn.modrinth.com/data/nPQ9xkPg/images/db28a090d7b3d243c8f49ff71238b63c15677fc5.png" alt="Custom UI." width="800" height="450" /></p> <p><img src="https://cdn.modrinth.com/data/nPQ9xkPg/images/dfda3f77cc960012dcac2c96c2ee4c4b37093f2f.png" alt="Custom dark UI." width="800" height="450" /></p>