Docs

Theme by Parse community

|

Updated: 21 Mar 2025

|

317 Stars

Parse Platform docs

Categories

Overview

The Parse Docs repository contains markdown sources for all of the Parse SDK guides. This repo utilizes Jekyll to generate a static site hosted on GitHub Pages. The guides are organized by platform inside the _includes directory, with each platform directory containing markdown files for each main section in the guide. Additionally, there is a _includes/common folder that holds content shared among all guides. The repository is public, allowing users to access and store a local copy of the markdown files.

Features

• Organized guide structure: The guides are organized by platform, making it easy to find relevant information for a specific platform.
• Shared content: The _includes/common folder contains content that is shared across all guides, minimizing duplicate content and ensuring consistency.
• Static site generation: Jekyll is used to generate a static site from the markdown sources, allowing for easy deployment and hosting on GitHub Pages.
• Offline access: Since the repository is public and the files are in markdown, users can keep a local copy for offline access.
• **Contribution: **Users are encouraged to contribute by suggesting fixes or sending pull requests to help improve the documentation.

Installation

To run the site locally, follow these steps:

1. Make sure you have Ruby, Bundler, and npm installed on your system.
2. Clone the repository to your local machine.
3. Install Jekyll and node packages by running the following command in the project directory:

bundle install
npm install

4. Run webpack and Jekyll using the following command:

bundle exec jekyll serve --watch

5. Finally, open http://localhost:4000/ in your web browser to access the locally hosted site. Any changes to the files will be output to _site folder, and the browser will auto-refresh.

Summary

The Parse Docs repository provides a convenient and easily accessible collection of SDK guides for various platforms. With its organized structure, shared content, and static site generation, users can quickly find the information they need and contribute to the improvement of the documentation. The option to access the docs offline and the straightforward installation process further enhance the usability of this repository.