Add support for LiveBook's .livemd Markdown files

[samharnack]

No description provided.

[josevalim]

Thank you @samharnack! One thing we want to do with .livemd files is to also include the original, so we can easily import them into Livebook. Can you please look into this? @wojtekmach should we also include the source .md files?

[samharnack]

Will do! @josevalim do you have a preference/suggestion of where the source files should be copied or is the root fine?

[wojtekmach]

I'm not sure I follow, in the context of livebook what is the difference between .livemd and .md and what do we need on the ExDoc side of things? My understanding is that when we work on our livebook, the file is persisted as .livemd. And when we export, we are nudged towards calling it .livemd too.

[josevalim]

For .livemd files, you want to import them into Livebook, so we need to keep a copy of the original and link to it. For now, keeping the original is fine until we figure out how to link it. Then the question is if we also want to keep the originals for .md. For keeping them, I think they can have the exact same path as the html one, we just change the extension. WDYT? -- *José Valimhttps://dashbit.co/ <https://dashbit.co/>*

[samharnack]

IMO including the .md might get noisy so I've just copied the .livemd files. I'm happy to update the PR to include the .md files if thats the desired direction.

The .livemd files are added to the same path as the html version, the only difference is it maintains the file name casing of the original.

[wojtekmach]

ok, I think I get it. Say we include ecto.livemd in Ecto docs. We already include for example the changelog. You are proposing to have all of these, right?

• https://hexdocs.pm/ecto/ecto.livemd
• https://hexdocs.pm/ecto/ecto.html
• https://hexdocs.pm/ecto/changelog.md
• https://hexdocs.pm/ecto/changelog.html

if so, sounds good to me.

[josevalim]

Btw, for full disclosure, we will be soon launching a Livebook website and we want to add a "Run in Livebook" badge. Clicking on the badge will point to the .livemd file, which you will be able to preview and run in your favorite Livebook instance (it can be local or cloud provided). The idea is to include this badge on all Livebooks generated as part of ExDoc. :)

[josevalim]

@samharnack good news! The tests failed, which means the current setup is enough to verify we are using the node.id. :) I have pushed a fix for the tests and we should be good to go!

[josevalim]

💚 💙 💜 💛 ❤️

[samharnack]

Oh wow, thank you! I was just sitting down to finish this up 🥳