livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2025-10-04 10:44:30 +08:00
Code Issues Projects Releases Packages Wiki Activity

Remove 'Rendering as Markdown' section (#1391)

Browse source 
`.livemd` extension was added to github/linguist project in May 2022
(see this PR for details https://github.com/github/linguist/pull/5672).
This commit is contained in:
Sergey Kuznetsov 2022-09-05 22:47:45 +02:00 • committed by GitHub
parent eeadb0811b
commit 8a76d31f93
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -213,24 +213,6 @@ variables used by Elixir releases are also available](
https://hexdocs.pm/mix/Mix.Tasks.Release.html#module-environment-variables).
The notables ones are `RELEASE_NODE` and `RELEASE_DISTRIBUTION`.
## Rendering notebooks as Markdown on GitHub
By default GitHub renders the `.livemd` notebooks as regular text files. Depending
on your use case and the target audience, you may find it useful to render notebooks
content as Markdown files instead. There is an option to override how a particular
file gets rendered on GitHub, so all you need to do is add a magic comment in every
such notebook:
```
<!-- vim: set syntax=markdown: -->
# My notebook
...
```
For more details see [the documentation](https://github.com/github/linguist/blob/master/docs/overrides.md#using-emacs-or-vim-modelines).
## Development
Livebook is primarily a Phoenix web application and can be setup as such: