https://github.com/peterpme/flow-dash

Flow (by facebook) docset documentation source for Dash (http://kapeli.com/dash)
https://github.com/peterpme/flow-dash

Last synced: 3 months ago
JSON representation

Flow (by facebook) docset documentation source for Dash (http://kapeli.com/dash)

• Host: GitHub
• URL: https://github.com/peterpme/flow-dash
• Owner: peterpme
• Created: 2017-07-28T19:06:44.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-28T19:07:07.000Z (almost 8 years ago)
• Last Synced: 2025-01-19T16:51:24.942Z (5 months ago)
• Language: JavaScript
• Homepage: http://flowtype.org/
• Size: 45.9 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [Flow](http://flowtype.org/) (A static type checker for javascript. From facebook) documentation for [Dash](http://kapeli.com/dash)

[![Known Vulnerabilities](https://snyk.io/test/github/epitaphmike/flow-dash/badge.svg)](https://snyk.io/test/github/epitaphmike/flow-dash) [![Build Status](https://travis-ci.org/epitaphmike/flow-dash.svg?branch=master)](https://travis-ci.org/epitaphmike/flow-dash)

## Installation in Dash

**To install the Flow documentation in Dash, go to:**

Preferences >> Downloads >> User Contributed

This repo is used to generate those docs. You don't need to touch it unless you want to contribute to it.

To update the docset, please read the instructions [here](https://github.com/Kapeli/Dash-User-Contributions#contribute-a-new-docset) (more specifically, "Set up your directory structure"). To generate the docset for your Dash-User-Contributions pull request, you'd use this repo.

**Note**: If you do wish to update the docset, please notify me by [opening an issue](https://github.com/epitaphmike/flow-dash/issues/new). I'd like to double check everything before you send it off to the Dash repo.

## Docset Manual Build Instructions

Prerequisites: wget, node and sqlite3. For OS X:

    brew install wget node sqlite3

Clone this repo, `cd` into it and do:

    npm install

    chmod 777 build.sh

    ./build.sh

The script will:

- Fetch the newest released Flow documentation from http://flowtype.org/docs/.

- Parse the doc site into a new SQLite database for Dash. The list of files are hardcoded. Please check `src/index.js` for more detail.

- Bundle up the result in a Flow.docset.

- GZip for Dash contribution

Test the output by loading the Flow.docset (importing it into Dash).