Docs

screenshot of Docs
jekyll

Parse Platform docs

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.

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.

jekyll
Jekyll

Jekyll is a static site generator written in Ruby that allows you to create simple, fast, and secure websites without the need for a database.

documentation
Documentation

Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.

webpack
Webpack

Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.