nbdev-jekyll-theme

A Jekyll theme for nbdev based on documentation-theme-jekyll.

Usage

We recommend that you use repo template nbdev template or the nbdev_new CLI command to create new nbdev projects. nbdev template containts this theme as well as other supporting files needed for nbdev.

Development

The following are instructions for using nbdev-jekyll-theme without the template, which can be useful for testing or development.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-remote-theme"

And add these lines to your Jekyll site's _config.yml:

plugins:
    - jekyll-remote-theme
    
remote_theme: fastai/nbdev-jekyll-theme

And then execute:

> bundle install

Serving

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

Overriding This Theme

Any site that uses this theme will only use the files in _layouts, _includes, _sass and assets. If you wish to override this theme, you must create the same directory and file in your local project. For example, to change your site's favicon, you can create a file named assets/images/favicon.ico to override the default favicon contained in this theme.

Note: This theme does not distribute certain files that are bundled with nbdev template such as sitemap.xml, feed.xml, and various configuration files and notebooks.

Resources

• Jekyll Docs
• How to create a Jekyll Theme
• nbdev docs
• nbdev repo template