{"id":19494753,"url":"https://github.com/ceejbot/md2nexus","last_synced_at":"2025-09-10T08:40:22.829Z","repository":{"id":193615604,"uuid":"689173371","full_name":"ceejbot/md2nexus","owner":"ceejbot","description":"Convert markdown to nexusmods-flavored bbcode","archived":false,"fork":false,"pushed_at":"2023-09-12T00:42:47.000Z","size":48,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"latest","last_synced_at":"2025-04-18T20:25:34.883Z","etag":null,"topics":["bbcode","markdown","nexusmods"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ceejbot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-09T01:58:08.000Z","updated_at":"2024-09-20T06:16:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"d998766b-0d04-420c-86e5-0f01411292ed","html_url":"https://github.com/ceejbot/md2nexus","commit_stats":null,"previous_names":["ceejbot/md2nexus"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceejbot%2Fmd2nexus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceejbot%2Fmd2nexus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceejbot%2Fmd2nexus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceejbot%2Fmd2nexus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ceejbot","download_url":"https://codeload.github.com/ceejbot/md2nexus/tar.gz/refs/heads/latest","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250900019,"owners_count":21504984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bbcode","markdown","nexusmods"],"created_at":"2024-11-10T21:32:52.652Z","updated_at":"2025-04-25T21:32:10.017Z","avatar_url":"https://github.com/ceejbot.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# md2nexus\n\nThis is a command-line tool for converting single files or directories of files from Markdown to valid [Nexusmods](https://nexusmods.com) [bbcode](https://wiki.nexusmods.com/index.php/Formating_and_BBCode_in_Descriptions). The Nexus bbcode editors are hell to use if you're writing any complex documentation.\n\nTo install, you can download a MacOS, Linux, or Windows prebuilt executable from [the releases](https://github.com/ceejbot/md2nexus/releases/latest). Or you can use Homebrew:\n\n```shell\nbrew tap ceejbot/tap\nbrew install md2nexus\n```\n\nIf you have rust installed and prefer to build from source:\n\n```shell\ngh repo clone ceejbot/md2nexus\ncd md2nexus\ncargo build --release\n\n# once installed:\nmd2nexus --help\n```\n\n## Usage\n\nSimplest possible usage:\n\n```shell\ncat docs.md | md2nexus \u003e docs.bbcode\n# or\ncat docs.md | md2nexus | pbcopy\n# and then paste into the nexus editor\n```\n\nIf you don't specify an input file, `md2nexus` reads stdin. If you don't specify an output file, `md2nexus` writes the converted text to stdout. It prints nothing to stdout other than program output.\n\nIf the input option is a _directory_, `md2nexus` converts all markdown files in the input directory and writes them to the output option, which must be a directory. If you do not specify an output directory, it writes them to the current directory. It prints the names of converted files to stdout.\n\n## Notes on conversion\n\nMarkdown is far more expressive than Nexus bbcode, which is a stunted bbcode variation. This tool converts some Markdown concepts to code blocks to make them work. For example, to handle Markdown tables, this tool uses a table output formatter intended for terminal usage and wraps it all in a code block.\n\nGithub-flavored markdown is supported. [MDX](https://mdxjs.com) is not supported at all, as Nexus bbcode doesn't allow components or javascript or indeed any potentially dangerous user-generated content.\n\nIn-document references such as footnotes or link references are not converted into usable links, but they are emitted into the text. [^note1]\n\n## Full usage\n\n```text\n$ md2nexus -h\nA command-line tool to convert gfm markdown to NexusMods-flavored bbcode\n\nUsage: md2nexus [OPTIONS]\n\nOptions:\n  -i, --input \u003cPATHNAME\u003e           Path to an input file or directory.\n                                   If omitted, input is read from stdin.\n  -o, --output \u003cPATHNAME\u003e          Path to an output file or directory\n  -c, --completions \u003cCOMPLETIONS\u003e  Emit completion data for your preferred shell [possible values:\n                                   bash, elvish, fish, powershell, zsh]\n      --license                    Print GPL-3.0 license information\n  -h, --help                       Print help (see more with '--help')\n  -V, --version                    Print version\n```\n\n## Implementation notes\n\nThe heavy lifting is done by the [markdown](https://lib.rs/crates/markdown) crate, which generates an AST for input documents. The tool visits the tree's nodes and generates appropriate bbcode.\n\n[^note1]: This is an example footnote. It's better than nothing?\n\n## LICENSE\n\nGPL-3.0.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceejbot%2Fmd2nexus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceejbot%2Fmd2nexus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceejbot%2Fmd2nexus/lists"}