_config.yml 4.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. # Welcome to Jekyll!
  2. #
  3. # This config file is meant for settings that affect your whole blog, values
  4. # which you are expected to set up once and rarely edit after that. If you find
  5. # yourself editing this file very often, consider using Jekyll's data files
  6. # feature for the data you need to update frequently.
  7. #
  8. # For technical reasons, this file is *NOT* reloaded automatically when you use
  9. # 'bundle exec jekyll serve'. If you change this file, please restart the server process.
  10. # Site settings
  11. # These are used to personalize your new site. If you look in the HTML files,
  12. # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
  13. # You can create any custom variable you would like, and they will be accessible
  14. # in the templates via {{ site.myvariable }}.
  15. #######################################################################################
  16. # Jekyll site settings
  17. title: Jupyter Books
  18. author: Samuel Lau and Deborah Nolan and Chris Holdgraf
  19. email: samlau95@berkeley.edu
  20. description: >- # this means to ignore newlines until "baseurl:"
  21. This is an example book built with Jupyter Books.
  22. baseurl: "/jupyter-book" # the subpath of your site, e.g. /blog
  23. url: "https://predictablynoisy.com" # the base hostname & protocol for your site, e.g. http://example.com
  24. #######################################################################################
  25. # Jupyter Book settings
  26. # Textbook settings
  27. content_folder_name : "content" # The folder where your raw content (notebooks/markdown files) are located
  28. textbook_logo : images/logo/logo.png # A logo to be displayed at the top of your textbook sidebar
  29. hide_cell_text : "# HIDDEN" # When building the textbook, any cells with this text inside will be hidden in the output markdown
  30. hide_code_text : "# NO CODE" # When building the textbook, any cells with this text inside will have *only* their output shown (no code)
  31. css_url : "/assets/css" # Path to static CSS files
  32. js_url : "/assets/js" # Path to JS files
  33. collapse_inactive_chapters: true # Whether to collapse the inactive chapters in the sidebar
  34. # Interact link settings
  35. hub_url : "https://mybinder.org" # The URL for your JupyterHub/BinderHub.
  36. hub_name : "JupyterHub" # The name of your JupyterHub (used for the button in the NavBar. If an empty string, no button is shown)
  37. hub_type : "binder" # ['binder', 'jupyterhub'] Whether to build interact links for a BinderHub or a JupyterHub
  38. binder_repo_base : "https://github.com/" # The site on which the textbook repository is hosted
  39. binder_repo_org : "choldgraf" # The username or organization that owns this repository
  40. binder_repo_name : "jupyter-book" # The name of the repository on the web
  41. binder_repo_branch : "master" # The branch on which your textbook is hosted.
  42. use_jupyterlab : false # If 'true', interact links will use JupyterLab as the interface
  43. interact_text : "Interact" # The text that interact buttons will contain.
  44. #######################################################################################
  45. # Jekyll build settings
  46. # Site settings (only modify if you know what you're doing)
  47. defaults:
  48. - scope:
  49. path: ""
  50. values:
  51. layout: "default"
  52. toc: true
  53. toc_label: " On this page"
  54. toc_icon: "list-ul"
  55. favicon_path: "images/logo/favicon.ico"
  56. # Markdown Processing
  57. markdown: kramdown
  58. kramdown:
  59. input: GFM
  60. syntax_highlighter: rouge
  61. sass:
  62. style: compressed
  63. collections:
  64. build:
  65. output: true
  66. permalink: /:path.html
  67. # Exclude from processing.
  68. # The following items will not be processed, by default. Create a custom list
  69. # to override the default setting.
  70. exclude:
  71. - notebooks/
  72. - add_section_numbers_to_book.py
  73. - convert_notebooks_to_html_partial.py
  74. - Gemfile
  75. - Gemfile.lock
  76. - node_modules
  77. - vendor/bundle/
  78. - vendor/cache/
  79. - vendor/gems/
  80. - vendor/ruby/
  81. - scripts/
  82. plugins:
  83. - jekyll-redirect-from