{"id":16656224,"url":"https://github.com/jfacorro/rebar3_docs","last_synced_at":"2025-07-19T09:32:19.090Z","repository":{"id":54858170,"uuid":"283333196","full_name":"jfacorro/rebar3_docs","owner":"jfacorro","description":"Generate nice looking documentation for your Erlang code (rebar3 plugin)","archived":false,"fork":false,"pushed_at":"2021-01-24T22:49:39.000Z","size":67,"stargazers_count":8,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T18:28:35.038Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jfacorro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-28T21:34:48.000Z","updated_at":"2023-12-04T11:45:12.000Z","dependencies_parsed_at":"2022-08-14T04:51:01.820Z","dependency_job_id":null,"html_url":"https://github.com/jfacorro/rebar3_docs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/jfacorro/rebar3_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfacorro%2Frebar3_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfacorro%2Frebar3_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfacorro%2Frebar3_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfacorro%2Frebar3_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jfacorro","download_url":"https://codeload.github.com/jfacorro/rebar3_docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfacorro%2Frebar3_docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265909775,"owners_count":23847502,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T09:56:41.289Z","updated_at":"2025-07-19T09:32:19.041Z","avatar_url":"https://github.com/jfacorro.png","language":"Erlang","readme":"rebar3_docs\n=====\n\nGenerates nice looking documentation\n\nBuild\n-----\n\n    $ rebar3 compile\n\nUse\n---\n\nAdd the plugin to your rebar config:\n\n    {plugins, [\n        {rebar3_docs, {git, \"https://github.com/jfacorro/rebar3_docs.git\", {tag, \"0.1.0\"}}}\n    ]}.\n\nThen just call your plugin directly in an existing application:\n\n    $ rebar3 docs\n    ===\u003e Fetching rebar3_docs\n    ===\u003e Compiling rebar3_docs\n    \u003cPlugin Output\u003e\n\nOptions\n--------\n\nThis plugin provides some configuration options by adding a `{docs,\nOptions}` entry to the project's `rebar.config`.\n\nAvailable options:\n\n- `categories`: list of category name with the modules that belong to\n  them. This information is used to create sections in the navigation\n  menu. When a module is not included in any category it is added at\n  the beginning of the modules list in the navigation menu.\n\n  ```\n  { categories\n  , [ {\"Name1\", [module1, module2]}\n    , {\"Name2\", [module3]}\n    ]\n  }\n  ```\n\n--------\n\nUseful links\n----------------\n\n- [docsh - Documentationi in the Erlang shell](https://github.com/erszcz/docsh)\n- [HTML+JS Sidenav How To](https://www.w3schools.com/howto/howto_js_sidenav.asp)\n- [Erlang Ecosystem Foundation - Documentation Working Group](https://github.com/erlef/documentation-wg/issues/5)\n- [edown - edoc to markdown](https://github.com/uwiger/edown)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfacorro%2Frebar3_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjfacorro%2Frebar3_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfacorro%2Frebar3_docs/lists"}