https://github.com/jfacorro/rebar3_docs

Generate nice looking documentation for your Erlang code (rebar3 plugin)
https://github.com/jfacorro/rebar3_docs

Last synced: 4 months ago
JSON representation

Generate nice looking documentation for your Erlang code (rebar3 plugin)

• Host: GitHub
• URL: https://github.com/jfacorro/rebar3_docs
• Owner: jfacorro
• License: apache-2.0
• Created: 2020-07-28T21:34:48.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-24T22:49:39.000Z (about 4 years ago)
• Last Synced: 2023-04-04T14:48:39.742Z (almost 2 years ago)
• Language: Erlang
• Size: 65.4 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
rebar3_docs

=====

Generates nice looking documentation

Build

-----

    $ rebar3 compile

Use

---

Add the plugin to your rebar config:

    {plugins, [

        {rebar3_docs, {git, "https://github.com/jfacorro/rebar3_docs.git", {tag, "0.1.0"}}}

    ]}.

Then just call your plugin directly in an existing application:

    $ rebar3 docs

    ===> Fetching rebar3_docs

    ===> Compiling rebar3_docs

    

Options

--------

This plugin provides some configuration options by adding a `{docs,

Options}` entry to the project's `rebar.config`.

Available options:

- `categories`: list of category name with the modules that belong to

  them. This information is used to create sections in the navigation

  menu. When a module is not included in any category it is added at

  the beginning of the modules list in the navigation menu.

  ```

  { categories

  , [ {"Name1", [module1, module2]}

    , {"Name2", [module3]}

    ]

  }

  ```

--------

Useful links

----------------

- [docsh - Documentationi in the Erlang shell](https://github.com/erszcz/docsh)

- [HTML+JS Sidenav How To](https://www.w3schools.com/howto/howto_js_sidenav.asp)

- [Erlang Ecosystem Foundation - Documentation Working Group](https://github.com/erlef/documentation-wg/issues/5)

- [edown - edoc to markdown](https://github.com/uwiger/edown)