Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start adding markdown #3643

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

HansOlsson
Copy link
Collaborator

This is just intended as a starting point for the discussion.
Closes #3636

Unclear points:

  • Compatibility? Should we reserve <...> for future extensions?
  • Specification of GitHub flavored markdown (especially as they don't update their own documentation).
  • Reference KaTeX as sub-set of LaTeX-math?
  • More?

@maltelenz
Copy link
Collaborator

In my opinion we need to be more specific about the flavor. Github could change their implementation at any time, and what would that mean? The MLS should point to a well defined specification.

@HansOlsson
Copy link
Collaborator Author

HansOlsson commented Jan 27, 2025

In my opinion we need to be more specific about the flavor. Github could change their implementation at any time, and what would that mean? The MLS should point to a well defined specification.

We could say Version 0.29-gfm of https://github.github.com/gfm/ (note in particular the extensions; they are marked with "extension" in the table-of-contents) with display math using $$ ... $$.

Unfortunately I cannot find an updated specification for what they currently have implemented.

Note: The math was announced in https://github.blog/news-insights/product-news/math-support-in-markdown/ with separate documentation https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions

@HansOlsson HansOlsson marked this pull request as ready for review January 29, 2025 13:57
@HansOlsson
Copy link
Collaborator Author

With the reference I believe it is now ready for review.

I didn't reserve other tags (in addition to HTML) - the reason is that I don't know whether potential new formats would use tags or something else. In case it is something else I guess we could do something like annotation(Documentation(info=..., format="SomethingElse"));

@HansOlsson HansOlsson added this to the 2025-February milestone Feb 5, 2025
@HansOlsson
Copy link
Collaborator Author

Investigate if markdown 0.29 (without GitHub flavor) works as well: Tables is the most important extension (strikethrough and task lists seem unimportant).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Standardizing the use of Markdown and LaTeX for the documentation layer
2 participants