Terbium-135

Terbium-135

VSCode: Embedded language (markdown) for @doc, @moduledoc, @typedoc - thoughts on getting syntax highlighting?

We were talking about this over at discord, perhaps somebody in this forum has more insight or already did that. Just trying to enlarge the audience here.

Given the fact that @doc, @moduledoc, @typedoc comments can contain MD it would be nice to get at least syntax highlighting (if not even more functionality) in VSCode.

Not sure about how other editors are handling this.

To do the editing right now:

  • I am copy/pasting these (well only the bigger ones) into a separate file with the proper .md ending
  • Open that file, edit and do a markdown preview sometimes
  • Copy back into elixir source file

@Blond11516 and @lukaszsamson discovered that VSCode is leaking markdown into elixir code.
https://github.com/lexical-lsp/vscode-lexical/issues/87

But it would be so nice to look at the latter while writing/extending documentation (Note: you can see markdown leaking here into elixir:

With best regards

Marked As Solved

steffend

steffend

Phoenix Core Team

Heyo, not an expert on TextMate grammars, but I recently did some research on while patterns, which should help. I commented in the linked issue. Maybe that helps!

Also Liked

Terbium-135

Terbium-135

Thank you @steffend !
This is looking great so far:

Now writing documentation is even more fun! :stuck_out_tongue_winking_eye:

Last Post!

Terbium-135

Terbium-135

Thank you @steffend !
This is looking great so far:

Now writing documentation is even more fun! :stuck_out_tongue_winking_eye:

Where Next?

Popular in Questions Top

rms.mrcs
Hi, I need to transform a list of numbers into a map where the keys are the indexes and the values are the original values of the list. ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New
Lily
In templates/appointment/index.html.eex: <%= for appointment <- @appointments do %> <tr> <td><%= appoi...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
Harrisonl
We have an ECS cluster with 4 services, where each task joins a single cluster, via discovery ECS discovery service. Currently when I de...
New
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New

Other popular topics Top

electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
AstonJ
Posting this to see if we can make things easier for people to get into Neovim. If you use Neovim and have a favourite distro please let ...
New

We're in Beta

About us Mission Statement