{"id":17239042,"url":"https://github.com/binarymuse/wow-api-documentation","last_synced_at":"2025-08-28T04:33:45.196Z","repository":{"id":66010576,"uuid":"1851281","full_name":"BinaryMuse/wow-api-documentation","owner":"BinaryMuse","description":"Documentation for the Blizzard Community Platform API","archived":false,"fork":false,"pushed_at":"2011-06-20T19:33:27.000Z","size":115,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-23T18:58:26.793Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://wowapi.info/","language":"JavaScript","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/BinaryMuse.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":"2011-06-05T18:40:49.000Z","updated_at":"2014-03-21T20:24:59.000Z","dependencies_parsed_at":"2023-02-19T21:15:41.985Z","dependency_job_id":null,"html_url":"https://github.com/BinaryMuse/wow-api-documentation","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/BinaryMuse%2Fwow-api-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BinaryMuse%2Fwow-api-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BinaryMuse%2Fwow-api-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BinaryMuse%2Fwow-api-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BinaryMuse","download_url":"https://codeload.github.com/BinaryMuse/wow-api-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245577310,"owners_count":20638299,"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-15T05:47:34.768Z","updated_at":"2025-03-26T02:35:36.620Z","avatar_url":"https://github.com/BinaryMuse.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"This is the source for http://wowapi.info, which contains documentation for the Blizzard Community Platform API. If you wish to contribute to the project, please:\n\n  1. Fork this repository.\n  2. Make your changes and push to your forked repository.\n  3. Issue a pull request.\n\nWriting API Documentation\n-------------------------\n\nAll API documentation should live in `content/api/`, one file per API. The table of contents is in `layouts/default.html` and should be updated to reflect any new pages.\n\nWithin a document, content is written in [Kramdown](http://kramdown.rubyforge.org/). Each document should have a single first-level heading which will be part of the `\u003ctitle\u003e` of the document.\n\nEach API document should include, at the top, the basic URL structure for the API call, followed by a small paragraph of text summing up the API. Following that, as a general, rule, there should be the following second-level headings and associated sections in an API document:\n\n  1. Introduction: any additional basic info, including Blizzard-employee forum quotes.\n  2. Request: any information about how to format the URL for the API request, sperated into third-level headings if necessary\n  3. Response: information about the response from the API call\n\nFor a good idea about how a document should be laid out, see the `content/api/realm.md` file. However, **if you wish to contribute but aren't sure about the formatting**, go ahead and add what you can, and I will take care of extra formatting or layout when I process the pull request.\n\nUsing nanoc\n-----------\n\nThe site is built using nanoc. Assuming you are using Bundler to manage your gems, you can install the necessary gems using `bundle install` and start the auto-compiler via `bundle exec rake auto`. This will start a web server on localhost port 3000; visit http://localhost:3000 in a browser to view the site. nanoc will recompile files as you modify them, so simply refresh your browser to see your changes.\n\nThe Blizzquote Filter\n---------------------\n\nTo create a Blizzard-employee quote block, use the following syntax:\n\n    [BLIZZQUOTE Name http://us.battle.net/path/to/forum/post/url]\n    Something a blue said!\n    [/BLIZZQUOTE]\n\nThe filter at `lib/blizzquote_filter.rb` will insert the necessary HTML to format the quote correctly.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinarymuse%2Fwow-api-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbinarymuse%2Fwow-api-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinarymuse%2Fwow-api-documentation/lists"}