{"id":18411395,"url":"https://github.com/alfg/restful-markdown","last_synced_at":"2026-05-01T04:42:32.928Z","repository":{"id":31826064,"uuid":"35392950","full_name":"alfg/restful-markdown","owner":"alfg","description":":pencil: A simple style-guide for building RESTful documentation in Markdown.","archived":false,"fork":false,"pushed_at":"2015-05-11T03:24:17.000Z","size":188,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T22:55:32.824Z","etag":null,"topics":["github","markdown","standard"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alfg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-11T00:00:17.000Z","updated_at":"2024-07-27T04:16:48.000Z","dependencies_parsed_at":"2022-08-17T21:15:17.008Z","dependency_job_id":null,"html_url":"https://github.com/alfg/restful-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Frestful-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Frestful-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Frestful-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alfg%2Frestful-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alfg","download_url":"https://codeload.github.com/alfg/restful-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248643050,"owners_count":21138353,"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":["github","markdown","standard"],"created_at":"2024-11-06T03:36:47.822Z","updated_at":"2026-05-01T04:42:32.872Z","avatar_url":"https://github.com/alfg.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# restful-markdown\n\nA simple style-guide for building RESTful documentation in Markdown, inspired by the [Github Developer API](https://developer.github.com/v3/).\n\nThere are so many ways to create documentation for your RESTful API. However, sometimes you just want something simple to publish along with your git repository. This project aims at utilizing [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/) to create a simple documentation of your RESTful API. No generators, compilers or any fluff, just Markdown.\n\nClone, fork, or just view the [examples](examples) directory for a documentation example.\n\n## Resources\n\nResources to help with the style guide.\n\n* http://restful-api-design.readthedocs.org/\n* https://developer.github.com/v3/\n* https://help.github.com/articles/github-flavored-markdown/\n\n\n## Contribute\n\nContributions are welcome! Feel free to create an issue or pull request!\n\n\n## License\n\n[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)\n\nTo the extent possible under law, [alfg](http://github.com/alfg) has waived all copyright and related or neighboring rights to this work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falfg%2Frestful-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falfg%2Frestful-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falfg%2Frestful-markdown/lists"}