mat-hek
Hello, I have an .exs script with Mix.install in a repo and I’d like to include it in the docs. Putting it into extras throws an error that only markdown files are allowed. What’s the best way to include the script in the docs?
Where Next?
Trending in Questions
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Practical resources that improve the lives of professional developers.
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
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #podcasts
- #javascript
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #blog-post
- #elixirconf-us
- #elixir-ls
- #ai
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #hex
- #security
- #metaprogramming
Our Sponsors
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.
Elixir, Erlang & BEAM conferences from Code Sync - join us in 2026!
Master modern tools, write cleaner code, and tackle real-world challenges.
Producing high quality Elixir screencasts since 2017.
**Building the future of software with AI, trust, and human connection.**
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
Showing Posts 1 to 5- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
benwilson512
You’re trying to show the contents of the file in the docs? Would
@moduledoc "#{File.read("script.exs")}"work?christhekeele
AFAIK, while Earmark supports custom processing allowing you to do things like this, ExDoc does not.
I’d use
@external_resourcewith @benwilson512’s approach to insert script code somewhere into module/function docs, or rework the script into a Livebook (which is publishable by ExDoc).mat-hek
Yeah, thought about it, but to me it doesn’t really fit in the moduledoc.
I asked if
exscould be supported, but apparently it cannot ¯\_(ツ)_/¯ so I’m going to just link to GitHubsodapopcan
I’m sure you have your reasons but why the hard requirement to have it as an
.exs? If it’s a sample file for people to run on their local machines, what’s wrong with putting it code fences in markdown? That way you get the copy-to-clipboard button and users can just paste into their editor.mat-hek
It’s not a hard requirement, it just feels right to me to have an exs script in an exs file. It’s not a big deal anyway