{"id":16702184,"url":"https://github.com/vkatsuba/rebar3_edoc_extensions","last_synced_at":"2025-12-11T23:39:43.916Z","repository":{"id":38193731,"uuid":"428244899","full_name":"vkatsuba/rebar3_edoc_extensions","owner":"vkatsuba","description":"Plugin for custom style of Erlang documentation","archived":false,"fork":false,"pushed_at":"2024-10-11T15:45:11.000Z","size":88,"stargazers_count":10,"open_issues_count":4,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-27T04:38:45.869Z","etag":null,"topics":["erlang","rebar3","rebar3-plugin"],"latest_commit_sha":null,"homepage":"","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/vkatsuba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-15T11:58:08.000Z","updated_at":"2025-07-27T22:13:35.000Z","dependencies_parsed_at":"2025-02-16T14:38:00.872Z","dependency_job_id":"dea60ccd-6ab9-46f5-b956-94c65543ad60","html_url":"https://github.com/vkatsuba/rebar3_edoc_extensions","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":"vkatsuba/rebar3_plugin","purl":"pkg:github/vkatsuba/rebar3_edoc_extensions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_edoc_extensions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_edoc_extensions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_edoc_extensions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_edoc_extensions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vkatsuba","download_url":"https://codeload.github.com/vkatsuba/rebar3_edoc_extensions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vkatsuba%2Frebar3_edoc_extensions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27672220,"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","status":"online","status_checked_at":"2025-12-11T02:00:11.302Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["erlang","rebar3","rebar3-plugin"],"created_at":"2024-10-12T18:47:07.456Z","updated_at":"2025-12-11T23:39:43.875Z","avatar_url":"https://github.com/vkatsuba.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rebar3_edoc_extensions\n\n[![Hex.pm Version][hexpm version]][hexpm]\n[![Hex.pm Downloads][hexpm downloads]][hexpm]\n[![Hex.pm Documentation][hexdocs documentation]][hexdocs]\n[![Erlang Versions][erlang version badge]][gh]\n[![Build Status][gh badge]][gh]\n\n`rebar3_edoc_extensions` is a Rebar 3 plugin bringing improvements to\n[EDoc](https://www.erlang.org/doc/apps/edoc/chapter.html)-based documentation.\n\n## Getting started\n\nTo use this plugin for your project, simply add the plugin to the\n`project_plugins` list in your `rebar.config` configuration:\n\n```erlang\n%% In `rebar.config`.\n{project_plugins, [rebar3_edoc_extensions]}.\n```\n\nIt overrides the defaut behavior of the `rebar edoc` command. Therefore, the\nnext time you generate the documentation, you will benefit from the\nimprovements brought by this plugin.\n\n## EDoc improvements\n\nHere is a list of changes this plugin makes to EDoc-generated documentation:\n\n1. A table of content of the Overview page is added to the left sidebar.\n2. The [GitHub Markdown stylesheet](https://github.com/sindresorhus/github-markdown-css)\n   is used to style the entire documentation.\n3. [PrismJS](https://prismjs.com/) is used to enable syntax highlighting to\n   literals and code snippets.\n\n## Configuration\n\nThe plugin supports a few options to configure the **PrismJS syntax\nhighlighting** library:\n\n*   Select the version of PrismJS to download:\n    ```erlang\n    {prismjs_version, \"v1.26.0\"}.\n    ```\n\n    The default version is `\"v1.26.0\"`.\n\n*   Select the PrismJS theme:\n    ```erlang\n    {prismjs_theme, \"twilight\"}.\n    ```\n\n    The default theme is `\"default\"`.\n\n*   Select the list of languages to support:\n    ```erlang\n    {prismjs_languages, [\"erlang\", \"javascript\"]}.\n    ```\n\n    The default languages are `\"erlang\"` and `\"elixir\"`.\n\n## Build\n\n```sh\n$ rebar3 compile\n```\n\n## Use\n\nAdd the plugin to your rebar config:\n\nFor generate `doc` with new style, run:\n```sh\n$ rebar3 edoc\n```\n\n\u003c!-- Badges --\u003e\n[hexpm]: https://hex.pm/packages/rebar3_edoc_extensions\n[hexpm version]: https://img.shields.io/hexpm/v/rebar3_edoc_extensions.svg?style=flat-square\n[hexpm downloads]: https://img.shields.io/hexpm/dt/rebar3_edoc_extensions.svg?style=flat-square\n[hexdocs documentation]: https://img.shields.io/badge/hex-docs-purple.svg?style=flat-square\n[hexdocs]: https://hexdocs.pm/rebar3_edoc_extensions\n[gh]: https://github.com/vkatsuba/rebar3_edoc_extensions/actions/workflows/ci.yaml\n[gh badge]: https://img.shields.io/github/workflow/status/vkatsuba/rebar3_edoc_extensions/CI?style=flat-square\n[erlang version badge]: https://img.shields.io/badge/erlang-23.X%20to%2025.X-blue.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkatsuba%2Frebar3_edoc_extensions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvkatsuba%2Frebar3_edoc_extensions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvkatsuba%2Frebar3_edoc_extensions/lists"}