An open API service indexing awesome lists of open source software.

https://github.com/think2011/lodash-zh

lodash4+文档翻译
https://github.com/think2011/lodash-zh

Last synced: 12 months ago
JSON representation

lodash4+文档翻译

Awesome Lists containing this project

README

          

# lodash doc

http://lodash.think2011.net

This is a trial doc website for lodash, generated from markdown using [pub-server](http://jldec.github.io/pub-doc)

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

```sh
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

```sh
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.
```sh
npm run generate
```

To preview the generated static output at http://localhost:3001/
```sh
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:

```bash
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".

```bash
git remote add origin https://github.com//.git
git push -u origin gh-pages
```