Skip to content

Commit

Permalink
Update README instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
hramos committed Jul 26, 2016
1 parent 80d1c38 commit f4478aa
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,40 @@
# Parse Docs

A static site that serves Parse's documentation using Jekyll on GitHub Pages. Work in progress.
These are the markdown sources for all of the [Parse SDK guides](https://parseplatform.github.io/#sdks). The content for the guides is stored in this repo, and we use Jekyll to generate a static site that is hosted on GitHub Pages.

## Setup
## Repository Structure

Install Jekyll and node packages:
The guides are organized by platform. Each platform directory contains a set of markdown files, one for each main section in the guide.

.
├── {platform}
│ └── {section}
└── common
└── {section}

For example, `/ios/` contains all of sections for the iOS guide. There is also a `common` folder that contains content that is shared amongst all of the guides. It helps us avoid duplicating content unnecessarily.

## Can I Access The Docs Offline?

This repository is public and all the files are in markdown. If you'd like to keep a copy locally, please do!

## How Do I Contribute?

If you have any fixes or suggestions, simply send us a pull request!

### Running The Site Locally

Clone this repository, then install Jekyll and node packages:

```
bundle install
npm install
```

## Development

Run webpack and Jekyll:
Then run webpack and Jekyll:

```
npm start
```

Finally, open http://localhost:4000/docs/ios/guide/ in your web browser.

0 comments on commit f4478aa

Please sign in to comment.