lodash doc

http://lodash.think2011.net

This is a trial doc website for lodash, generated from markdown using pub-server

To edit the site locally, clone https://github.com/jldec/lodash-doc-src, then

npm install

pub-config.js points to the lodash source code in '../../lodash/lodash/lodash.js'. Either modify pub-config to point to the actual source location, or clone lodash to match this.

To generate the doc site and preview at http://localhost:3001/ while you edit

npm run develop

The browser preview will auto-reload whenever you save a file.

To generate a new set of html and copy static files into ./out.

npm run generate

To preview the generated static output at http://localhost:3001/

npm run static

To publish to gh-pages, use a separate repo with just a gh-pages branch in the ./out directory. To set this up the first time:

cd out
git init
git add -A
git commit -m 'first pub-server output'
git branch -m gh-pages

The last step above just renames the default "master" branch to "gh-pages".

Follow the normal process to create a new repo on Gitub and use the suggested commands for intializing that with an existing repo, except when you git push -u the first time, replace "master" with "gh-pages".

git remote add origin https://github.com/<id>/<repo>.git
git push -u origin gh-pages