https://github.com/giswqs/jupyter-book-demo

A Jupyter book demo.
https://github.com/giswqs/jupyter-book-demo

jupyter-notebook jupyterbook markdown website website-template

Last synced: 28 days ago
JSON representation

A Jupyter book demo.

• Host: GitHub
• URL: https://github.com/giswqs/jupyter-book-demo
• Owner: giswqs
• License: cc-by-4.0
• Created: 2022-04-01T13:43:42.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T18:52:59.000Z (3 months ago)
• Last Synced: 2024-10-24T15:57:09.304Z (3 months ago)
• Topics: jupyter-notebook, jupyterbook, markdown, website, website-template
• Language: TeX
• Homepage: https://giswqs.github.io/jupyter-book-demo
• Size: 3.55 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jupyter Book Demo

This is a Jupyter book demo

## Usage

### Building the book

If you'd like to develop and/or build the Jupyter Book Demo book, you should:

1. Clone this repository

2. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)

3. (Optional) Edit the books source files located in the `jupyter-book-demo/` directory

4. Run `jupyter-book clean .` to remove any existing builds

5. Run `jupyter-book build .` to build the book

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

### Hosting the book

Please see the [Jupyter Book documentation](https://jupyterbook.org/publish/web.html) 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](https://github.com/executablebooks/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](https://github.com/giswqs/jupyter-book-demo/graphs/contributors).

## Credits

This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).