https://github.com/rgarcia/dochub

speedy docs
https://github.com/rgarcia/dochub

Last synced: 16 days ago
JSON representation

speedy docs

• Host: GitHub
• URL: https://github.com/rgarcia/dochub
• Owner: rgarcia
• License: wtfpl
• Archived: true
• Created: 2011-11-10T21:11:33.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2020-11-14T17:35:58.000Z (almost 4 years ago)
• Last Synced: 2024-08-01T05:21:47.833Z (3 months ago)
• Language: JavaScript
• Homepage: http://dochub.io/
• Size: 6.24 MB
• Stars: 795
• Watchers: 41
• Forks: 107
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Runnning locally

Run the server:

    npm install # downloads dependencies for web server

    node web.js

Open http://localhost:5000/ in your browser.

# Scraper

The `static/data/` directory contains our scrape of the sites we get content from. Right now we don't update this very often. If you want the most up-to-date content, you can run the scrapers:

    cd scraper

    npm install # downloads dependencies for scrapers

    (cd css-mdn;  node scrape.js)

    (cd html-mdn; node scrape.js)

    (cd js-mdn;   node scrape.js)

    (cd dom-mdn;  node scrape.js)

    (cd jquery;   node scrape.js)

# Notes

How to use the r.js optimizer:

    node node_modules/requirejs/bin/r.js -o static/js/app.build.js

Make sure the node server is serving the correct static folder

(whether you want /static or /static-build).