Skip to content
This repository has been archived by the owner on Sep 21, 2024. It is now read-only.
This repository has been archived by the owner on Sep 21, 2024. It is now read-only.

Consider making Subtext MAYA #31

Open
@gordonbrander

Description

Umbrella for considering

The value would be in trying to hit a MAYA (most advanced yet acceptable) threshold of "good enough" surface-level similarity to the unofficial Markdown flavors used by popular wikis and TfTs, while retaining the advantage of having a flat list block model.

Goals:

  • Surface-level similarity to some markup features used in Markdown-flavored wikis and TfTs.
  • "Mostly working" for the simplest markdown/wikilink markup cases. This will be a subjective criteria.

Non-goals:

  • Compatibility. It is a non-goal to implement 1:1 feature compatibility with Markdown or Obsidian
  • Strict subsetting. It is a non-goal to implement strict subset compatibility. This would be a "mostly works due to passing resemblance" kind of thing. The value is in the familiarity, not in 1:1 semantic equivalency.

Subtext deliberately takes a fundamentally different, line-oriented parsing strategy that enables you to treat lines as a flat list of blocks. This means that while it has a passing resemblance to Markdown, it will always be subtly different from Markdown at a deeper level (by design!)

Tradeoffs:

  • Pro: conformability with existing infrastructure
  • Pro: known/proven set of features (although I think many of these, such as deep headings are long-tail)
  • Con: complicates Subtext
  • Con: not a strict subset. There will be edge-cases.
  • Con: adds an additional linking flavor

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions