Skip to content

markdown

Jump to bottom
ABKQPO edited this page Jun 1, 2026 · 14 revisions

navigation: title: Markdown Basics parent: index.md position: 190 recommend: 0 categories:

  • markdown

Markdown Test

This page is a runtime sample sheet for checking what GuideNH currently renders in-game.

See also: Charts · Function Graphs

LaTeX Formulas

Render LaTeX math inline with <Latex formula="..." />, or as a centered display block by using the same tag in block context (on its own paragraph line).

Inline formulas

Einstein's mass-energy equivalence: and Pythagoras:

A formula with a fraction expands the line height automatically: contains and also in the same line.

Custom colour (gold):

Scaled up (scale=1.5):

Tooltip on hover (showTooltip):

Plain custom tooltip:

Rich tooltip: Gibbs free energy combines enthalpy and entropy.

  • is the enthalpy change.
  • is the entropy term.
  • Hovered tooltips can use regular Markdown and inline guide tags.

Bottom-aligned (valign=bottom): sits below a regular line.

Top-aligned (valign=top): is flush with the line top.

Manual offset: nudged right 2 px and up 1 px.

$$formula$$ shorthand

Use $$formula$$ directly in text for quick formulas with default parameters.

Inline shorthands: $$E=mc^2$$ and $$a^2+b^2=c^2$$

Inline fraction: $$\frac{1}{2}$$

$$\int_0^\infty e^{-x^2},dx = \frac{\sqrt{\pi}}{2}$$

$$\begin{pmatrix} a & b \ c & d \end{pmatrix}$$

Block (display) formulas

Attribute reference

Attribute Type Default Description
formula String (required) — LaTeX source
color #RRGGBB or #AARRGGBB #FFFFFF Glyph colour
scale float 1.0 Display size multiplier
sourceScale float 100.0 jlatexmath render quality
tooltip String — Plain custom tooltip text
showTooltip boolean false Show formula source on hover when no custom tooltip is provided
valign baseline/top/center/bottom baseline Inline vertical alignment
offsetX int 0 Horizontal pixel offset after alignment
offsetY int 0 Vertical pixel offset after alignment

Inline Formatting

Markdown Alternative Result
*Italic* _Italic_ Italic
**Bold** __Bold__ Bold
~~Strikethrough~~ ~Strikethrough~ Strikethrough
++Underline++ ++Underline++
^^Wavy underline^^ ^^Wavy underline^^
::Emphasis dots:: ::Emphasis dots::
==Highlight== <mark>Highlight</mark> ==Highlight==
[Link](http://a.com) Link
[Relative Link](./index.md) Relative Link
[Absolute Link](guidenh:index.md) Absolute Link
[Other Namespace](gregtech:guide.md) Other Namespace
[Anchor Link](#Headings) Anchor Link
[Cross-Page Anchor](./index.md#navigation) Cross-Page Anchor
[Absolute Anchor](guidenh:index.md#navigation) Absolute Anchor
`Inline Code` Inline Code
![Image](test1.png) Image

Literal autolinks: visit https://example.com/docs, www.example.org, or guide@example.com

Custom mark color: dark golden highlight

hover to reveal this hidden sentence

Anchor Link still hovers and underlines like a normal link after reveal

Bold italic ==mark== and tint still render inside the hidden text

Hidden text can also use Markdown and runtime tags.

Press Shift + 1

Back to index

Headings

Headings can be defined by prefixing them with #.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Blockquote And Alerts

Markdown:

> Blockquote

Result:

Blockquote

Note

GitHub-style note alert with the blue accent line and icon.

Tip

Tip alert with a green accent line and icon.

Important

Important alert with the purple accent line and icon.

Warning

Warning alert with the gold accent line and icon.

Caution

Caution alert with the red accent line and icon.

Custom runtime quote directives:

> {: title="Custom Quote" color="#638ef1" icon="i" }
> Custom title, accent color and text icon.

{: title="Custom Quote" color="#638ef1" icon="i" } Custom title, accent color and text icon.

> {: title="Item Quote" color="#61b75d" iconItem="minecraft:emerald" }
> ItemStack icon in the quote header.

{: title="Item Quote" color="#61b75d" iconItem="minecraft:emerald" } ItemStack icon in the quote header.

> {: title="PNG Quote" color="#c79d3e" iconPng="./diamond.png" }
> PNG icon loaded from guide assets.

{: title="PNG Quote" color="#c79d3e" iconPng="./diamond.png" } PNG icon loaded from guide assets.

Lists

Markdown:

* List
* List
* List

1. One
2. Two
3. Three

Result:

  • List
  • List
  • List
  1. One
  2. Two
  3. Three
  • Task done
  • Task pending
- constrained list line width example - another constrained list item that should wrap earlier

Tables

Markdown:

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

Result:

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

Alignment check:

Left Center Right
iron 42 128
gold 17 64

Ordinary markdown tables can also use runtime width hints:

Name Value
Iron 42
Gold 17
{: widths="120,80" }

Another width-hint sample with three columns:

Material Count Notes
Iron 42 base line
Gold 17 compact
Diamond 9 rare
{: widths="130,70,150" }

Reference Links And Images

Guide Ref

Machine Diagram

Details

<details> accepts width, height, wrap, and align. The summary supports inline tags, and the body can mix ordinary text with arbitrary runtime blocks.

Mixed runtime content

This details body keeps normal page links, inline formatting, and block content together inside the same scrollable panel.

Machine Diagram

Text outside the block should still wrap around it when wrap="square" is used.

Code Blocks

Explicit language:

local value = 42
print(value)

Explicit Scala:

object Demo extends App {
  println("scala language label")
}

Explicit Markdown:

* List
* List
* List

1. One
2. Two
3. Three

This unlabeled fence should stay a code block and auto-detect Scala:

object Demo extends App {
  println("auto detected scala")
}

This unlabeled fence should stay a code block and auto-detect CSV instead of rendering a table:

name,value
iron,42
gold,17

Indented code block:

print("indented code block")

Forced code block viewport height with inner scrolling:

line 01
line 02
line 03
line 04
line 05
line 06
line 07
line 08
line 09
line 10
line 11
line 12
line 13
line 14
line 15
line 16
line 17
line 18
line 19
line 20
line 21
line 22
line 23
line 24

CSV Runtime Tables

This explicit csv fence renders as a runtime table:

name,value
iron,42
gold,17

This explicit csv fence also applies column width hints:

name,value
iron,42
gold,17

Quoted widths and header=false:

iron,42
gold,17
diamond,9

Imported CSV:

Imported CSV with widths:

File Trees

Fenced tree / filetree blocks render directory-style outlines with real connector lines. Both Unicode box-drawing (│ ├ └ ─) and ASCII (| +-- \-- / four spaces) prefixes are accepted, mixed freely. Payload text supports the usual inline Markdown (links, bold, code, etc.), and those links should be clickable both in-game and in site export.

project
├── src
│   ├── **main**
│   │   └── [App.java](./index.md)
│   └── *test*
└── `README.md`

ASCII variant with optional per-row icons ({:icon=…} for plain text, {:iconPng=path.png} for an image, {:iconItem=mod:item[:meta][:{snbt}]} for an item stack):

world
|-- {:iconItem=minecraft:grass} grass biome
|   |-- {:icon=Oak} oak forest
|   \-- {:icon=Hill} rolling hills
|-- {:iconItem=minecraft:wool:14} red wool patch
\-- {:iconPng=test1.png} sample asset

Inside an MDX block tag, the same syntax works through <FileTree> with optional indent (px per depth, default 14) and gap (extra px between rows, default 0):

<FileTree indent="16" gap="2">
docs
├── [intro.md](./index.md#headings)
└── advanced
    ├── [tags.md](./index.md#details)
    └── [recipes.md](./charts.md)
</FileTree>

Mermaid Mindmaps

Inline Mermaid fence:

mindmap
  root((GuideNH))
    Runtime
      Markdown
      CSV
    Languages
      Lua
      Scala
    Mindmap::icon(fa fa-sitemap)
      Drag to pan
      Wheel to zoom
Loading

Mindmap with explicit node coordinates:

mindmap
  Root((Pinned Root))
    Branch[Branch]::pos(120,80)
      Child A
      Child B::icon(fa fa-code)
Loading

Imported Mermaid file:

Fixed runtime Mermaid viewport size:

Mindmap with rich labels and explicit node content:

mindmap root["**GuideNH** [Index](./index.md)"] runtime["Runtime blocks"] preview["Scene preview"] Runtime nodes can mix normal text with embedded guide blocks.

Footnotes

Footnote ref[^one]

[^one]: tooltip text for the footnote

GuideNH Wiki

English

中文

Clone this wiki locally