Add .livemd extension to Markdown language #5672
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've fixed the ordering to get the tests passing. Unfortunately, we can't merge this yet as the extension isn't popular enough yet: Total files found: 645 |
lildude
changed the title
.livemd extension to Markdown language
lildude
approved these changes
May 25, 2022
|
I always save my Livebook files on GitHub as .md because I don't want to loose syntax highlighting. |
cr0t
added a commit
to cr0t/livebook
that referenced
this pull request
Sep 5, 2022
`.livemd` extension was added to github/linguist project in May 2022 (see this PR for details github-linguist/linguist#5672). Since this time GitHub treats all `.livemd` files as Markdown, and this section is redundant (or even a little bit misleading).
jonatanklosko
pushed a commit
to livebook-dev/livebook
that referenced
this pull request
Sep 5, 2022
`.livemd` extension was added to github/linguist project in May 2022 (see this PR for details github-linguist/linguist#5672).
techknowlogick
added a commit
to go-gitea/gitea
that referenced
this pull request
Apr 26, 2023
## Needs and benefits [Livebook](https://livebook.dev/) notebooks are used for code documentation and for deep dives and note-taking in the elixir ecosystem. Rendering these in these as Markdown on frogejo has many benefits, since livemd is a subset of markdown. Some of the benefits are: - New users of elixir and livebook are scared by unformated .livemd files, but are shown what they expect - Sharing a notebook is as easy as sharing a link, no need to install the software in order to see the results. [goldmark-meraid ](https://github.com/abhinav/goldmark-mermaid) is a mermaid-js parser already included in gitea. This makes the .livemd rendering integration feature complete. With this PR class diagrams, ER Diagrams, flow charts and much more will be rendered perfectly. With the additional functionality gitea will be an ideal tool for sharing resources with fellow software engineers working in the elixir ecosystem. Allowing the git forge to be used without needing to install any software. ## Feature Description This issue requests the .livemd extension to be added as a Markdown language extension. - `.livemd` is the extension of Livebook which is an Elixir version of Jupyter Notebook. - `.livemd` is` a subset of Markdown. This would require the .livemd to be recognized as a markdown file. The Goldmark the markdown parser should handle the parsing and rendering automatically. Here is the corresponding commit for GitHub linguist: github-linguist/linguist#5672 Here is a sample page of a livemd file: https://github.com/github/linguist/blob/master/samples/Markdown/livebook.livemd ## Screenshots The first screenshot shows how github shows the sample .livemd in the browser. The second screenshot shows how mermaid js, renders my development notebook and its corresponding ER Diagram. The source code can be found here: https://codeberg.org/lgh/Termi/src/commit/79615f74281789a1f2967b57bad0c67c356cef1f/termiNotes.livemd ## Testing I just changed the file extension from `.livemd`to `.md`and the document already renders perfectly on codeberg. Check you can it out [here](https://codeberg.org/lgh/Termi/src/branch/livemd2md/termiNotes.md) --------- Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds
.livemdextension toMarkdownlanguage..livemdis the extension of Livebook which is an Elixir version of Jupyter..livemdis a subset of Markdown..livemdcan be displayed as Markdown on GitHub when.livemdhas<!-- vim: syntax=markdown -->at the first line of it (Example), but it's not a default option of.livemd.Checklist: