{"id":15285987,"url":"https://github.com/baransu/elm-docs","last_synced_at":"2025-04-13T03:08:08.929Z","repository":{"id":57222545,"uuid":"96929202","full_name":"baransu/elm-docs","owner":"baransu","description":"📖 Markdown documentation generator for elm-make compatible projects","archived":false,"fork":false,"pushed_at":"2018-11-09T17:41:28.000Z","size":16,"stargazers_count":4,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T03:08:03.375Z","etag":null,"topics":["cli","docs","documentation","elm","elm-lang"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/baransu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-11T19:32:25.000Z","updated_at":"2018-11-09T17:41:29.000Z","dependencies_parsed_at":"2022-08-28T23:23:16.010Z","dependency_job_id":null,"html_url":"https://github.com/baransu/elm-docs","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baransu%2Felm-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baransu%2Felm-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baransu%2Felm-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/baransu%2Felm-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/baransu","download_url":"https://codeload.github.com/baransu/elm-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248657918,"owners_count":21140846,"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":["cli","docs","documentation","elm","elm-lang"],"created_at":"2024-09-30T15:09:00.229Z","updated_at":"2025-04-13T03:08:08.861Z","avatar_url":"https://github.com/baransu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# elm-docs\n\n\u003e 📖 Markdown documentation generator for elm-make compatible projects\n\nExample generated docs for [wende/elchemy](https://github.com/wende/elchemy): https://gist.github.com/Baransu/26ce8e7c987f68f078a8e415a2601d3c\n\n## Usage\n\nInstall globally with you package manager of choice:\n```sh\nyarn global add elm-docs\n# or\nnpm install -g elm-docs\n```\n\nThen go into root of your `elm-make` project and use\n```sh\nelm-docs\n```\nBy default output will be placed in `DOCS.md` file in your current directory. To specify custom output file you can use `--output, -o` flag and define your file of choice like that:\n```sh\nelm-docs --output DOCUMENTATION.md \n```\nIt will output documentation into `DOCUMENTATION.md` file in you current directory.\n\n## Licence\n\nMIT © Tomasz Cichocinski\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbaransu%2Felm-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbaransu%2Felm-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbaransu%2Felm-docs/lists"}