# Welcome to Jekyll! # # This config file is meant for settings that affect your whole blog, values # which you are expected to set up once and rarely edit after that. If you find # yourself editing this file very often, consider using Jekyll's data files # feature for the data you need to update frequently. # # For technical reasons, this file is *NOT* reloaded automatically when you use # 'bundle exec jekyll serve'. If you change this file, please restart the server process. # Site settings # These are used to personalize your new site. If you look in the HTML files, # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. # You can create any custom variable you would like, and they will be accessible # in the templates via {{ site.myvariable }}. ####################################################################################### # Jekyll site settings title: Qiskit Textbook author: The Qiskit Team description: >- # this means to ignore newlines until "baseurl:" A university quantum algorithms/computation course supplement based on Qiskit baseurl: "/textbook" # the subpath of your site, e.g. /blog. If there is no subpath for your site, use an empty string "" url: "https://community.qiskit.org" # the base hostname & protocol for your site, e.g. http://example.com port: 80 ####################################################################################### # Jupyter Book settings # Main page settings footer_text : This page was created by <a href="https://github.com/jupyter/jupyter-book/graphs/contributors">The Jupyter Book Community</a> # Sidebar settings sidebar_title : 'Learn Quantum Computation using Qiskit' show_sidebar : true # Show the sidebar. Only set to false if your only wish to host a single page. collapse_inactive_chapters: true # Whether to collapse the inactive chapters in the sidebar collapse_inactive_sections: true # Whether to collapse the sub-sections within a non-active section in the sidebar textbook_logo : images/preface_illustration.svg # A logo to be displayed at the top of your textbook sidebar. Should be square textbook_logo_link : https://qiskit.org/ # A link for the logo. sidebar_footer_text : 'Powered by <a href="https://github.com/jupyter/jupyter-book">Jupyter Book</a>' number_toc_chapters : true # Whether to add numbers to chapterse in your Table of Contents. If true, you can control this at the Chapter level in _data/toc.yml # Search settings search_max_words_in_content : 100 # In the search function, use at most this many words (too many words will make search slow) # Controlling page information page_titles : infer # Either `None`, `infer`, or `toc` page_authors : None # Either `None` or `infer` filename_title_split_character : '_' # If inferring titles based on filename, splt on this character. # Math settings number_equations : false # Whether to automatically number all block equations with MathJax ####################################################################################### # Interact link settings # General interact settings use_jupyterlab : true # If 'true', interact links will use JupyterLab as the interface # Jupyterhub link settings use_jupyterhub_button : false # If 'true', display a button that will direct users to a JupyterHub (that you provide) jupyterhub_url : "" # The URL for your JupyterHub. If no URL, use "" jupyterhub_interact_text : "Interact on IBM Quantum Experience" # The text that interact buttons will contain. # Binder link settings use_binder_button : true # If 'true', add a binder button for interactive links binderhub_url : "https://mybinder.org" # The URL for your BinderHub. If no URL, use "" iqx_url : "https://quantum-computing.ibm.com/jupyter/user/qiskit-textbook" # Link to IQX binder_repo_base : "https://github.com/" # The site on which the textbook repository is hosted binder_repo_org : "qiskit-community" # The username or organization that owns this repository binder_repo_name : "qiskit-textbook" # The name of the repository on the web binder_repo_branch : "thebe-stable" # The branch on which your textbook is hosted. binderhub_interact_text : "Interact on IBM Quantum Experience" # The text that interact buttons will contain. # Thebelab settings use_thebelab_button : true # If 'true', display a button to allow in-page running code cells with Thebelab thebelab_button_text : "Interact Here" # The text to display inside the Thebelab initialization button hardware_warning_message : "This cell uses quantum hardware. To run it in your browser, please " # message to display above hardware-using cells hardware_warning_linktxt : "click here to go to the IBM Quantum Experience." # text to appear in the link next to the warning codemirror_theme : "abcdef" # Theme for codemirror cells, for options see https://codemirror.net/doc/manual.html#config # nbinteract settings use_show_widgets_button : true # If 'true', display a button to allow in-page running code cells with nbinteract # Download settings use_download_button : true # If 'true', display a button to download a zip file for the notebook download_button_text : "Download" # The text that download buttons will contain download_page_header : "Made with Jupyter Book" # A header that will be displayed at the top of and PDF-printed page ####################################################################################### # Jupyter book extensions and additional features # Bibliography and citation settings. See https://github.com/inukshuk/jekyll-scholar#configuration for options scholar: style: apa ####################################################################################### # Option to add a Goggle analytics tracking code # Navigate to https://analytics.google.com, add a new property for your jupyter book and copy the tracking id here. google_analytics: mytrackingcode: ####################################################################################### # Jupyter book settings you probably don't need to change content_folder_name : "content" # The folder where your raw content (notebooks/markdown files) are located images_url : "/assets/images" # Path to static image files css_url : "/assets/css" # Path to static CSS files js_url : "/assets/js" # Path to JS files custom_static_url : "/assets/custom" # Path to user's custom CSS/JS files vendor_url : "/assets/vendor" # Path to 3rd party libs ####################################################################################### # Jekyll build settings (only modify if you know what you're doing) # Site settings defaults: - scope: path: "" values: layout: "default" toc: true toc_label: " On this page" toc_icon: "list-ul" excerpt: '' favicon_path: "images/logo/favicon.ico" include: ['*.bib'] # Markdown Processing markdown: kramdown kramdown: input: GFM syntax_highlighter: rouge sass: style: compressed collections: build: output: true permalink: /:path.html # Exclude from processing. # The following items will not be processed, by default. Create a custom list # to override the default setting. exclude: - scripts/ - Gemfile - Gemfile.lock - node_modules - vendor/bundle/ - vendor/cache/ - vendor/gems/ - vendor/ruby/ plugins: - jekyll-redirect-from - jekyll-scholar # Jupyter Book version - DO NOT CHANGE THIS. It is generated when a new book is created jupyter_book_version: "0.6.4"