{"id":15103036,"url":"https://github.com/meteor/docs","last_synced_at":"2025-09-27T01:30:43.766Z","repository":{"id":4746549,"uuid":"5896228","full_name":"meteor/docs","owner":"meteor","description":"The Meteor API documentation.","archived":true,"fork":false,"pushed_at":"2021-10-24T13:26:09.000Z","size":6173,"stargazers_count":186,"open_issues_count":11,"forks_count":203,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-09-21T08:33:01.767Z","etag":null,"topics":["documentation","hacktoberfest","meteor","meteorjs"],"latest_commit_sha":null,"homepage":"https://docs.meteor.com/","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/meteor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"Contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-09-21T03:22:09.000Z","updated_at":"2023-07-26T18:54:16.000Z","dependencies_parsed_at":"2022-09-13T02:31:55.324Z","dependency_job_id":null,"html_url":"https://github.com/meteor/docs","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/meteor%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meteor%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meteor%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meteor%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meteor","download_url":"https://codeload.github.com/meteor/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219871825,"owners_count":16554457,"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":["documentation","hacktoberfest","meteor","meteorjs"],"created_at":"2024-09-25T19:20:20.660Z","updated_at":"2025-09-27T01:30:38.439Z","avatar_url":"https://github.com/meteor.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e This repository has been merged into Meteor main repository. You can find it [there](https://github.com/meteor/meteor/tree/devel/docs).\n\n## Meteor API Documentation - http://docs.meteor.com\n\nThis is a [hexo](https://hexo.io) static site used to generate the [Meteor API Docs](http://docs.meteor.com).\n\n## Contributing\n\nWe'd love your contributions! Please send us Pull Requests or open issues on [github](https://github.com/meteor/docs). Also, read the [contribution guidelines](https://github.com/meteor/docs/blob/master/Contributing.md).\n\nIf you are making a larger contribution, you may need to run the site locally:\n\n### Running locally\n\n#### Submodules\n\nThis repo has two submodules, one the theme, the other full Meteor repository.\n\nWe have the Meteor repo to generate the `data.js` file (see below).\n\nAfter cloning, or updating the repo, it makes sense to run\n\n```\ngit submodule update --init\n```\n\nGenerally you should not commit changes to the submodules, unless you know what you are doing.\n\n#### Generating `data.js`\n\nTo generate the api boxes, the site uses a file `data/data.js` which is generated from the js docs in the [Meteor source code](https://github.com/meteor/meteor). This will automatically happen whenever you start your local hexo server.\n\n#### Starting hexo\n\nEnsure you've run `npm install`. Then simply `npm start`.\n\n### Developing with local meteor source\n\nWhen developing jsdoc documentation within the meteor code you will\nneed to make some local modifications to get the documentation to work locally for testing.\n\n1. Modify `url` in `_config.yml` so links within `localhost:4000` will not jump out to `https://docs.meteor.com`\n```diff\n- url: http://docs.meteor.com/\n+ url: http://localhost:4000/\n```\n2. reconnect the meteor submodule in `/code` to your local meteor folder.\n```bash\n# REMOVE submodule\n# Remove the submodule entry from .git/config\ngit submodule deinit -f code\n\n# Remove the submodule directory from the superproject's\n# .git/modules directory\nrm -rf .git/modules/code\n\n# Remove the entry in .gitmodules and remove the submodule directory\n# located at path/to/submodule\ngit rm -f code\n\n# ADD your local meteor submodule\ngit submodule add /path/to/local/meteor code\n```\n\n3. Hexo builds if you are just changing md files in sources then\nhexo will watch for changes and update.  If you are making changes\nin the `/code` folder then you will need to `npm run clean \u0026\u0026 npm start`.\n\nOf course, do not commit any of these changes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeteor%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeteor%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeteor%2Fdocs/lists"}