{"id":13614664,"url":"https://github.com/yuin/goldmark-meta","last_synced_at":"2025-04-05T03:11:58.442Z","repository":{"id":40652738,"uuid":"189385092","full_name":"yuin/goldmark-meta","owner":"yuin","description":"A YAML metadata extension for the goldmark markdown parser.","archived":false,"fork":false,"pushed_at":"2022-03-17T12:36:07.000Z","size":17,"stargazers_count":83,"open_issues_count":4,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T02:08:24.348Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yuin.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}},"created_at":"2019-05-30T09:28:10.000Z","updated_at":"2025-02-17T04:47:52.000Z","dependencies_parsed_at":"2022-08-10T00:01:00.344Z","dependency_job_id":null,"html_url":"https://github.com/yuin/goldmark-meta","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuin%2Fgoldmark-meta","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuin%2Fgoldmark-meta/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuin%2Fgoldmark-meta/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuin%2Fgoldmark-meta/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuin","download_url":"https://codeload.github.com/yuin/goldmark-meta/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247280272,"owners_count":20912967,"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":[],"created_at":"2024-08-01T20:01:04.255Z","updated_at":"2025-04-05T03:11:58.417Z","avatar_url":"https://github.com/yuin.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"goldmark-meta\n=========================\n[![GoDev][godev-image]][godev-url]\n\n[godev-image]: https://pkg.go.dev/badge/github.com/yuin/goldmark-meta\n[godev-url]: https://pkg.go.dev/github.com/yuin/goldmark-meta\n\n\ngoldmark-meta is an extension for the [goldmark](http://github.com/yuin/goldmark) \nthat allows you to define document metadata in YAML format.\n\nUsage\n--------------------\n\n### Installation\n\n```\ngo get github.com/yuin/goldmark-meta\n```\n\n### Markdown syntax\n\nYAML metadata block is a leaf block that can not have any markdown element\nas a child.\n\nYAML metadata must start with a **YAML metadata separator**.\nThis separator must be at first line of the document.\n\nA **YAML metadata separator** is a line that only `-` is repeated.\n\nYAML metadata must end with a **YAML metadata separator**.\n\nYou can define objects as a 1st level item. At deeper level, you can define \nany kind of YAML element.\n\nExample:\n\n```\n---\nTitle: goldmark-meta\nSummary: Add YAML metadata to the document\nTags:\n    - markdown\n    - goldmark\n---\n\n# Heading 1\n```\n\n\n### Access the metadata\n\n```go\nimport (\n    \"bytes\"\n    \"fmt\"\n    \"github.com/yuin/goldmark\"\n    \"github.com/yuin/goldmark/extension\"\n    \"github.com/yuin/goldmark/parser\"\n    \"github.com/yuin/goldmark-meta\"\n)\n\nfunc main() {\n    markdown := goldmark.New(\n        goldmark.WithExtensions(\n            meta.Meta,\n        ),\n    )\n    source := `---\nTitle: goldmark-meta\nSummary: Add YAML metadata to the document\nTags:\n    - markdown\n    - goldmark\n---\n\n# Hello goldmark-meta\n`\n\n    var buf bytes.Buffer\n    context := parser.NewContext()\n    if err := markdown.Convert([]byte(source), \u0026buf, parser.WithContext(context)); err != nil {\n        panic(err)\n    }\n    metaData := meta.Get(context)\n    title := metaData[\"Title\"]\n    fmt.Print(title)\n}\n```\n\nOr `WithStoresInDocument` option:\n\n```go\nimport (\n    \"bytes\"\n    \"fmt\"\n    \"github.com/yuin/goldmark\"\n    \"github.com/yuin/goldmark/extension\"\n    \"github.com/yuin/goldmark/parser\"\n    \"github.com/yuin/goldmark/text\"\n    \"github.com/yuin/goldmark-meta\"\n)\n\nfunc main() {\n\tmarkdown := goldmark.New(\n\t\tgoldmark.WithExtensions(\n\t\t\tmeta.New(\n\t\t\t\tmeta.WithStoresInDocument(),\n\t\t\t),\n\t\t),\n\t)\n\tsource := `---\nTitle: goldmark-meta\nSummary: Add YAML metadata to the document\nTags:\n    - markdown\n    - goldmark\n---\n`\n\n\tdocument := markdown.Parser().Parse(text.NewReader([]byte(source)))\n\tmetaData := document.OwnerDocument().Meta()\n\ttitle := metaData[\"Title\"]\n\tfmt.Print(title)\n}\n```\n\n### Render the metadata as a table\n\nYou need to add `extension.TableHTMLRenderer` or the `Table` extension to\nrender metadata as a table.\n\n```go\nimport (\n    \"bytes\"\n    \"fmt\"\n    \"github.com/yuin/goldmark\"\n    \"github.com/yuin/goldmark/extension\"\n    \"github.com/yuin/goldmark/parser\"\n    \"github.com/yuin/goldmark/renderer\"\n    \"github.com/yuin/goldmark/util\"\n    \"github.com/yuin/goldmark-meta\"\n)\n\nfunc main() {\n    markdown := goldmark.New(\n        goldmark.WithExtensions(\n            meta.New(meta.WithTable()),\n        ),\n        goldmark.WithRendererOptions(\n            renderer.WithNodeRenderers(\n                util.Prioritized(extension.NewTableHTMLRenderer(), 500),\n            ),\n        ),\n    )\n    // OR\n    // markdown := goldmark.New(\n    //     goldmark.WithExtensions(\n    //         meta.New(meta.WithTable()),\n    //         extension.Table,\n    //     ),\n    // )\n    source := `---\nTitle: goldmark-meta\nSummary: Add YAML metadata to the document\nTags:\n    - markdown\n    - goldmark\n---\n\n# Hello goldmark-meta\n`\n\n    var buf bytes.Buffer\n    if err := markdown.Convert([]byte(source), \u0026buf); err != nil {\n        panic(err)\n    }\n    fmt.Print(buf.String())\n}\n```\n\n\nLicense\n--------------------\nMIT\n\nAuthor\n--------------------\nYusuke Inuzuka\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuin%2Fgoldmark-meta","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuin%2Fgoldmark-meta","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuin%2Fgoldmark-meta/lists"}