Skip to content

Commit

Permalink
add info about MkDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
caseyjhol committed Feb 19, 2016
1 parent 9815556 commit 23efad2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,18 @@ Bootstrap-select is a jQuery plugin that utilizes Bootstrap's dropdown.js to sty

## Demo and Documentation

See a Bootstrap 3 example [here](http:https://silviomoreto.github.io/bootstrap-select).
You can view a live demo and some examples of how to use the various options [here](http:https://silviomoreto.github.io/bootstrap-select).

Bootstrap-select's documentation, included in this repo in the root directory, is built with MkDocs and publicly hosted on GitHub Pages at http:https://silviomoreto.github.io/bootstrap-select. The documentation may also be run locally.


### Running documentation locally

1. If necessary, [install MkDocs](http:https://www.mkdocs.org/#installation).
3. From the `/bootstrap-select/docs` directory, run `mkdocs serve` in the command line.
4. Open `http:https://127.0.0.1:8000/` in your browser, and voilà.

Learn more about using MkDocs by reading its [documentation](http:https://www.mkdocs.org/).

## Authors

Expand Down

0 comments on commit 23efad2

Please sign in to comment.