{"id":19372535,"url":"https://github.com/sproutcore/guides","last_synced_at":"2025-09-09T07:39:34.875Z","repository":{"id":1081909,"uuid":"928033","full_name":"sproutcore/guides","owner":"sproutcore","description":"The guides source.  Build and push to https://github.com/sproutcore-guides/sproutcore-guides.github.com.","archived":false,"fork":false,"pushed_at":"2019-01-20T13:05:44.000Z","size":2814,"stargazers_count":110,"open_issues_count":8,"forks_count":65,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-23T16:33:11.337Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://guides.sproutcore.com/","language":"CSS","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/sproutcore.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2010-09-21T15:48:03.000Z","updated_at":"2024-10-09T02:53:00.000Z","dependencies_parsed_at":"2022-07-15T07:00:29.622Z","dependency_job_id":null,"html_url":"https://github.com/sproutcore/guides","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sproutcore/guides","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproutcore%2Fguides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproutcore%2Fguides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproutcore%2Fguides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproutcore%2Fguides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sproutcore","download_url":"https://codeload.github.com/sproutcore/guides/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproutcore%2Fguides/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263480867,"owners_count":23473164,"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-11-10T08:23:49.897Z","updated_at":"2025-07-04T09:06:55.936Z","avatar_url":"https://github.com/sproutcore.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"SproutCore Guides\n=================\n\nThese are the official guides for the [SproutCore](http://www.sproutcore.com) framework. You can see them live at the [SproutCore Guides\nhomepage](http://guides.sproutcore.com).\n\nThis document contains a brief overview of how to contribute changes and additioins to the SproutCore Guides. For an in-depth explanation, see the\n[Contributing Guide](http://guides.sproutcore.com/contribute.html).\n\n## Getting the Source Code\n\n1. [Fork](https://help.github.com/articles/fork-a-repo) the [SproutCore Guides repository](https://github.com/sproutcore/guides) on [GitHub](http://github.com).\n\n2. Clone the fork on to your local machine.\n    ```bash\n    $ git clone git://github.com/\u003cyourname\u003e/guides.git\n    ```\n\n3. Add the main SproutCore Guides repository as a remote so you can fetch updates.\n    ```bash\n    $ cd guides\n    $ git remote add upstream git://github.com/sproutcore/guides.git\n    ```\n\n## Installing Prerequisites\n\nThe SproutCore guides use the [Node](http://nodejs.org/)-powered [DocPad](http://docpad.org/) framework. In order to contribute to the guides,\nyou will first need to install Node from [http://nodejs.org/](http://nodejs.org/).\n\nNext, install the docpad framework (note: you may need to use `sudo` for this):\n\n```bash\n$ npm install -g docpad\n```\n\nFinally, change into the guides directory and install the necessary development dependencies:\n\n```bash\n$ cd ~/my/dev/directory/sproutcore/guides\n$ npm install\n```\n\nYou should see a plethora of output similar to the following:\n\n    ...\n    npm http 304 https://registry.npmjs.org/keypress\n    npm http 304 https://registry.npmjs.org/readable-stream\n    npm http 304 https://registry.npmjs.org/underscore\n    npm http 304 https://registry.npmjs.org/qs/0.6.5\n    npm http 304 https://registry.npmjs.org/commander/0.6.1\n    npm http 304 https://registry.npmjs.org/bal-util\n    npm http 304 https://registry.npmjs.org/range-parser/0.0.4\n    ...\n\n## Before Making Changes\n\nBefore you make any changes, you'll want to pull in any upstream changes and create a new topic branch for your changes.\n\n```bash\n$ git checkout master\n$ git pull\n$ git checkout -b \u003cbranchname\u003e\n```\n\n## Create the Avatar Cache\n\nOur sproutdown plugin will attempt to cache the avatars so that we do not hit GitHub more than necessary. Run the following\ncommand to initialize the file.\n\n```bash\necho '{}' \u003e plugins/sproutdown/src/.avatar_cache.json\n```\n\n## Creating or Modifying a Guide\n\nGuides reside in the `src` directory and are written in a modified version of the [Markdown](http://daringfireball.net/projects/markdown/) markup\nlanguage. The best way to familiarize yourself with how to use Markdown is to check out the other guides.\n\nDocpad makes it easy to see what the guides on your local machine will look like when they're published to\n[guides.sproutcore.com](http://guides.sproutcore.com). To preview your changes, run the following command from the `guides` directory:\n\n```bash\n$ docpad run\n```\n\nNow point a web browser to [localhost:9778](http://localhost:9778). This preview will keep itself updated as you make changes to the guides; all you have to do is refresh\nyour browser window to see your latest changes.\n\n## Submitting Your Changes\n\nYou can get your changes and additions included by creating a [pull request](https://help.github.com/articles/using-pull-requests) on GitHub using the\ntopic branch you created above.\n\n## Deploying a Release\n\nIn order to deploy a release, you'll need to have the\n[sproutcore-guides.github.com](https://github.com/sproutcore-guides/sproutcore-guides.github.com) repository checked out\ninto a local directory. All you need to do is use DocPad to generate the guides, copy that to the checked out live repo\nand then commit and push. It should looks something like this:\n\n    ./generate_production.sh\n    cd ../sproutcore-guides.github.com\n    git status\n    git commit -am \"New release of guides...\"\n    git push\n\n## More Information\n\nFor more information on the SproutCore Guides, including a more in depth look at committing your additions and changes, see the [contributing\nguide](http://guides.sproutcore.com/contribute.html).\n\nIf you have any questions, the team can be reached at [@sproutcore](http://twitter.com/#!/sproutcore) on Twitter, in the\n[#sproutcore](irc://irc.freenode.net/sproutcore) IRC channel on [Freenode](http://freenode.net/), or at the [SproutCore Google\nGroup](http://groups.google.com/group/sproutcore).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsproutcore%2Fguides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsproutcore%2Fguides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsproutcore%2Fguides/lists"}