Hello folks – I just published v1.0.0 of elm-book!
I’ll copy-paste a little sneak of the overview page here to explain a little bit more about the goals behind the project:
This library takes a lot of inspiration from two libraries:
- Storybook – a JS ecosystem tool that focus on showcasing components and their states, mostly aiming at internal design systems but also enabling the pattern of creating visual components in isolation.
- HexDocs – an Erlang/Elixir ecosystem tool that enables structured library documentation with guides, function docs, links to code and external sources.
Both of these tools affected their whole ecosystems greatly. Creating good docs is a common place when you’re in Elixir world. Using Storybook to facilitate design-engineering iteration is a common place in the JS world.What if the Elm ecosystem can create its own thing with the best of both worlds?
ElmBook aims to be just that – making it easy to create attractive documentation websites that can also work as a playground for live components built with Elm.
Please take a look, use it, throw punches at it and let me know how can we make it better!
The theme builder is a particularly fun little tool I made available as part of the website if you like messing around with theme colors.