{"id":16965004,"url":"https://github.com/propensive/punctuation","last_synced_at":"2025-04-11T23:02:36.075Z","repository":{"id":39483212,"uuid":"316214845","full_name":"propensive/punctuation","owner":"propensive","description":"Typesafe parsing and rendering of markdown in Scala","archived":false,"fork":false,"pushed_at":"2025-02-11T23:49:19.000Z","size":1975,"stargazers_count":7,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T07:46:37.065Z","etag":null,"topics":["markdown","md","parser","scala"],"latest_commit_sha":null,"homepage":"https://propensive.com/punctuation/","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/propensive.png","metadata":{"files":{"readme":".github/readme.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"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":"2020-11-26T11:48:34.000Z","updated_at":"2025-02-11T23:49:23.000Z","dependencies_parsed_at":"2024-02-11T20:54:03.367Z","dependency_job_id":"b882f9b7-1c8c-4225-868b-a609436410c9","html_url":"https://github.com/propensive/punctuation","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fpunctuation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fpunctuation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fpunctuation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fpunctuation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/punctuation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248492874,"owners_count":21113163,"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":["markdown","md","parser","scala"],"created_at":"2024-10-13T23:44:48.965Z","updated_at":"2025-04-11T23:02:36.044Z","avatar_url":"https://github.com/propensive.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg alt=\"GitHub Workflow\" src=\"https://img.shields.io/github/actions/workflow/status/propensive/punctuation/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/punctuation/actions)\n[\u003cimg src=\"https://img.shields.io/discord/633198088311537684?color=8899f7\u0026label=DISCORD\u0026style=for-the-badge\" height=\"24\"\u003e](https://discord.com/invite/MBUrkTgMnA)\n\u003cimg src=\"/doc/images/github.png\" valign=\"middle\"\u003e\n\n# Punctuation\n\n__Typesafe parsing and rendering of markdown__\n\n_Punctuation_ provides a convenient representation of Markdown which disambiguates between inline-\nand block-level content, with converters to\n[Honeycomb](https://github.com/propensive/honeycomb) HTML and\n[Escapade](https://github.com/propensive/escapade) ANSI-rendered text.\n\n## Features\n\n- parse Markdown content\n- use different types for inline- and block-level content\n- static typechecking of Markdown using interpolated strings\n- support for substitutions of different types as formatted Markdown\n- simple Scala AST representing Markdown\n- convert inline- or block-level Markdown to HTML (using Honeycomb)\n- convert Markdown to styled ANSI terminal text (using Escapade)\n\n\n## Availability\n\n\n\n\n\n\n\n## Getting Started\n\nMarkdown may be read from a source such as a string or file with the `Markdown.parse` method. For example,\n```scala\nimport punctuation.*\nval md = Markdown.parse(t\"## This is a subheading\")\n```\nwill return an instance of `Markdown[Block]`, which is a wrapper for a sequence of block-level Markdown\nAST elements. In the example above, the result would be equal to,\n`Markdown(Heading(2, Textual(t\"This is a subheading\")))`.\n\nBlock-level AST elements are:\n- `ThematicBreak()`\n- `Paragraph(inline*)`\n- `Heading(level, inline*)`\n- `FencedCode(lang, meta, text)`\n- `BulletList(numbered, loose, items*)`\n- `BlockQuote(block*)`\n- `Reference(id, location)`\n- `Table(parts*)`\n\nUsing [Honeycomb](https://github.com/propensive/honeycomb/) a `Markdown[Block]` instance may be converted\nto HTML just by calling the `html` extension method on it. This extension method returns an instance of\n`Seq[Html[Flow]]`.\n\n### Inline Markdown\n\nOften block-level Markdown elements are not desired, and the subset of Markdown that is valid in \"inline\"\ncontexts is required. The `Markdown.parseInline` method will parse an inline fragment of Markdown, returning\nan instance of `Markdown[Inline]`.\n\nInline AST elements are:\n- `Break()`\n- `Emphasis(inline*)`\n- `HtmlNode(text)`\n- `Image(alt, src)`\n- `Code(text)`\n- `Strong(inline*)`\n- `Textual(text)`\n- `Link(location, inline*)`\n\nLikewise, a `Markdown[Inline]` instance can be converted to HTML with the `html` extension method. Since\ninline Markdown uses a more limited set of HTML tags, this method returns a `Seq[Html[Phrasing]]` which\nallows it to be embedded within nodes such as `P`, which would not be the case for block-level Markdown\nconverted to HTML.\n\n### `md\"\"` Interpolator\n\nIn addition to parsing Markdown at runtime, it's possible to construct Markdown literals with the `md\"\"`\ninterpolator. This is as simple as writing markdown inside quotes preceded by `md`, and it will be\nparsed at compiletime. For example, `md\"This is _emphasised_.\"`\n\nThe type of a `md\"\"` literal will depend upon its content. If it includes block-level elements, its\nreturn type will be `Markdown[Block]`, whereas if it uses only inline elements, it will be typed as\n`Markdown[Inline]`.\n\nAny errors in the Markdown content will be detected at compiletime, causing compile errors.\n\nSubstitutions into Markdown literals are also supported, provided the type of the substitution can be\nconverted to Markdown, and can appear at the position it's substituted. Conversion of a particular type\nto Markdown is permitted by the existence of a contextual typeclass instance.\n\n\n\n\n\n## Status\n\nPunctuation is classified as __fledgling__. For reference, Soundness projects are\ncategorized into one of the following five stability levels:\n\n- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity\n- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns\n- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement\n- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later\n- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipated\n\nProjects at any stability level, even _embryonic_ projects, can still be used,\nas long as caution is taken to avoid a mismatch between the project's stability\nlevel and the required stability and maintainability of your own project.\n\nPunctuation is designed to be _small_. Its entire source code currently consists\nof 704 lines of code.\n\n## Building\n\nPunctuation will ultimately be built by Fury, when it is published. In the\nmeantime, two possibilities are offered, however they are acknowledged to be\nfragile, inadequately tested, and unsuitable for anything more than\nexperimentation. They are provided only for the necessity of providing _some_\nanswer to the question, \"how can I try Punctuation?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Punctuation's build\n   structure, dependencies and source location; the file format should be short\n   and quite intuitive. Copy the sources into a source directory in your own\n   project, then repeat (recursively) for each of the dependencies.\n\n   The sources are compiled against the latest nightly release of Scala 3.\n   There should be no problem to compile the project together with all of its\n   dependencies in a single compilation.\n\n2. *Build with [Wrath](https://github.com/propensive/wrath/)*\n\n   Wrath is a bootstrapping script for building Punctuation and other projects in\n   the absence of a fully-featured build tool. It is designed to read the `fury`\n   file in the project directory, and produce a collection of JAR files which can\n   be added to a classpath, by compiling the project and all of its dependencies,\n   including the Scala compiler itself.\n   \n   Download the latest version of\n   [`wrath`](https://github.com/propensive/wrath/releases/latest), make it\n   executable, and add it to your path, for example by copying it to\n   `/usr/local/bin/`.\n\n   Clone this repository inside an empty directory, so that the build can\n   safely make clones of repositories it depends on as _peers_ of `punctuation`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Punctuation's dependencies.\n\n   If the build was successful, the compiled JAR files can be found in the\n   `.wrath/dist` directory.\n\n## Contributing\n\nContributors to Punctuation are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/punctuation/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Punctuation\neasier.\n\nPlease __do not__ contact project maintainers privately with questions unless\nthere is a good reason to keep them private. While it can be tempting to\nrepsond to such questions, private answers cannot be shared with a wider\naudience, and it can result in duplication of effort.\n\n## Author\n\nPunctuation was designed and developed by Jon Pretty, and commercial support and\ntraining on all aspects of Scala 3 is available from [Propensive\nO\u0026Uuml;](https://propensive.com/).\n\n\n\n## Name\n\nTo _punctuate_ is \"to mark with points\" (or more specifically, symbolic characters) and also, \"to stress or single out as important\", which describes Markdown in both the literal sense that punctuation characters are added to text, and in the figurative sense that this punctuates a document with stress and other styled emphasis.\n\nIn general, Soundness project names are always chosen with some rationale,\nhowever it is usually frivolous. Each name is chosen for more for its\n_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no\nbias towards names with positive or \"nice\" meanings—since many of the libraries\nperform some quite unpleasant tasks.\n\nNames should be English words, though many are obscure or archaic, and it\nshould be noted how willingly English adopts foreign words. Names are generally\nof Greek or Latin origin, and have often arrived in English via a romance\nlanguage.\n\n## Logo\n\nThe logo shows a downward arrow overlaid on a capital letter M, representing the \"*M*ark-down\" format.\n\n## License\n\nPunctuation is copyright \u0026copy; 2025 Jon Pretty \u0026 Propensive O\u0026Uuml;, and\nis made available under the [Apache 2.0 License](/license.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fpunctuation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Fpunctuation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fpunctuation/lists"}