Converter.MarkdownToBBCodeSteam.Tool 1.0.0.29

Converter.MarkdownToBBCode

Converts Markdown and HTML (GitHub flavor) into NexusMods and Steam BBCode flavor. Might be opionated with the HTML conversion, since there are a few ways to interpret HTML

Installation

dotnet tool install -g Converter.MarkdownToBBCodeNM.Tool
dotnet tool install -g Converter.MarkdownToBBCodeSteam.Tool

Usage

When installed as a global tool:

# NexusMods
markdown_to_bbcodenm -i "**raw markdown**"
markdown_to_bbcodenm -i "~~raw\r\nmarkdown~~" --disableextended

markdown_to_bbcodenm -i "/markdown.md";
markdown_to_bbcodenm -i "/markdown.md" -o "/bbcode.txt";

# Steam
markdown_to_bbcodesteam -i "**raw markdown**"
markdown_to_bbcodesteam -i "~~raw\r\nmarkdown~~" --disableextended

markdown_to_bbcodesteam -i "/markdown.md";
markdown_to_bbcodesteam -i "/markdown.md" -o "/bbcode.txt";

-i or --input accepts both raw markdown and a file path.
-o or --output accepts a file path. If specified, will write the converted BBCode to the file instead of outputting to the console.
-d or --disableextended will disable newline detection via two spaces and will disable HTML conversion

Example

At the time of writing the tool, it was used to keep in sync the description of the BLSE mod for Bannerlord.
BLSE - GitHub → NexusMods
MCM - GitHub → NexusMods & GitHub → Steam

Notes

• You can ignore an HTML element by adding converter_ignore, converter_nexusmods, converter_steam attribute to the element

  <p converter_ignore>WILL NOT BE CONVERTED TO BBCODE</p>
  <p converter_nexusmods>WILL NOT BE CONVERTED TO BBCODE FOR STEAM</p>
  <p converter_steam>WILL NOT BE CONVERTED TO BBCODE FOR NEXUSMODS</p>
  

• You can scope a region of plain Markdown to a platform with HTML-comment fences (invisible on GitHub, so the content stays Markdown - no HTML wrapping needed)

  NOT CONVERTED TO BBCODE
  ONLY CONVERTED FOR NEXUSMODS
  ONLY CONVERTED FOR STEAM
  

• You can set an alternative href for a link for NexusMods/Steam by adding a nexusmods_href or steam_href attribute to the element

  <a href="MARKDOWN_LINK" nexusmods_href="NEXUSMODS_LINK" /> </a>
  

• You can set an alternative src for an image for NexusMods/Steam by adding a nexusmods_src or steam_src attribute to the element

  <img src="MARKDOWN_IMAGE" nexusmods_src="NEXUSMODS_IMAGE" />
  

• Literal BBCode-like text (e.g. [b], [spoiler]) in plain Markdown and inline code is passed through as-is on both platforms, so they will interpret it as BBCode. This is deliberate: NexusMods has no [noparse] equivalent, and escaping only on Steam would hide breakage that still happens on NexusMods. Avoid literal [tags] outside of code blocks

Supporting Codes

GitHub Markdown Supported HTML Codes
Steam Supported BBCode Codes