smd-oss-book

This cookiecutter creates a simple boilerplate for a Jupyter Book.

Usage

Building the book

If you'd like to develop and/or build the smd-oss-book book, you should:

Clone this repository
Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
(Optional) Edit the books source files located in the smd_oss_book/ directory
Run jupyter-book clean smd_oss_book/ to remove any existing builds
Run jupyter-book build smd_oss_book/

A fully-rendered HTML version of the book will be built in smd_oss_book/_build/html/.

Hosting the book

Please see the Jupyter Book documentation to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.

For GitHub and GitLab deployment specifically, the cookiecutter-jupyter-book includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose github for the include_ci cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the gh-pages branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits