Skip to content

Commit

Permalink
adding a license
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf committed Nov 16, 2018
1 parent cfc14ed commit 38cf44a
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Jupyter Books <img src="content/images/logo/logo.png" width=40 />
# <img src="content/images/logo/logo.png" width=40 /> Jupyter Books


This is a guide and template for hosting your own book using
Expand Down
5 changes: 5 additions & 0 deletions content/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# License for this book

All content in this book (ie, any files and content in the `content/` folder)
is licensed under the
[Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) (CC BY-SA 4.0) license.
25 changes: 24 additions & 1 deletion content/guide/03_configure.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
## Site configuration
## Add content to your book

Jupyter Book expects all of your content to be placed in the `/content/` directory
of the repository. You should place the following files somewhere in this directory:

* notebook files for your content
* markdown files for your content
* any images referenced in notebook / markdown files.
Make sure to use relative paths for your images!
* Any other files you'd like copied over to the `/_build/` directory when you build
your book.

## Configure your book

You can configure several aspects of your site. This is primarily done
by changing [the values in `_config.yml`](https://github.com/choldgraf/jupyter-book/blob/master/_config.yml). Values that are unique to the
Expand All @@ -15,3 +27,14 @@ any javascript that you wish. To do so, find the relevant folders in the `assets

This site uses SCSS to make it easier to create modular and beautiful CSS rules. If you create
a new CSS file, make sure that you include it in `_sass/main.scss`.

## (optional) choose a different license

By default, all content in the `content/` folder is licensed under the
[Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) (CC BY-SA 4.0) license. This is specified in the LICENSE.md file.

CC BY-SA requires attribution of your work, and also requires that any derivations
someone creates are released under a license *at least as permissive* as CC BY-SA.

If you'd like to choose a different license, you can modify the text in LICENSE.md to
whatever you'd like.
2 changes: 2 additions & 0 deletions content/guide/04_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ To build your site, take the following steps.:

This will:

* Use the links specified in the `_data/toc.yml` file (pointing to files in `/content/`) and
do the following:
* Run `nbconvert` to turn the `.ipynb` files into markdown
* Replace relative image file paths so that they work on your new built site
* Clean up formatting issues for things like MathJax to display properly
Expand Down

0 comments on commit 38cf44a

Please sign in to comment.