Skip to content
lfexPublic

About

An LFE port of Clojure's cljdoc

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

54 Commits

Folders and files

Repository files navigation

ldoc

Build Status LFE Version Erlang/OTP Versions Tags Downloads HexDocs

An LFE port of Clojure's cljdoc

ldoc turns the documentation in Erlang and LFE projects into an easy-to-browse website. It brings API references, guides, and other project pages together, helping people find what they need, understand how a library works, and get started using it.

Build a project reference with Rebar3

For an ordinary Erlang project, add ldoc as a development-only plugin in rebar.config:

{project_plugins, [{ldoc, "0.1.1"}]}.

For an LFE project, keep its normal runtime and compiler configuration and add ldoc only to project_plugins:

{deps, [{lfe, "2.2.2"}]}.
{plugins, [{rebar3_lfe, "0.5.8"}]}.
{project_plugins, [{ldoc, "0.1.1"}]}.

Run rebar3 ldoc, then open _build/default/ldoc/current/site/index.html. The plugin builds the default profile and leaves the application's normal compiler settings intact. Rebar3 3.28.0 is the verified provider version. Erlang source-comment conversion requires OTP's edoc_doclet_chunks and edoc_layout_chunks tools. Use rebar3 help ldoc for provider options. ldoc is development-only and does not become a runtime dependency of the documented application.

Documentation

Select project Markdown pages with the ordinary {ldoc, [{pages, [...]}]} setting in rebar.config; see the page selection guide.

  • User guide: collection, snapshots, analysis, and rendering.
  • Maintainer guide: output behavior, standalone installation, and package publishing.

Licence

ldoc is released under the Apache License, Version 2.0.

The project image featuring LiffyBot (the LFE mascot) was inspired by Andrea Wisnewski's linocut prints.

About

An LFE port of Clojure's cljdoc

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages