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

Add support for Literate Juvix Markdown #2448

Merged
merged 2 commits into from
Nov 10, 2023
Merged

Add support for Literate Juvix Markdown #2448

merged 2 commits into from
Nov 10, 2023

Conversation

jonaprieto
Copy link
Collaborator

@jonaprieto jonaprieto commented Oct 17, 2023

This PR adds an initial support for Literate Juvix Markdown files, files with the extension .juvix.md.

Here is a small example of such a file: Test.juvix.md.

# This is a heading
Lorem ...

```juvix
module Test;

type A := a;

fun : A -> A 
 | _ := a;
```
Other text

This initial support enables users to execute common commands such as typechecking, compilation, and HTML generation. Additionally, a new command called markdown has been introduced. This command replaces code blocks marked with the juvix attribute with their respective HTML output, much like the output we obtain when running juvix html. In this version, comments are ignored in the output, including judoc blocks.

2023-10-30.15.28.03.mp4

Future work

Open as issues once this PR is merged, we can work on the following:

.repos Outdated Show resolved Hide resolved
@jonaprieto jonaprieto force-pushed the markdown branch 6 times, most recently from 53bbe20 to ce2a179 Compare November 7, 2023 23:22
@jonaprieto jonaprieto marked this pull request as ready for review November 8, 2023 09:16
@jonaprieto jonaprieto merged commit bd16d3e into main Nov 10, 2023
4 checks passed
@jonaprieto jonaprieto deleted the markdown branch November 10, 2023 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integration of Juvix with Mdbook for Juvix Excerpts Syntax coloring in the documentation
2 participants