{"id":17036152,"url":"https://github.com/kormanowsky/spec-md-merger","last_synced_at":"2025-03-22T22:42:16.438Z","repository":{"id":86846263,"uuid":"391189443","full_name":"kormanowsky/spec-md-merger","owner":"kormanowsky","description":"Merges your Swagger spec and MarkDown description files","archived":false,"fork":false,"pushed_at":"2021-08-01T21:25:42.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-28T02:23:40.079Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/kormanowsky.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-30T21:16:13.000Z","updated_at":"2021-08-01T21:25:44.000Z","dependencies_parsed_at":"2023-03-11T05:16:38.782Z","dependency_job_id":null,"html_url":"https://github.com/kormanowsky/spec-md-merger","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/kormanowsky%2Fspec-md-merger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kormanowsky%2Fspec-md-merger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kormanowsky%2Fspec-md-merger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kormanowsky%2Fspec-md-merger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kormanowsky","download_url":"https://codeload.github.com/kormanowsky/spec-md-merger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245031345,"owners_count":20549913,"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-14T08:49:29.608Z","updated_at":"2025-03-22T22:42:16.403Z","avatar_url":"https://github.com/kormanowsky.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spec and Markdown Merger \n\nMerges your Swagger spec and MarkDown description files, \noptionally adding code samples.\n\n# Usage\n\n`python3 main.py COMMAND ARGS`\n\n# Commands\n\n## `createfiles`\n`python3 main.py createfiles YOUR_SPEC [YOUR_ROOT_FOLDER] \n[--languages LANG1 LANG2 ... LANGN`\n\nThis command will create all necessary folders and \nempty .md and code sample files for your spec. \n`LANG1`, `LANG2` etc are names of programming languages. \nNow this program supports\nlanguages listed below. \n```python3\nLANGUAGES = {\n    \"Python\": \".py\",\n    \"PHP\": \".php\",\n    \"JavaScript\": \".js\",\n    \"Java\": \".java\",\n    \"C\": \".c\",\n    \"C++\": \".cpp\",\n    \"C#\": \".cs\",\n    \"Go\": \".go\",\n    \"Dart\": \".dart\",\n}\n```\n\n## `merge`\n`python3 main.py merge YOUR_SPEC [YOUR_ROOT_FOLDER] [OUTPUT_SPEC]`\n\nThis command will merge your spec and your MarkDown files and output the result\nto `OUTPUT_SPEC` if it is present, or will `print()` the result.\n\n## Note\n\n`YOUR_ROOT_FOLDER` is current working directory by default.\n\n# Folders and files\n\n## `YOUR_ROOT_FOLDER/info.md`\n\nContains general information about your spec. The first line is the `\"title\"`, \nthe rest of the file is the `\"description\"`\n\n## `YOUR_ROOT_FOLDER/YOUR_PATH/YOUR_METHOD.md`\n\nContains information about one of YOUR_PATH methods. The first line is the \n`\"summary\"`, the rest of the file is the `\"description\"`\n\n## Example\nYou have API method `/users/list` and you're writing a MarkDown file\nfor `POST` method. You should name your file `YOUR_ROOT_FOLDER/users/list/post.md`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkormanowsky%2Fspec-md-merger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkormanowsky%2Fspec-md-merger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkormanowsky%2Fspec-md-merger/lists"}