{"id":23871263,"url":"https://github.com/darakian/mini_markdown","last_synced_at":"2025-09-08T20:32:34.862Z","repository":{"id":37784492,"uuid":"352441437","full_name":"darakian/mini_markdown","owner":"darakian","description":"Dependency free markdown ","archived":false,"fork":false,"pushed_at":"2024-03-21T22:45:29.000Z","size":334,"stargazers_count":19,"open_issues_count":2,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-21T17:11:41.791Z","etag":null,"topics":["hacktoberfest","html","markdown"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/darakian.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":"2021-03-28T21:22:02.000Z","updated_at":"2024-12-02T13:09:31.000Z","dependencies_parsed_at":"2023-01-22T16:01:12.276Z","dependency_job_id":null,"html_url":"https://github.com/darakian/mini_markdown","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darakian%2Fmini_markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darakian%2Fmini_markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darakian%2Fmini_markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darakian%2Fmini_markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darakian","download_url":"https://codeload.github.com/darakian/mini_markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232347874,"owners_count":18509292,"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":["hacktoberfest","html","markdown"],"created_at":"2025-01-03T14:30:47.283Z","updated_at":"2025-01-03T14:31:07.544Z","avatar_url":"https://github.com/darakian.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mini_markdown\nA dependency free markdown renderer.\n___\nThe design goal of this project is to provide a dependency free, feature complete markdown to html renderer.\nAll output is sanitized and any script injection vector is considered a bug.\n\n## Status\nMarkdown support is now feature complete with testing ongoing.   \nPlease report bugs as issues should you find any.  \nAll output and interfaces are considered unstable for the time being.\n\n\n## Usage\nThe primary function in this library is the `render` function.\n```\npub fn render(source: \u0026str) -\u003e String {\n    parse(lex(source))\n}\n```\nIf all you want is to take markdown and get html `render` is your function. If you want to work with the internal structure the `parse` and `lex` functions are public.\n\n## Syntax\n### Headings\nHeadings are supported with the `#` syntax only. Up to six levels are supported\n### Paragraphs\nOne or more lines separating text will begin a new paragraph\n### Line breaks\nTwo or more spaces at the end of a line will add a `\u003cbr\u003e`\n### Italic text\nText surrounded by any pairing of `*` and `_` will be italicized\n```\n*text*, _text_, *text_ or _text*\n```\n### Bold text\nText surrounded by any pairing of two `*` and/or `_` will be bolded\n### Bold Italic text\nText surrounded by any pairing of three `*` and/or `_` will be bolded and italicized\n### Blockquotes and nested block quotes\nBlockquotes and nested block quotes are supported using the `\u003e` character\n```\n\u003e Some quoted text\n\u003e\u003e Some quoted text in a nested quote\n\u003e Some more text in the outer quote\n```\n### Ordered Lists\nOrdered lists are supported by numbering new lines\n```\n1. One\n2. Two\n3. Three\n```\nMax length is 9 elements\n### Unordered lists \nUnordered lists are supported by starting a line with `-`, `+`, or `*`\n```\n* Some\n- list\n+ text\n```\n### Inline code\nInline code is supported by encapsulating text in two \\` characters\n### Code blocks\nCode blocks are supported by either indenting lines with four spaces or by encapsulating lines with three \\` characters before and after.\n### Images\nImages are supported with the following syntax `![Hover text](link)`\n### Links\nLinks are supported with the following syntax `[Text](link)`\n### Quick links\nUrl or email text can be made into a link by enclosing the text in angle brackets `\u003c`text`\u003e`\n### Horizontal rules\nHorizontal rules are supported with three or more `*`, `-`, or `_` characters alone on a line\n```\n****\n-----\nor\n______\n```\n### Escaping characters\nControl characters can be escaped by preceding them with a backslash `\\`\n\n### Collapsable sections\nCollapsable sections are supported and follow the html for a `details` section.\n```\n\u003cdetails\u003e\n\u003csummary\u003eSummary text\u003c/summary\u003e\nText\n\u003c/details\u003e\n```\nWill render as \n\u003cdetails\u003e\n\u003csummary\u003eSummary text\u003c/summary\u003e\nText\n\u003c/details\u003e\n\n### Tables\nHTML tables are supported with the following\n```\n| Syntax      | Description | Test Text     |\n| :---        |    :----:   |          ---: |\n| Header      | Title       | Here's this   |\n| Paragraph   | Text        | And more      |\n```\n\nwhich renders as\n\n| Syntax      | Description | Test Text     |\n| :---        |    :----:   |          ---: |\n| Header      | Title       | Here's this   |\n| Paragraph   | Text        | And more      |\n\nThe `:` character will define the alignments as shown.\n\n### Footnotes\nReferences with text tags are supported for both inline footnotes and multiline big footnotes.  \nFor example\n```\nHere's a simple footnote,[^1] and here's a longer one.[^bignote]\n[^1]: This is the first footnote.\n\n[^bignote]: Here's one with multiple paragraphs and code.\n\n    Indent paragraphs to include them in the footnote.\n\n    `{ my code }`\n\n    Add as many paragraphs as you like.\n\n```\nrenders as  \n\nHere's a simple footnote,[^1] and here's a longer one.[^bignote]\n[^1]: This is the first footnote.\n\n[^bignote]: Here's one with multiple paragraphs and code.\n\n    Indent paragraphs to include them in the footnote.\n\n    `{ my code }`\n\n    Add as many paragraphs as you like.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarakian%2Fmini_markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarakian%2Fmini_markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarakian%2Fmini_markdown/lists"}