mirror of
https://github.com/anoma/juvix.git
synced 2024-09-11 08:15:41 +03:00
Juvix empowers developers to write code in a high-level, functional language, compile it to gas-efficient output VM instructions, and formally verify the safety of their contracts prior to deployment and execution.
bd16d3ef2a
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`. <pre> # This is a heading Lorem ... ```juvix module Test; type A := a; fun : A -> A | _ := a; ``` Other text </pre> 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. - We intend to use this new feature in combination with this Python plugin (https://github.com/anoma/juvix-mkdocs) to enhance our documentation site. https://github.com/anoma/juvix/assets/1428088/a0c17f36-3d76-42cc-a571-91f885866874 ## Future work Open as issues once this PR is merged, we can work on the following: - Support imports of Juvix Markdown modules (update the path resolver to support imports of Literate Markdown files) - Support (Judoc) comments in md Juvix blocks - Support Markdown in Judoc blocks - Update Text editor support, vscode extension and emacs mode (the highlighting info is a few characters off in the current state) - Closes #1839 - Closes #1719 |
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| app | ||
| assets | ||
| bench | ||
| examples | ||
| gnuplot | ||
| include/package/PackageDescription | ||
| juvix-stdlib@708d920c6e | ||
| licenses | ||
| runtime | ||
| src/Juvix | ||
| test | ||
| tests | ||
| .clang-format | ||
| .github_changelog_generator | ||
| .gitignore | ||
| .gitmodules | ||
| .hlint.yaml | ||
| .pre-commit-config.yaml | ||
| cabal.hie.yaml | ||
| cabal.project | ||
| cabal.project.freeze | ||
| CHANGELOG.md | ||
| cntlines.sh | ||
| CONTRIBUTING.md | ||
| LICENSE.md | ||
| Makefile | ||
| migrate-juvix-yaml.sh | ||
| package.yaml | ||
| README.md | ||
| stack.hie.yaml | ||
| stack.yaml | ||
Juvix
| CI Status |
|---|
|
|
|
|
| Codebase |
|
|
|
This repository is specifically dedicated to the compiler of the Juvix programming language.
For any Juvix-related inquiries, we strongly advise visiting the following resources.
Our documentation offers an in-depth understanding of the Juvix programming language. It encompasses a language reference, examples, blog posts, and numerous other resources to facilitate effective use of Juvix.