Adzz

Adzz

LivebookHelpers - Creating Livebooks From Module docs

Announcing GitHub - Adzz/livebook_helpers: Generates livebooks from module docs · GitHub

This is a library that generates a livebook from a module’s docs. It turns the module, type and function docs into a livebook, turning any doctests and elixir snippets into elixir cells and setting the doc itself as markdown.

This is helpful for boostrapping livebooks and having interactive versions of the Hexdoccs. You can for example set up a pipeline on hex publish that generates the livebook as part of it.

I’ve experimented with generating a livebook for all the core Elixir modules, for example here is the livebook for the Collectable protocol. Here is a livebook from the Time module.

Feedback welcome :tada:

Most Liked

Adzz

Adzz

Here is a blog post introducing what you can do with it:

Adzz

Adzz

This is a very cool hack but…

I think this nicely sums up most of my programming career to date :sweat_smile:.

Some nice ideas. I think if we were to go that route it could be good to build it into hexdocs itself.
I did try to host for free all the core Elixir module docs on Fly.io but one problem I ran into is there is a bit of a limit on the size of livebook that you can reasonably run.

For example you can’t open or run a livebook created in this manner for the Enum module in Elixir - it’s simply too large.

There isn’t really a workaround for this yet either - each Elixir cell is an instance of the monaco editor so if you have a lot of them the page gets very heavy. See this issue for more.

Where Next?

Popular in Announcing Top

mtrudel
Bandit is an HTTP server for Plug and WebSock apps. Bandit is written entirely in Elixir and is built atop Thousand Island. It can serve...
New
aesmail
Hello guys, I have finally made it. I created an admin interface for a framework. It’s been on my todo list for years and with the curre...
New
woutdp
Hi! I wanted to introduce my latest project LiveSvelte. It allows you to render Svelte inside LiveView with end-to-end reactivity. It’s ...
New
blatyo
The best overview for how things are tied together is this presentation. Modules and functions are pretty well documented at this point, ...
New
wojtekmach
Hey everyone! Req is an HTTP client for Elixir that I’ve been working on for quite some time. There is already a lot of HTTP clients out...
New
aditya7iyengar
Rummage.Ecto and Rummage.Phoenix provide ways to perform Searching, Sorting and Pagination over Ecto queries and Phoenix collections. Fo...
New
Jskalc
Hi! Today, after a couple weeks of development I’ve released v0.1 of LiveVue. It’s a seamless integration of Vue and Phoenix LiveView, i...
New
Hal9000
Here is my first stab at this. README pasted below. https://github.com/Hal9000/elixir_random Comments and critiques are welcome. Thank...
New
Qqwy
TypeCheck: Fast and flexible runtime type-checking for your Elixir projects. Core ideas Type- and function specifications are const...
336 14327 100
New
woylie
Flop is an Elixir library that applies filtering, ordering and pagination parameters to your Ecto queries. offset-based pagination with...
New

Other popular topics Top

New
9mm
I am constructing a JSON object (map) and I need to conditionally set a field. I’m trying to write proper elixir-way code… and I’m at a l...
New
albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New
Nvim
Anybody knows a comprehensive comparison of Django and Phoenix, thanks for the help. Where are they similar? Where do they differ the m...
New
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
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
alice
Hey, Just curious what are the main benefits of Elixir compared to Clojure? When is Elixir more useful than Clojure and vice versa? Th...
New
sergio_101
I am VERY much an elixir newbie. I have taken one elixir course and one phoenix course on Udemy. During that course, I saw the instructor...
New
boundedvariable
I am going through the kafka architecture. All the features what the kafka is providing are already in Erlang. I would like hear your opi...
New
marick
I had some trouble figuring out how to make many-to-many associations work. Once I got it working, I wrote a blog post. Because I’m a nov...
New

We're in Beta

About us Mission Statement