Skip to content

Commit

Permalink
Add binder to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
greenape committed Sep 16, 2020
1 parent a8d86fc commit 4fc1cf5
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,23 @@ markdown_extensions:
- codehilite
```

## Example
### Binder

You can also choose to have mknotebooks insert a [Binder](https://mybinder.org) link into each notebook.

``` mkdocs.yml
- mknotebooks:
binder: true
binder_service_name: "gh"
binder_branch: "master"
```

If you are using GitLab, you will need to set `binder_service_name` to `"gl"`.

## Examples

Example docs projects demonstrating the [use of a preamble](examples/execute_with_preamble) and [Binder](examples/binder_logo) are. Try them out by running `pipenv install && pipenv run mkdocs serve`.

An [example docs project](examples/execute_with_preamble) demonstrating the above is included. Try it out by running `pipenv install && pipenv run mkdocs serve`.

## Inspecting generated markdown

Expand Down

0 comments on commit 4fc1cf5

Please sign in to comment.