Giter VIP home page Giter VIP logo

coldbox.dashdocs's Introduction

coldbox.dashdocs

DashDocs generator for ColdBox API documentation

###To Install DocSet:

  1. Clone this project
  2. In Dash, go to Manage DocSets
  3. Click (+) in lower left
  4. Browse to this project and select the .docset folder corresponding to version you want to install

###To Create a DocSet For a Different Version of ColdBox (ex 3.5.1)

This process has only been tested on OSX 10.9. Pre-requisites:

  • Python (should be available on OSX already)
  • BeautifulSoup python library (download, then python setup.py install)
  1. Clone this project

  2. Duplicate one of the existing docset folders, renaming to your version (ColdBox 3.5.1.docset)

  3. Edit ./ColdBox 3.5.1.docset/Contents/Info.plist, change the version in CFBundleName key.

  4. Delete everything in ./ColdBox 3.5.1.docset/Contents/Resources/Documents/

  5. Download the API docs for your version from http://www.coldbox.org/api

  6. Copy the API docs for your version to ./ColdBox 3.5.1.docset/Contents/Resources/Documents/

  7. Run the search index populator script included in this project, passing your docset directory name as second arg:

    python cbdoc2set.py ColdBox\ 3.5.1.docset

coldbox.dashdocs's People

Contributors

elpete avatar lmajano avatar sjdaniels avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

elpete

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.