A QuantEcon Book for MyST Markdown

A dedicated MyST interactive book theme for the QuantEcon lectures and books.

• Responsive and mobile ready
• Page Footer based on MyST Content
• Bundled QuantEcon brand assets

Downloads

A when downloads are available on a page a download button will appear in the top toolbar. The contents of the menu available from that button is configured via the download configuration of the MyST project and page. Typically, a download of the entire book as a PDF is provided along with downloads of each lecture in PDF and Notebook (md) form.

To achieve this the following configuration should be added to build and expose the downloads.

At the project level:

# myst.yml
project:
  ...
  exports:
    - id: book-pdf
      format: pdf
      template: plain_latex_book
      output: exports/quantecon-python-intro.pdf
  downloads:
    - id: book-pdf
      title: Book (PDF)

And then on each page:

# long_run_growth.md
exports:
  - format: pdf
    template: plain_latex_book
    output: exports/long_run_growth.pdf
downloads:
  - file: exports/long_run_growth.pdf
    title: Lecture (PDF)
  - file: ./long_run_growth.md
    title: Notebook (md)

Launch Notebooks

The launch notebooks capability has been developed to mirror capabilities in the previous QuantEcon theme. It is assumed that the .notebooks suffix convention for repository naming is used when launching both Google Colab and Private Jupyter Hub sessions.

Usage with MyST

To use this template locally, update your site template make sure your project's local dependencies are installed:

site:
  template: https://github.com/curvenote-themes/quantecon/archive/refs/heads/main.zip

Then start the local server:

myst start

Open up http://localhost:3000 and you should be ready to go!

Development

To run a local development server:

cd quantecon-theme
npm install
npm run dev

Release

To bundle and release this theme run:

make deploy

This will build a bundled version of the theme and push to the repository at https://github.com/curvenote-themes/quantecon.

Development

Run a myst content server:

myst start --headless

After cloning the repository, install the packages and start the server:

npm install
npm run dev

You should then be able to make changes with hot-reload.