{"id":13726088,"url":"https://github.com/mseri/md2mld","last_synced_at":"2025-03-21T20:34:28.680Z","repository":{"id":49168869,"uuid":"137476585","full_name":"mseri/md2mld","owner":"mseri","description":"Little cli to convert md files into mld files","archived":false,"fork":false,"pushed_at":"2023-05-01T13:48:29.000Z","size":435,"stargazers_count":27,"open_issues_count":3,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-13T21:30:07.207Z","etag":null,"topics":["hacktoberfest","mld","odoc"],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mseri.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","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}},"created_at":"2018-06-15T10:49:53.000Z","updated_at":"2024-10-04T15:01:47.000Z","dependencies_parsed_at":"2024-01-10T18:34:51.169Z","dependency_job_id":null,"html_url":"https://github.com/mseri/md2mld","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mseri%2Fmd2mld","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mseri%2Fmd2mld/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mseri%2Fmd2mld/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mseri%2Fmd2mld/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mseri","download_url":"https://codeload.github.com/mseri/md2mld/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221819056,"owners_count":16885883,"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":["hacktoberfest","mld","odoc"],"created_at":"2024-08-03T01:02:52.224Z","updated_at":"2024-10-28T10:52:14.152Z","avatar_url":"https://github.com/mseri.png","language":"OCaml","funding_links":[],"categories":["OCaml"],"sub_categories":[],"readme":"# md2mld: Convert md files into odoc mld files\n\n`md2mld` converts a Markdown-format file into the `mld` format used by [odoc](https://github.com/ocaml/odoc) to render HTML documentation or OCaml libraries.  You can use this script to automatically embed a `README.md` file into API documentation for an OCaml  library.\n\n## Usage\n\nYou can use it manually as follows\n\n```console\n$ md2mld filename.md \u003e outfile.mld\n```\n\nIn `dune` you can use it to generate an mld file with\n\n```text\n(rule\n (target outfile.mld)\n (deps filename.md)\n (action\n  (with-stdout-to outfile.mld (run md2mld filename.md))))\n```\n\nAttach the mld file using the [`(documentation …)` stanza](https://dune.readthedocs.io/en/stable/documentation.html#documentation-stanza-examples).\nYou can see the documentation generated from the latest tagged version of this README at [mseri.github.io/md2mld/md2mld](https://mseri.github.io/md2mld/md2mld).\n\n\n## Known issues\n\n- Until the new odoc [fixing #141](https://github.com/ocaml/odoc/issues/141) is released, the minimal header allowed in the `md` file will be the level 3 one `###`.\nYou can work around this by using the `-min-header 3` flag during the invocation of `md2mld`.\n\n- If you see an error like `'{0': heading level should be lower than top heading level '0'`, this is because in `ocamldoc` the first header must have a level higher than all other headings in the page.\nYou can safely ignore it or increase the level of the subsequent headings to get rid of it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmseri%2Fmd2mld","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmseri%2Fmd2mld","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmseri%2Fmd2mld/lists"}