{"id":15048734,"url":"https://github.com/mandelsoft/mdref","last_synced_at":"2026-02-08T22:03:08.104Z","repository":{"id":208492007,"uuid":"721692707","full_name":"mandelsoft/mdref","owner":"mandelsoft","description":"Process a folder tree with markdown files containing logical tags to generate appropriate link targets.","archived":false,"fork":false,"pushed_at":"2025-04-28T15:17:58.000Z","size":46,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-09T17:43:54.884Z","etag":null,"topics":["generator","golang","markdown"],"latest_commit_sha":null,"homepage":"","language":"Go","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/mandelsoft.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,"zenodo":null}},"created_at":"2023-11-21T15:24:57.000Z","updated_at":"2025-04-28T14:19:24.000Z","dependencies_parsed_at":"2023-11-24T13:42:53.847Z","dependency_job_id":"c0a86654-b599-45ec-b15d-5f67c4766d86","html_url":"https://github.com/mandelsoft/mdref","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"9412a821d781c32afee92a439071603c98bb0b90"},"previous_names":["mandelsoft/mdref"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/mandelsoft/mdref","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mandelsoft%2Fmdref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mandelsoft%2Fmdref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mandelsoft%2Fmdref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mandelsoft%2Fmdref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mandelsoft","download_url":"https://codeload.github.com/mandelsoft/mdref/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mandelsoft%2Fmdref/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29246439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-08T21:42:34.334Z","status":"ssl_error","status_checked_at":"2026-02-08T21:41:38.468Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["generator","golang","markdown"],"created_at":"2024-09-24T21:15:50.054Z","updated_at":"2026-02-08T22:03:08.041Z","avatar_url":"https://github.com/mandelsoft.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- DO NOT MODIFY                   --\u003e\n\u003c!-- this file is generated by mdref --\u003e\n\u003c!-- from src/README.md              --\u003e\n\n# Markdown Reference Generator\n\nThis markdown reference generator uses\na document tree with markdown files containing\na special annotation syntax for tags and references\nas input and generates an appropriate target tree with\nreferences resolved to consistent Markdown links\nand anchors.\n\n- Never fix headings anymore with corrupting links all over the document tree\n- Never move text blocks or even complete files around in the document tree with corrupting links all over the document tree\n- Use terms all over the document tree, which are automatically linked to their explanation.\n- Provide example documentation consistent with working code.\n\n\n## Command Line Syntax\n\n```shell\n$ mdref {\u003coptions\u003e} [\u003csource dir\u003e [\u003ctarget dir\u003e]]\n\nFlags:\n  --version      just print the program version\n  --help         this help text\n  --headings     prefer using standard heading anchors\n  --skip-execute omit the evaluation of the execute statement (for test purposes, only)\n  --skip-source  omit source reference in generation comment\n  --list         print reference index and usage list\n```\n\nIf called without a target folder a consistency check is\ndone. It checks, that for all used references the appropriate anchors are defined.\n\nIf called with target folder, the source tree\nis evaluated and the generated files are provided in the target folder.\n\nIf the `--list` option is given, additionally the reference index\nand usage list is printed.\n\n\nThe source folder may not only contain markdown files. The generator copies all non-markdown files in the same structure to the target folder.\n\n## What it does\n\nThe command scans a folder tree for markdown files (`.md`) and processes special\n[annotations](#general-annotation-syntax).\nThe result is copied to a target folder preserving the original sub folder hierarchy.\nNon-markdown files are just copied to the target folder tree.\nWhile scanning the source folder tree folders with the name `local` are ignored.\nFiles contained in those folders might be used by special [commands](doc/chapters/commands.md) used in \nprocessed markdown files without being copied to the target folder hierarchy.\n\nProcessing means to resolve [references](#reference-and-anchor-syntax) and evaluate some\n[commands](#commands).\n\n## General Annotation Syntax\n\nAnnotations used by this generator use a common syntax\n\n```\n{{\u003celementsyntax\u003e}[{\u003cargument\u003e}...]}\n```\n\nElements may be [anchors](doc/chapters/references.md#anchors), [term anchors](doc/chapters/terms.md#anchors), [references](doc/chapters/references.md) or [commands](doc/chapters/commands.md).\n\n\n## Reference and Anchor Syntax\n\nAnchors and references are character sequences\nfollowing the regular expression\n\n\u003ca id=\"name\"\u003e\u003c/a\u003e\n\n```regexp\n[a-z][a-z0-9.-]*\n```\n\nThese names are location independent, so content\nmay be copied or even moved into a completely different folder structure without corrupting any link in the generated target folder.\n\nTherefore, the anchors must be globally unique in the\ncomplete document tree.\n\nThe generator supports two kinds of references as well as anchors:\n- [References](doc/chapters/references.md) \n- [Terms](doc/chapters/terms.md)\n\n## Commands\n\nBesides the generation of consistent references among Markdown documents\nthe generator also supports some useful extensions to enrich the content\nof the Markdown file.\n\nSuch *commands* are described by [annotations](#general-annotation-syntax) using\narguments.\n\nThe list of all supported commands can be found [here](doc/chapters/commands.md).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmandelsoft%2Fmdref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmandelsoft%2Fmdref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmandelsoft%2Fmdref/lists"}