https://github.com/dtwrks/elm-book

Rich documentation builder for Elm applications and packages. Inspired by Storybook and HexDocs.
https://github.com/dtwrks/elm-book

developer-tools documentation elm elm-lang hexdocs storybook

Last synced: about 1 year ago
JSON representation

Rich documentation builder for Elm applications and packages. Inspired by Storybook and HexDocs.

• Host: GitHub
• URL: https://github.com/dtwrks/elm-book
• Owner: dtwrks
• License: mpl-2.0
• Created: 2021-05-31T09:18:47.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-22T18:11:59.000Z (over 1 year ago)
• Last Synced: 2025-04-12T20:46:41.586Z (about 1 year ago)
• Topics: developer-tools, documentation, elm, elm-lang, hexdocs, storybook
• Language: Elm
• Homepage: http://elm-book-in-elm-book.netlify.app
• Size: 416 KB
• Stars: 98
• Watchers: 4
• Forks: 8
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - dtwrks/elm-book - Rich documentation builder for Elm applications and packages. Inspired by Storybook and HexDocs. (Elm)

README

          
# ElmBook

Every application, tool or team has their own history worth telling.

ElmBook tries to help them by making it easy to create rich documents that showcase their **libraries documentations**, **UI components**, **design tokens**, and more.

- Showcase your live interactive Elm components

- Create documents based on markdown

- Embed Elm components inside your markdown

- Fully customizable theme including dark mode

- Lots of helpers to make your development experience easier

- Works with elm-ui, elm-css and others

- Plain Elm (no javascript)

- Built-in development server (Optional)

Checkout the rich documentation for this library created on ElmBook itself:

https://elm-book-in-elm-book.netlify.app/