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

Generate opam file, dune.3, omd.2.0.0~alpha3, emit tables! #15

Merged
merged 2 commits into from
Feb 16, 2023

Conversation

MisterDA
Copy link
Contributor

@MisterDA MisterDA commented Feb 10, 2023

Emit tables using the odoc-parser "heavy" syntax (slightly easier than
the light syntax, similar to GitHub Flavored Markdown). Syntax for
alignment isn't yet defined.

ocaml-doc/odoc-parser#11

Emit tables using the odoc-parser "heavy" syntax (slightly easier than
the light syntax, similar to GitHub Flavored Markdown). Syntax for
alignment isn't yet defined.
@MisterDA MisterDA changed the title Generate opam file, update to Dune 3 and omd.2.0.0~alpha3 Generate opam file, dune.3, omd.2.0.0~alpha3, emit tables! Feb 14, 2023
@mseri
Copy link
Owner

mseri commented Feb 14, 2023

Thanks a lot!

@MisterDA
Copy link
Contributor Author

You could emit the "light" syntax instead which preserves alignment, but the code would be a tad more complex.

{t | title 1             | title 2 |
   |--------------------:|---------|
   |              a cell | cell    |
   | {e emphasized cell} | cell    | }

@mseri
Copy link
Owner

mseri commented Feb 15, 2023

I don't mind either way. I think we can stick with this for the moment, and revise it once the syntax for alignment is finalized and released. What do you think?

@@ -41,3 +41,4 @@ another code block?
{!module:Module} <-- An explicit cross reference

{!Module} <-- An inferred cross reference
{table {tr {th foo}{th bar}{th tut}}{tr {td {e baz}}{td bim}{td [who]}}{tr {td per}{td {b lol}}{td dit}}}
Copy link
Owner

@mseri mseri Feb 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we enforce that the table is isolated from the surrounding content by empty lines?

@mseri mseri merged commit b5cf1ef into mseri:master Feb 16, 2023
@MisterDA MisterDA deleted the updates branch February 16, 2023 23:12
@mseri
Copy link
Owner

mseri commented Feb 17, 2023

I will make a release once tables are supported by odoc as well

mseri added a commit to mseri/opam-repository that referenced this pull request May 1, 2023
CHANGES:

- Add option to dump OMD ast as sexp for debugging ([mseri/md2mld#20](mseri/md2mld#20) MisterDA)
- Support code block language tags ([mseri/md2mld#19](mseri/md2mld#19) MisterDA)
- Add support for odoc heavy table syntax ([mseri/md2mld#15](mseri/md2mld#15) MisterDA)
mseri added a commit to mseri/opam-repository that referenced this pull request May 1, 2023
CHANGES:

- Add option to dump OMD ast as sexp for debugging ([mseri/md2mld#20](mseri/md2mld#20) MisterDA)
- Support code block language tags ([mseri/md2mld#19](mseri/md2mld#19) MisterDA)
- Add support for odoc heavy table syntax ([mseri/md2mld#15](mseri/md2mld#15) MisterDA)
toots pushed a commit to savonet/opam-repository that referenced this pull request May 10, 2023
CHANGES:

- Add option to dump OMD ast as sexp for debugging ([mseri/md2mld#20](mseri/md2mld#20) MisterDA)
- Support code block language tags ([mseri/md2mld#19](mseri/md2mld#19) MisterDA)
- Add support for odoc heavy table syntax ([mseri/md2mld#15](mseri/md2mld#15) MisterDA)
toots pushed a commit to savonet/opam-repository that referenced this pull request May 11, 2023
CHANGES:

- Add option to dump OMD ast as sexp for debugging ([mseri/md2mld#20](mseri/md2mld#20) MisterDA)
- Support code block language tags ([mseri/md2mld#19](mseri/md2mld#19) MisterDA)
- Add support for odoc heavy table syntax ([mseri/md2mld#15](mseri/md2mld#15) MisterDA)
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.

2 participants