vrod
Using Mermaid with ex_doc?
I saw a few thread about mermaid – it is a markdown way to make some charts and diagrams. I think it can be very useful for documentations. Does anyone know if ex_doc has “hooks” where something like this could be used? I’m not sure if I follow the ex_doc documentation, but hopefully someone knows if this might be possible! Thank you!
Marked As Solved
hauleth
Yes, in mix help docs:
:javascript_config_path- Path of an additional JavaScript file to be
included on all pages to provide up-to-date data for features like the
version dropdown - See the “Additional JavaScript config” section. Example:
"../versions.js"
So you can write script that will process Mermaid blocks in your documentation on the FE side. Alternatively you can write use options/custom wrapper for the Markdown parser, so you will be able to statically generate images basing on the returned data.
Also Liked
ityonemo
I think you can generate the @moduledoc as part of @before_compile. The Macro.Env.t term passed into the before_compile callback should have information about what functions exist in the module.
hauleth
Well, if you meant GenStage.init/1 callback then it can return different values depending on passed arguments. So unless you return always the same value, then it is not possible to achieve what you want. If you always return the same value, independently of the argument, then you can do:
defmodule A do
@init_return …
@moduledoc """
#{make_mermaid_chart(@init_return)}
"""
def init(_), do: @init_return
end
Last Post!
vrod
Yes, I thought about module attributes, but the actual values are more complex (at least right now they are). Sometimes the functions take runtime argument and things like that, so it doesn’t always work inside the module attributes. It is working well now, it is just in a different module.
Popular in Questions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Catch errors, track performance, monitor hosts and more.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #elixirconf-us
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #security
- #hex
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Practical resources that improve the lives of professional developers.
Enabling companies to succeed by building software people love.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"