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.

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:

Where Next?

Popular in Questions Top

Tee
can someone please explain to me how Enum.reduce works with maps
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
_russellb
I want to try my hand at web scraping. What tools/libraries do I need to use. I’m hoping to turn this into something professional so don’...
New
New
lk-geimfari
What is most correct way to open, read and parse JSON file with poison? For example if we have example.json file in root of some projec...
New
script
If I have a string “1000 cfu/ml” . I want to remove the characters and / and space . So the string is like this "1000" What is the ...
New
Phillipp
Hey, I have a NanoPi-M3 and try to install Elixir on their Ubuntu image. I followed the Raspberry Pi installation instructions from the ...
New
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
Mooodi
Given a string, how can I get access to its character by index? Enum.at("my_string", 2) doesn't work. Or rather, not char, but a substr...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New

Other popular topics Top

peerreynders
Manning 2016 Halloween weekend sale via Deal of the Day Friday, October 28 - Half off all MEAPs - code WM102816LT Saturday, October 29 ...
326 29600 154
New
Tee
can someone please explain to me how Enum.reduce works with maps
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New
jerry
Good day to you all. I have been struggling to get a query involving like and ilike to work. Can anyone assist me on this, please? pro...
New
KronicDeth
Elixir plugin for JetBrain’s IntelliJ Platform (including Rubymine) This is a plugin that adds support for Elixir to JetBrains IntelliJ...
289 35421 110
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
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
fayddelight
I tried installing elixir 1.11.2 erlang 23.3.4 via asdf in my zsh shell. Enabled the versions locally and globally. When I list them ...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? https://hexdocs.pm/ecto/Ecto.Repo.h...
New
baxterw3b
Hi guys, i’m new in the Elixir world, and i have to say, that i love it! i’m having some problem to understand anonymous functions with ...
New

We're in Beta

About us Mission Statement