Contents

11 | {% for category in site.categories %} 12 | {% capture category_name %}{{ category | first }}{% endcapture %} 13 |

14 | {% endfor %} 15 |

26 |

{{post.title}} • {{ post.date | date: date_format }}

27 |

12 |

13 |

14 |

17 |

18 |

19 |

/media 11 | for FILENAME in ${GITHUB_WORKSPACE}/_word/*.docx; do 12 | [ -e "$FILENAME" ] || continue # skip when glob doesn't match 13 | NAME=${FILENAME##*/} # Get filename without the directory 14 | NEW_NAME=`python3 "/fastpages/word2post.py" "${FILENAME}"` # clean filename to be Jekyll compliant for posts 15 | BASE_NEW_NAME=${NEW_NAME%.md} # Strip the file extension 16 | 17 | if [ -z "$NEW_NAME" ]; then 18 | echo "Unable To Rename: ${FILENAME} to a Jekyll complaint filename for blog posts" 19 | exit 1 20 | fi 21 | 22 | echo "Converting: ${NAME} ---to--- ${NEW_NAME}" 23 | cd ${GITHUB_WORKSPACE} 24 | pandoc --from docx --to gfm --output "${GITHUB_WORKSPACE}/_posts/${NEW_NAME}" --columns 9999 \ 25 | --extract-media="assets/img/${BASE_NEW_NAME}" --standalone "${FILENAME}" 26 | 27 | # Inject correction to image links in markdown 28 | sed -i.bak 's/!\[\](assets/!\[\]({{ site.url }}{{ site.baseurl }}\/assets/g' "_posts/${NEW_NAME}" 29 | # Remove intermediate files 30 | rm _posts/*.bak 31 | done 32 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: 5 | - master # need to filter here so we only deploy when there is a push to master 6 | # no filters on pull requests, so intentionally left blank 7 | pull_request: 8 | 9 | jobs: 10 | build-site: 11 | if: ( github.event.commits[0].message != 'Initial commit' ) || github.run_number > 1 12 | runs-on: ubuntu-latest 13 | steps: 14 | 15 | - name: Copy Repository Contents 16 | uses: actions/checkout@master 17 | with: 18 | persist-credentials: false 19 | 20 | - name: fastpages repo only - convert notebooks and word docs to posts 21 | if: github.repository == 'fastai/fastpages' 22 | uses: ./ # use code in this repo instead of a pinned version, for testing. 23 | 24 | - name: convert notebooks and word docs to posts 25 | if: github.repository != 'fastai/fastpages' 26 | uses: fastai/fastpages@v2.1.2 # use a pinned version 27 | 28 | - name: setup directories for Jekyll build 29 | run: | 30 | rm -rf _site 31 | sudo chmod -R 777 . 32 | 33 | - name: Jekyll build 34 | uses: docker://jekyll/jekyll 35 | with: 36 | args: jekyll build -V 37 | 38 | - name: copy CNAME file into _site if CNAME exists 39 | run: | 40 | sudo chmod -R 777 _site/ 41 | cp CNAME _site/ 2>/dev/null || : 42 | 43 | - name: Deploy 44 | if: github.event_name == 'push' 45 | uses: peaceiris/actions-gh-pages@v3 46 | with: 47 | deploy_key: ${{ secrets.SSH_DEPLOY_KEY }} 48 | publish_dir: ./_site 49 | -------------------------------------------------------------------------------- /_word/README.md: -------------------------------------------------------------------------------- 1 | # Automatically Convert MS Word (*.docx) Documents To Blog Posts 2 | 3 | _Note: You can convert Google Docs to Word Docs by navigating to the File menu, and selecting Download > Microsoft Word (.docx)_ 4 | 5 | [`fastpages`](https://github.com/fastai/fastpages) will automatically convert Word Documents (.docx) saved into this directory as blog posts!. Furthermore, images in your document are saved and displayed as you would expect on your blog post automatically. 6 | 7 | ## Usage 8 | 9 | 1. Create a Word Document (must be .docx) with the contents of your blog post. 10 | 11 | 2. Save your file with the naming convention `YYYY-MM-DD-*.docx` into the `/_word` folder of this repo. For example `2020-01-28-My-First-Post.docx`. This [naming convention is required by Jekyll](https://jekyllrb.com/docs/posts/) to render your blog post. 12 | - Be careful to name your file correctly! It is easy to forget the last dash in `YYYY-MM-DD-`. Furthermore, the character immediately following the dash should only be an alphabetical letter. Examples of valid filenames are: 13 | 14 | ```shell 15 | 2020-01-28-My-First-Post.docx 16 | 2012-09-12-how-to-write-a-blog.docx 17 | ``` 18 | 19 | - If you fail to name your file correctly, `fastpages` will automatically attempt to fix the problem by prepending the last modified date of your notebook to your generated blog post. However, it is recommended that you name your files properly yourself for more transparency. 20 | 21 | 3. Synchronize your files with GitHub by [following the instructions in this blog post](https://www.fast.ai/2020/01/18/gitblog/). 22 | -------------------------------------------------------------------------------- /_action_files/nb2post.py: -------------------------------------------------------------------------------- 1 | """Converts Jupyter Notebooks to Jekyll compliant blog posts""" 2 | from datetime import datetime 3 | import re, os, logging 4 | from nbdev import export2html 5 | from nbdev.export2html import Config, Path, _re_digits, _to_html, _re_block_notes 6 | from fast_template import rename_for_jekyll 7 | 8 | warnings = set() 9 | 10 | # Modify the naming process such that destination files get named properly for Jekyll _posts 11 | def _nb2htmlfname(nb_path, dest=None): 12 | fname = rename_for_jekyll(nb_path, warnings=warnings) 13 | if dest is None: dest = Config().doc_path 14 | return Path(dest)/fname 15 | 16 | # Add embedded links for youtube and twitter 17 | def add_embedded_links(cell): 18 | "Convert block quotes to embedded links in `cell`" 19 | _styles = ['youtube', 'twitter'] 20 | def _inner(m): 21 | title,text = m.groups() 22 | if title.lower() not in _styles: return f"> {m.groups()[0]}: {m.groups()[1]}" 23 | return '{% include '+title.lower()+".html content=\'`"+_to_html(text)+"`\' %}" 24 | if cell['cell_type'] == 'markdown': 25 | cell['source'] = _re_block_notes.sub(_inner, cell['source']) 26 | return cell 27 | 28 | # TODO: Open a GitHub Issue in addition to printing warnings 29 | for original, new in warnings: 30 | print(f'{original} has been renamed to {new} to be complaint with Jekyll naming conventions.\n') 31 | 32 | ## apply monkey patches 33 | export2html._nb2htmlfname = _nb2htmlfname 34 | export2html.process_cell.append(add_embedded_links) 35 | 36 | export2html.notebook2html(fname='_notebooks/*.ipynb', dest='_posts/', template_file='/fastpages/fastpages.tpl') 37 | 38 | -------------------------------------------------------------------------------- /_layouts/home.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 | 5 |

6 | {%- if page.title -%} 7 |

8 | {%- endif -%} 9 | 10 | {{ content }} 11 | 12 | 13 | {% if site.paginate %} 14 | {% assign posts = paginator.posts %} 15 | {% else %} 16 | {% assign posts = site.posts %} 17 | {% endif %} 18 | 19 | 20 | {%- if posts.size > 0 -%} 21 | {%- if page.list_title -%} 22 |

23 | {%- endif -%} 24 |

28 | {%- if site.show_image -%} 29 | {%- include post_list_image_card.html -%} 30 | {% else %} 31 | {%- include post_list.html -%} 32 | {%- endif -%} 33 |

36 | 37 | {% if site.paginate %} 38 | 53 | {%- endif %} 54 | 55 | {%- endif -%} 56 | 57 |

-------------------------------------------------------------------------------- /_action_files/action_entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | # setup ssh: allow key to be used without a prompt and start ssh agent 5 | export GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" 6 | eval "$(ssh-agent -s)" 7 | 8 | ######## Run notebook/word converter ######## 9 | # word converter using pandoc 10 | /fastpages/word2post.sh 11 | # notebook converter using nbdev 12 | cp /fastpages/settings.ini . 13 | python /fastpages/nb2post.py 14 | 15 | 16 | ######## Optionally save files and build GitHub Pages ######## 17 | if [[ "$INPUT_BOOL_SAVE_MARKDOWN" == "true" ]];then 18 | 19 | if [ -z "$INPUT_SSH_DEPLOY_KEY" ];then 20 | echo "You must set the SSH_DEPLOY_KEY input if BOOL_SAVE_MARKDOWN is set to true."; 21 | exit 1; 22 | fi 23 | 24 | # Get user's email from commit history 25 | if [[ "$GITHUB_EVENT_NAME" == "push" ]];then 26 | USER_EMAIL=`cat $GITHUB_EVENT_PATH | jq '.commits | .[0] | .author.email'` 27 | else 28 | USER_EMAIL="actions@github.com" 29 | fi 30 | 31 | # Setup Git credentials if we are planning to change the data in the repo 32 | git config --global user.name "$GITHUB_ACTOR" 33 | git config --global user.email "$USER_EMAIL" 34 | git remote add fastpages-origin "git@github.com:$GITHUB_REPOSITORY.git" 35 | echo "${INPUT_SSH_DEPLOY_KEY}" > _mykey 36 | chmod 400 _mykey 37 | ssh-add _mykey 38 | 39 | # Optionally save intermediate markdown 40 | if [[ "$INPUT_BOOL_SAVE_MARKDOWN" == "true" ]]; then 41 | git pull fastpages-origin ${GITHUB_REF} --ff-only 42 | git add _posts 43 | git commit -m "[Bot] Update $INPUT_FORMAT blog posts" --allow-empty 44 | git push fastpages-origin HEAD:${GITHUB_REF} 45 | fi 46 | fi 47 | 48 | 49 | 50 | -------------------------------------------------------------------------------- /_posts/2020-01-14-test-markdown-post.md: -------------------------------------------------------------------------------- 1 | --- 2 | toc: true 3 | description: A minimal example of using markdown with fastpages. 4 | categories: [fastpages, markdown] 5 | --- 6 | # Example Markdown Post 7 | 8 | ## Basic setup 9 | 10 | Jekyll requires blog post files to be named according to the following format: 11 | 12 | `YEAR-MONTH-DAY-filename.md` 13 | 14 | Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `filename` is whatever file name you choose, to remind yourself what this post is about. `.md` is the file extension for markdown files. 15 | 16 | The first line of the file should start with a single hash character, then a space, then your title. This is how you create a "*level 1 heading*" in markdown. Then you can create level 2, 3, etc headings as you wish but repeating the hash character, such as you see in the line `## File names` above. 17 | 18 | ## Basic formatting 19 | 20 | You can use *italics*, **bold**, `code font text`, and create [links](https://www.markdownguide.org/cheat-sheet/). Here's a footnote [^1]. Here's a horizontal rule: 21 | 22 | --- 23 | 24 | ## Lists 25 | 26 | Here's a list: 27 | 28 | - item 1 29 | - item 2 30 | 31 | And a numbered list: 32 | 33 | 1. item 1 34 | 1. item 2 35 | 36 | ## Boxes and stuff 37 | 38 | > This is a quotation 39 | 40 | {% include alert.html text="You can include alert boxes" %} 41 | 42 | ...and... 43 | 44 | {% include info.html text="You can include info boxes" %} 45 | 46 | ## Images 47 | 48 | ![]({{ site.baseurl }}/images/logo.png "fast.ai's logo") 49 | 50 | ## Code 51 | 52 | General preformatted text: 53 | 54 | # Do a thing 55 | do_thing() 56 | 57 | Python code and output: 58 | 59 | ```python 60 | # Prints '2' 61 | print(1+1) 62 | ``` 63 | 64 | 2 65 | 66 | 67 | ## Tables 68 | 69 | | Column 1 | Column 2 | 70 | |-|-| 71 | | A thing | Another thing | 72 | 73 | 74 | ## Tweetcards 75 | 76 | {% twitter https://twitter.com/jakevdp/status/1204765621767901185?s=20 %} 77 | 78 | 79 | ## Footnotes 80 | 81 | 82 | 83 | [^1]: This is the footnote. 84 | 85 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | # Welcome to Jekyll! 2 | # 3 | # This config file is meant for settings that affect your whole blog. 4 | # 5 | # If you need help with YAML syntax, here are some quick references for you: 6 | # https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml 7 | # https://learnxinyminutes.com/docs/yaml/ 8 | 9 | title: fastpages 10 | description: An easy to use blogging platform with support for Jupyter Notebooks. 11 | github_username: fastai 12 | # you can comment the below line out if your repo name is not different than your baseurl 13 | github_repo: "fastpages" 14 | 15 | # OPTIONAL: override baseurl and url if using a custom domain 16 | url: "https://fastpages.fast.ai" # the base hostname & protocol for your site, e.g. http://example.com 17 | baseurl: "" # the subpath of your site, e.g. "/blog". WARNING: if you are not using a custom domain, the baseurl *must* be set to your repo name. 18 | 19 | # Email and twitter are optional: 20 | email: 21 | twitter_username: "fastdotai" 22 | 23 | # Set this to true to get LaTeX math equation support 24 | use_math: 25 | 26 | # Set this to true to display the summary of your blog post under your title on the Home page. 27 | show_description: true 28 | 29 | # Set this to true to display image previews on home page, if they exist 30 | show_image: false 31 | 32 | # Set this to true to display tags on each post 33 | show_tags: true 34 | 35 | # Add your Google Analytics ID here if you have one and want to use it 36 | google_analytics: 37 | 38 | exclude: 39 | - CONTRIBUTING.md 40 | - DEVELOPMENT.md 41 | - settings.ini 42 | - docker-compose.yml 43 | - action.yml 44 | - README_TEMPLATE.md 45 | - Makefile 46 | 47 | # Everything below here should be left alone. Modifications may break fastpages 48 | theme: minima 49 | plugins: 50 | - jekyll-feed 51 | - jekyll-gist 52 | - jekyll-octicons 53 | - jekyll-github-metadata 54 | - jekyll-toc 55 | - jekyll-twitter-plugin 56 | - jekyll-relative-links 57 | - jekyll-seo-tag 58 | 59 | titles_from_headings: 60 | enabled: true 61 | strip_title: true 62 | collections: true 63 | 64 | highlighter: rouge 65 | markdown: kramdown 66 | kramdown: 67 | math_engine: katex 68 | input: GFM 69 | auto_ids: true 70 | hard_wrap: false 71 | syntax_highlighter: rouge 72 | -------------------------------------------------------------------------------- /_manual_setup.md: -------------------------------------------------------------------------------- 1 | # Manual Setup Instructions 2 | 3 | These are the setup steps that are automated by [setup.yaml](.github/workflows/setup.yaml) 4 | 5 | 1. Click the [![](https://img.shields.io/static/v1?label=&message=Use%20this%20template&color=brightgreen&style=flat)](https://github.com/fastai/fastpages/generate) button to create a copy of this repo in your account. 6 | 7 | 2. [Follow these instructions to create an ssh-deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys). Make sure you **select Allow write access** when adding this key to your GitHub account. 8 | 9 | 3. [Follow these instructions to upload your deploy key](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets) as an encrypted secret on GitHub. Make sure you name your key `SSH_DEPLOY_KEY`. Note: The deploy key secret is your **private key** (NOT the public key). 10 | 11 | 4. [Create a branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch) named `gh-pages`. 12 | 13 | 5. Change the badges on this README to point to **your** repository instead of `fastai/fastpages`. Badges are organized in a section at the beginning of this README. For example, you should replace `fastai` and `fastpages` in the below url: 14 | 15 | `![](https://github.com/fastai/fastpages/workflows/CI/badge.svg)` 16 | 17 | to 18 | 19 | `![](https://github.com/{your-username}/{your-repo-name}/workflows/CI/badge.svg)` 20 | 21 | 6. Change `baseurl:` in `_config.yaml` to the name of your repository. For example, instead of 22 | 23 | `baseurl: "/fastpages"` 24 | 25 | this should be 26 | 27 | `baseurl: "/your-repo-name"` 28 | 29 | 7. Similarly, change the `url:` parameter in `_config.yaml` to the url your blog will be served on. For example, instead of 30 | 31 | `url: "https://fastpages.fast.ai/"` 32 | 33 | this should be 34 | 35 | `url: "https://.github.io"` 36 | 37 | 8. Read through `_config.yaml` carefully as there may be other options that must be set. The comments in this file will provide instructions. 38 | 39 | 9. Delete the `CNAME` file from the root of your `master` branch (or change it if you are using a custom domain) 40 | 41 | 10. Go to your [repository settings and enable GitHub Pages](https://help.github.com/en/enterprise/2.13/user/articles/configuring-a-publishing-source-for-github-pages) with the `gh-pages` branch you created earlier. -------------------------------------------------------------------------------- /_layouts/post.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 |

5 | 6 |

7 |

8 | {%- if page.description -%} 9 |

10 | {%- endif -%} 11 |

12 | {%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%} 13 | 14 | {{ page.date | date: date_format }} 15 | 16 | {%- if page.modified_date -%} 17 | ~ 18 | {%- assign mdate = page.modified_date | date_to_xmlschema -%} 19 | 20 | {{ mdate | date: date_format }} 21 | 22 | {%- endif -%} 23 | {%- if page.author -%} 24 | • {% for author in page.author %} 25 | 26 | {{ author }} 27 | {%- if forloop.last == false %}, {% endif -%} 28 | {% endfor %} 29 | {%- endif %} 30 | • {% include reading_time.html -%} 31 |

32 | 33 | {% if page.categories.size > 0 and site.show_tags %} 34 |

35 | {% for category in page.categories %} 36 | {{category}} 37 | {% unless forloop.last %} {% endunless %} 38 | {% endfor %} 39 |

40 | {% endif %} 41 | 42 | {% if page.layout == 'notebook' %} 43 | {% if page.badges or page.badges == nil %} 44 |

45 | {% include notebook_github_link.html %}{% include notebook_colab_link.html %} 46 |

47 | {% endif -%} 48 | {% endif -%} 49 |

50 | 51 |

52 | {{ content | toc }} 53 |

54 | {%- if page.comments -%} 55 | {%- include utterances.html -%} 56 | {%- endif -%} 57 | {%- if site.disqus.shortname -%} 58 | {%- include disqus_comments.html -%} 59 | {%- endif -%} 60 | 61 |

-------------------------------------------------------------------------------- /_setup_pr_template.md: -------------------------------------------------------------------------------- 1 | Hello :wave: @{_username_}! Thank you for using fastpages! 2 | 3 | ## Before you merge this PR 4 | 5 | 1. Create an ssh key-pair. Open this utility. Select: `RSA` and `4096` and leave `Passphrase` blank. Click the blue button `Generate-SSH-Keys`. 6 | 7 | 2. Navigate to this link and click `Add a new secret`. Copy and paste the **Private Key** into the `Value` field. In the `Name` field, name the secret `SSH_DEPLOY_KEY`. 8 | 9 | 3. Navigate to this link and click the `Add deploy key` button. Paste your **Public Key** from step 1 into the `Key` box. In the `Title`, name the key anything you want, for example `fastpages-key`. Finally, **make sure you click the checkbox next to `Allow write access`** (pictured below), and click `Add key` to save the key. 10 | 11 | ![](_checkbox.png) 12 | 13 | 14 | ### What to Expect After Merging This PR 15 | 16 | - GitHub Actions will build your site, which will take 3-4 minutes to complete. **This will happen anytime you push changes to the master branch of your repository.** You can monitor the logs of this if you like on the [Actions tab of your repo](https://github.com/{_username_}/{_repo_name_}/actions). 17 | - Your GH-Pages Status badge on your README will eventually appear and be green, indicating your first sucessfull build. 18 | - You can monitor the status of your site in the GitHub Pages section of your [repository settings](https://github.com/{_username_}/{_repo_name_}/settings). 19 | 20 | If you are not using a custom domain, your website will appear at: 21 | 22 | #### https://{_username_}.github.io/{_repo_name_} 23 | 24 | 25 | ## Optional: Using a Custom Domain 26 | 27 | 1. After merging this PR, add a file named `CNAME` at the root of your repo. For example, the `fastpages` blog is hosted at `https://fastpages.fast.ai`, which means [our CNAME](https://github.com/fastai/fastpages/blob/master/CNAME) contains the following contents: 28 | 29 | 30 | >`fastpages.fast.ai` 31 | 32 | 33 | 2. Change the `url` and `baseurl` parameters in your `/_config.yml` file to reflect your custom domain. 34 | 35 | 36 | Wondering how to setup a custom domain? See [this article](https://dev.to/trentyang/how-to-setup-google-domain-for-github-pages-1p58). You must add a CNAME file to the root of your master branch for the intructions in the article to work correctly. 37 | 38 | 39 | ## Questions 40 | 41 | Please use the [nbdev & blogging channel](https://forums.fast.ai/c/fastai-users/nbdev/48) in the fastai forums for any questions or feature requests. 42 | -------------------------------------------------------------------------------- /assets/js/search.js: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | {% assign counter = 0 %} 4 | var documents = [{% for page in site.pages %}{% if page.url contains '.xml' or page.url contains 'assets' or page.search == 'exclude' %}{% else %}{ 5 | "id": {{ counter }}, 6 | "url": "{{ site.url }}{{ page.url }}", 7 | "title": "{{ page.title }}", 8 | "body": "{{ page.content | markdownify | replace: '.', '. ' | replace: '', ': ' | replace: '', ': ' | replace: '', ': ' | replace: '

', ' ' | strip_html | strip_newlines | replace: ' ', ' ' | replace: '"', ' ' }}"{% assign counter = counter | plus: 1 %} 9 | }, {% endif %}{% endfor %}{% for page in site.without-plugin %}{ 10 | "id": {{ counter }}, 11 | "url": "{{ site.url }}{{ page.url }}", 12 | "title": "{{ page.title }}", 13 | "body": "{{ page.content | markdownify | replace: '.', '. ' | replace: '', ': ' | replace: '', ': ' | replace: '', ': ' | replace: '

', ' ' | strip_html | strip_newlines | replace: ' ', ' ' | replace: '"', ' ' }}"{% assign counter = counter | plus: 1 %} 14 | }, {% endfor %}{% for page in site.posts %}{ 15 | "id": {{ counter }}, 16 | "url": "{{ site.url }}{{ page.url }}", 17 | "title": "{{ page.title }}", 18 | "body": "{{ page.date | date: "%Y/%m/%d" }} - {{ page.content | markdownify | replace: '.', '. ' | replace: '', ': ' | replace: '', ': ' | replace: '', ': ' | replace: '

', ' ' | strip_html | strip_newlines | replace: ' ', ' ' | replace: '"', ' ' }}"{% assign counter = counter | plus: 1 %} 19 | }{% if forloop.last %}{% else %}, {% endif %}{% endfor %}]; 20 | 21 | var idx = lunr(function () { 22 | this.ref('id') 23 | this.field('title') 24 | this.field('body') 25 | this.metadataWhitelist = ['position'] 26 | 27 | documents.forEach(function (doc) { 28 | this.add(doc) 29 | }, this) 30 | }); 31 | function lunr_search(term) { 32 | document.getElementById('lunrsearchresults').innerHTML = '

'; 33 | if(term) { 34 | document.getElementById('lunrsearchresults').innerHTML = "

Search results for '" + term + "'

" + document.getElementById('lunrsearchresults').innerHTML; 35 | //put results on the screen. 36 | var results = idx.search(term); 37 | if(results.length>0){ 38 | //console.log(idx.search(term)); 39 | //if results 40 | for (var i = 0; i < results.length; i++) { 41 | // more statements 42 | var ref = results[i]['ref']; 43 | var url = documents[ref]['url']; 44 | var title = documents[ref]['title']; 45 | var body = documents[ref]['body'].substring(0,160)+'...'; 46 | document.querySelectorAll('#lunrsearchresults ul')[0].innerHTML = document.querySelectorAll('#lunrsearchresults ul')[0].innerHTML + "

" + title + "
"+ body +"
"+ url +"

"; 47 | } 48 | } else { 49 | document.querySelectorAll('#lunrsearchresults ul')[0].innerHTML = "

No results found...

"; 50 | } 51 | } 52 | return false; 53 | } -------------------------------------------------------------------------------- /_notebooks/2020-02-27-My-first-post.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "cell_type": "markdown", 5 | "metadata": {}, 6 | "source": [ 7 | "# This is my first test post using FastPages\n", 8 | "> \"Just a quick post\"\n", 9 | "- toc: false\n", 10 | "- branch: master\n", 11 | "- badges: true\n", 12 | "- comments: true\n", 13 | "- categories: [fastpages, jupyter, summary, statistics]\n", 14 | "- metadata_key1: metadata_value1\n", 15 | "- metadata_key2: metadata_value2" 16 | ] 17 | }, 18 | { 19 | "cell_type": "markdown", 20 | "metadata": {}, 21 | "source": [ 22 | "## Library import" 23 | ] 24 | }, 25 | { 26 | "cell_type": "code", 27 | "execution_count": 1, 28 | "metadata": {}, 29 | "outputs": [], 30 | "source": [ 31 | "import numpy as np" 32 | ] 33 | }, 34 | { 35 | "cell_type": "markdown", 36 | "metadata": {}, 37 | "source": [ 38 | "## Creating an array of data" 39 | ] 40 | }, 41 | { 42 | "cell_type": "code", 43 | "execution_count": 2, 44 | "metadata": {}, 45 | "outputs": [], 46 | "source": [ 47 | "np.random.seed(12)\n", 48 | "sales = np.random.randint(30, 90, size=40)" 49 | ] 50 | }, 51 | { 52 | "cell_type": "markdown", 53 | "metadata": {}, 54 | "source": [ 55 | "## Summary statistics" 56 | ] 57 | }, 58 | { 59 | "cell_type": "code", 60 | "execution_count": 3, 61 | "metadata": {}, 62 | "outputs": [ 63 | { 64 | "data": { 65 | "text/plain": [ 66 | "56.1" 67 | ] 68 | }, 69 | "execution_count": 3, 70 | "metadata": {}, 71 | "output_type": "execute_result" 72 | } 73 | ], 74 | "source": [ 75 | "# Mean\n", 76 | "sales.mean()" 77 | ] 78 | }, 79 | { 80 | "cell_type": "code", 81 | "execution_count": 6, 82 | "metadata": {}, 83 | "outputs": [ 84 | { 85 | "data": { 86 | "text/plain": [ 87 | "53.5" 88 | ] 89 | }, 90 | "execution_count": 6, 91 | "metadata": {}, 92 | "output_type": "execute_result" 93 | } 94 | ], 95 | "source": [ 96 | "# Median\n", 97 | "np.median(sales)" 98 | ] 99 | }, 100 | { 101 | "cell_type": "code", 102 | "execution_count": 7, 103 | "metadata": {}, 104 | "outputs": [ 105 | { 106 | "data": { 107 | "text/plain": [ 108 | "303.64" 109 | ] 110 | }, 111 | "execution_count": 7, 112 | "metadata": {}, 113 | "output_type": "execute_result" 114 | } 115 | ], 116 | "source": [ 117 | "# Variance\n", 118 | "sales.var()" 119 | ] 120 | }, 121 | { 122 | "cell_type": "code", 123 | "execution_count": null, 124 | "metadata": {}, 125 | "outputs": [], 126 | "source": [] 127 | } 128 | ], 129 | "metadata": { 130 | "kernelspec": { 131 | "display_name": "Python 3", 132 | "language": "python", 133 | "name": "python3" 134 | }, 135 | "language_info": { 136 | "codemirror_mode": { 137 | "name": "ipython", 138 | "version": 3 139 | }, 140 | "file_extension": ".py", 141 | "mimetype": "text/x-python", 142 | "name": "python", 143 | "nbconvert_exporter": "python", 144 | "pygments_lexer": "ipython3", 145 | "version": "3.7.6" 146 | } 147 | }, 148 | "nbformat": 4, 149 | "nbformat_minor": 2 150 | } 151 | -------------------------------------------------------------------------------- /_includes/head.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {%- include favicons.html -%} 6 | {% seo %} 7 | 8 | 9 | 10 | {%- feed_meta -%} 11 | {%- if jekyll.environment == 'production' and site.google_analytics -%} 12 | {%- include google-analytics.html -%} 13 | {%- endif -%} 14 | 15 | {% if site.use_math %} 16 | 17 | 18 | 19 | 20 | 31 | {% endif %} 32 | 33 | 54 | 55 | 65 | -------------------------------------------------------------------------------- /_includes/social.html: -------------------------------------------------------------------------------- 1 | 14 | -------------------------------------------------------------------------------- /README_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | [//]: # (This template replaces README.md when someone creates a new repo with the fastpages template.) 2 | 3 | ![](https://github.com/{_username_}/{_repo_name_}/workflows/CI/badge.svg) 4 | ![](https://github.com/{_username_}/{_repo_name_}/workflows/GH-Pages%20Status/badge.svg) 5 | [![](https://img.shields.io/static/v1?label=fastai&message=fastpages&color=57aeac&labelColor=black&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAjCAYAAABhCKGoAAAGMklEQVR42q1Xa0xTVxyfKExlui9blszoB12yDzPGzJhtyT5s+zBxUxELBQSHm2ZzU5epBF/LclXae29pCxR5VEGgLQUuIOKDuClhm8oUK7S9ve19tLTl/fA5p9MNc/Y/hRYEzGLxJL/87zk9Ob/zf5++NGHMALzYgdDYmWh0Qly3Lybtwi6lXdpN2cWN5A0+hrQKe5R2PoN2uD+OKcn/UF5ZsVduMmyXVRi+jzebdmI5/juhwrgj3mTI2GA0vvsUIcMwM7GkOD42t7Mf6bqHkFry2yk7X5PXcxMVDN5DGtFf9NkJfe6W5iaUyFShjfV1KPlk7VPAa0k11WjzL+eRvMJ4IKQO0dw8SydJL+Op0u5cn+3tQTn+fqTivTbQpiavF0iG7iGt6NevKjpKpTbUo3hj+QO47XB8hfHfIGAelA+T6mqQzFi+e0oTKm3iexQnXaU56ZrK5SlVsq70LMF7TuX0XNTyvi1rThzLST3TgOCgxwD0DPwDGoE07QkcSl/m5ynbHWmZVm6b0sp9o2DZN8aTZtqk9w9b2G2HLbbvsjlx+fry0vwU0OS5SH68Ylmilny3c3x9SOvpRuQN7hO8vqulZQ6WJMuXFAzcRfkDd5BG8B1bpc+nU0+fQtgkYLIngOEJwGt/J9UxCIJg1whJ05Ul4IMejbsLqUUfOjJKQnCDr4ySHMeO1/UMIa3UmR9TUpj7ZdMFJK8yo6RaZjLAF/JqM/rifCO+yP4AycGmlgUaT9cZ0OYP2um5prjBLhtvLhy68Fs7RFqbRvSlf15ybGdyLcPJmcpfIcIuT4nqqt+Sa2vaZaby1FB+JGi1c9INhuiv9fpIysItIh3CVgVAzXfEE1evzse/bwr8bolcAXs+zcqKXksQc5+FD2D/svT06I8IYtaUeZLZzsVm+3oRDmON1Ok/2NKyIJSs0xnj84RknXG6zgGEE1It+rsPtrYuDOxBKAJLrO1qnW7+OpqeNxF4HWv6v4Rql3uFRvL/DATnc/29x4lmy2t4fXVjY+ASGwylm8DBvkSm2gpgx1Bpg4hyyysqVoUuFRw0z8+jXe40yiFsp1lpC9navlJpE9JIh7RVwfJywmKZO4Hkh02NZ1FilfkJLi1B4GhLPduAZGazHO9LGDX/WAj7+npzwUQqvuOBoo1Va91dj3Tdgyinc0Dae+HyIrxvc2npbCxlxrJvcW3CeSKDMhKCoexRYnUlSqg0xU0iIS5dXwzm6c/x9iKKEx8q2lkV5RARJCcm9We2sgsZhGZmgMYjJOU7UhpOIqhRwwlmEwrBZHgCBRKkKX4ySVvbmzQnXoSDHWCyS6SV20Ha+VaSFTiSE8/ttVheDe4NarLxVB1kdE0fYAgjGaOWGYD1vxKrqmInkSBchRkmiuC4KILhonAo4+9gWVHYnElQMEsAxbRDSHtp7dq5CRWly2VlZe/EFRcvDcBQvBTPZeXly1JMpvlThzBBRASBoDsSBIpgOBQV6C+sUJzffwflQX8BTevCTZMZeoslUo9QJJZYTZDw3RuIKtIhlhXdfhDoJ7TTXY/XdBBpgUshwFMSRYTVwim7FJvt6aFyOnoVKqc7MZQDzzNwsmnd3UegCudl8R2qzHZ7bJbQoYGyn692+zMULCfXenoOacTOTBUnJYRFsq+5+a3sjp5BXM6hEz7ObHNoVEIHyocekiX6WIiykwWDd1HhzT8RzY2YqxnK0HNQBJtW500ddiwrDgdIeCABZ4MPnKQdk9xDhUP3wfHSqbBI9v/e9jo0Iy30cCOgAMyVgMMVCMwql/cQxfKp2R1dWWrRm0PzUkrIXC9ykDY+hnJ5DqkE709guriwSRgGzWTQCPABWJZ6vbNHQlgo099+CCEMPnF6xnwynYETEWd8ls0WPUpSWnTrfuAhAWacPslUiQRNLBGXFSA7TrL8V3gNhesTnLFY0jb+bYWVp0i7SClY184jVtcayi7so2yuA0r4npbjsV8CJHZhPQ7no323cJ5w8FqpLwR/YJNRnHs0hNGs6ZFw/Lpsb+9oj/dZSbuL0XUNojx4d9Gch5mOT0ImINsdKyHzT9Muz1lcXhRWbo9a8J3B72H8Lg6+bKb1hyWMPeERBXMGRxEBCM7Ddfh/1jDuWhb5+QkAAAAASUVORK5CYII=)](https://github.com/fastai/fastpages) 6 | 7 | https://{_username_}.github.io/{_repo_name_}/ 8 | 9 | # My Blog 10 | 11 | 12 | _powered by [fastpages](https://github.com/fastai/fastpages)_ 13 | 14 | 15 | ## What To Do Next? 16 | 17 | Great! You have setup your repo. Now its time to start writing content. Some helpful links: 18 | 19 | - [Writing Blogs With Jupyter](https://github.com/fastai/fastpages#writing-blog-posts-with-jupyter) 20 | 21 | - [Writing Blogs With Markdown](https://github.com/fastai/fastpages#writing-blog-posts-with-markdown) 22 | 23 | - [Writing Blog Posts With Word](https://github.com/fastai/fastpages#writing-blog-posts-with-microsoft-word) 24 | 25 | - [(Optional) Preview Your Blog Locally](DEVELOPMENT.md) 26 | 27 | Note: you may want to remove example blog posts from the `_posts`, `_notebooks` or `_word` folders (but leave them empty, don't delete these folders) if you don't want these blog posts to appear on your site. 28 | 29 | Please use the [nbdev & blogging channel](https://forums.fast.ai/c/fastai-users/nbdev/48) in the fastai forums for any questions or feature requests. 30 | -------------------------------------------------------------------------------- /.github/workflows/setup.yaml: -------------------------------------------------------------------------------- 1 | name: Setup 2 | on: push 3 | 4 | jobs: 5 | setup: 6 | if: (github.event.commits[0].message == 'Initial commit') && (github.run_number == 1) 7 | runs-on: ubuntu-latest 8 | steps: 9 | 10 | - name: Set up Python 11 | uses: actions/setup-python@v1 12 | with: 13 | python-version: 3.6 14 | 15 | - name: Copy Repository Contents 16 | uses: actions/checkout@v2 17 | 18 | - name: modify files 19 | run: | 20 | import re, os 21 | from pathlib import Path 22 | 23 | nwo = os.getenv('GITHUB_REPOSITORY') 24 | username, repo_name = nwo.split('/') 25 | readme_template_path = Path('README_TEMPLATE.md') 26 | readme_path = Path('README.md') 27 | config_path = Path('_config.yml') 28 | pr_msg_path = Path('_setup_pr_template.md') 29 | 30 | assert readme_template_path.exists(), 'Did not find README_TEMPLATE.md in the current directory!' 31 | assert readme_path.exists(), 'Did not find README.md in the current directory!' 32 | assert config_path.exists(), 'Did not find _config.yml in the current directory!' 33 | assert pr_msg_path.exists(), 'Did not find _setup_pr_template.md in the current directory!' 34 | 35 | # replace content of README with template 36 | readme = readme_template_path.read_text().replace('{_username_}', username).replace('{_repo_name_}', repo_name) 37 | readme_path.write_text(readme) 38 | 39 | # update _config.yml 40 | cfg = config_path.read_text() 41 | cfg = re.sub(r'^(github_username: )(fastai)', r'\1{}'.format(username), cfg, flags=re.MULTILINE) 42 | cfg = re.sub(r'^(baseurl: )("")', r'\1"/{}"'.format(repo_name), cfg, flags=re.MULTILINE) 43 | cfg = re.sub(r'^(github_repo: ")(fastpages)', r'\1{}'.format(repo_name), cfg, flags=re.MULTILINE) 44 | cfg = re.sub(r'^(url: "https://)(fastpages.fast.ai)(")', r'\1{}.github.io\3'.format(username), cfg, flags=re.MULTILINE) 45 | config_path.write_text(cfg) 46 | 47 | # prepare the pr message 48 | pr = pr_msg_path.read_text().replace('{_username_}', username).replace('{_repo_name_}', repo_name) 49 | pr_msg_path.write_text(pr) 50 | shell: python 51 | 52 | - name: commit changes 53 | run: | 54 | git config --global user.email "${GH_EMAIL}" 55 | git config --global user.name "${GH_USERNAME}" 56 | git checkout -B fastpages-automated-setup 57 | git rm README_TEMPLATE.md CONTRIBUTING.md CNAME action.yml _checkbox.png 58 | git rm _notebooks/2020-02-21-introducing-fastpages.ipynb 59 | git rm .github/workflows/chatops.yaml 60 | git rm -rf .github/ISSUE_TEMPLATE 61 | git add _config.yml README.md _setup_pr_template.md 62 | git commit -m'setup repo' 63 | git push -f --set-upstream origin fastpages-automated-setup 64 | env: 65 | GH_EMAIL: ${{ github.event.commits[0].author.email }} 66 | GH_USERNAME: ${{ github.event.commits[0].author.username }} 67 | 68 | - name: Open a PR 69 | uses: actions/github-script@0.5.0 70 | with: 71 | github-token: ${{secrets.GITHUB_TOKEN}} 72 | script: | 73 | var fs = require('fs'); 74 | var contents = fs.readFileSync('_setup_pr_template.md', 'utf8'); 75 | github.pulls.create({ 76 | owner: context.repo.owner, 77 | repo: context.repo.repo, 78 | title: 'Initial Setup', 79 | head: 'fastpages-automated-setup', 80 | base: 'master', 81 | body: `${contents}` 82 | }) 83 | -------------------------------------------------------------------------------- /DEVELOPMENT.md: -------------------------------------------------------------------------------- 1 | # Development Guide 2 | - [Seeing All Options From the Terminal](#seeing-all-commands-in-the-terminal) 3 | - [Basic usage: viewing your blog](#basic-usage-viewing-your-blog) 4 | - [Converting the pages locally](#converting-the-pages-locally) 5 | - [Visual Studio Code integration](#visual-studio-code-integration) 6 | - [Advanced usage](#advanced-usage) 7 | - [Rebuild all the containers](#rebuild-all-the-containers) 8 | - [Removing all the containers](#removing-all-the-containers) 9 | - [Attaching a shell to a container](#attaching-a-shell-to-a-container) 10 | 11 | 12 | You can run your fastpages blog on your local machine, and view any changes you make to your posts, including Jupyter Notebooks and Word documents, live. 13 | The live preview requires that you have Docker installed on your machine. [Follow the instructions on this page if you need to install Docker.](https://www.docker.com/products/docker-desktop) 14 | 15 | ## Seeing All Commands In The Terminal 16 | 17 | There are many different `docker-compose` commands that are necessary to manage the lifecycle of the fastpages Docker containers. To make this easier, we aliased common commands in a [Makefile](https://www.gnu.org/software/make/manual/html_node/Introduction.html). 18 | 19 | You can quickly see all available commands by running this command in the root of your repository: 20 | 21 | `make` 22 | 23 | ## Basic usage: viewing your blog 24 | 25 | All of the commands in this block assume that you're in your blog root directory. 26 | To run the blog with live preview: 27 | 28 | ```bash 29 | make server 30 | ``` 31 | 32 | When you run this command for the first time, it'll build the required Docker images, and the process might take a couple minutes. 33 | 34 | This command will build all the necessary containers and run the following services: 35 | 1. A service that monitors any changes in `./_notebooks/*.ipynb/` and `./_word/*.docx;*.doc` and rebuild the blog on change. 36 | 2. A Jupyter Notebook server — use this to write and edit your posts. **You must see your terminal logs to find the link**, which will start with `https://127.0.0.1:8888` 37 | 3. A Jekyll server on https://127.0.0.1:4000 — use this to preview your blog. 38 | 39 | The services will output to your terminal. If you close the terminal or hit `Ctrl-C`, the services will stop. 40 | If you want to run the services in the background: 41 | 42 | ```bash 43 | # run all services in the background 44 | make server-detached 45 | 46 | # stop the services 47 | make stop 48 | ``` 49 | 50 | If you need to restart just the Jekyll server, and it's running in the background — you can do `make restart-jekyll`. 51 | 52 | _Note that the blog won't autoreload on change, you'll have to refresh your browser manually._ 53 | 54 | **If containers won't start**: try `make build` first, this would rebuild all the containers from scratch, This might fix the majority of update problems. 55 | 56 | **To get the Jupyter Notebook Token**: look for the Jupyter Notebook link in the output log of `make server` command, it'll post the link with the token param in it. If you're running containers in background, you can get the token by running the following command: 57 | 58 | ```bash 59 | # assuming you're running containers in background with docker-compose up -d 60 | # attach to bash in jupyter container 61 | make bash-nb 62 | 63 | # get notebook list & token 64 | jupyter notebook list 65 | ``` 66 | 67 | ## Converting the pages locally 68 | 69 | If you just want to convert your notebooks and word documents to `.md` posts in `_posts`, this command will do it for you: 70 | 71 | ```bash 72 | make convert 73 | ``` 74 | 75 | You can launch just the jekyll server with `make server`. 76 | 77 | ## Visual Studio Code integration 78 | 79 | If you're using VSCode with the Docker extension, you can run three containers from the sidebar: `fastpages_jupyter_1`,`fastpages_watcher_1`, and `fastpages_jekyll_1`. 80 | The containers will only show up in the list after you run or build them for the first time. So if they're not in the list — try `make build` in the console. 81 | 82 | ## Advanced usage 83 | 84 | ### Rebuild all the containers 85 | If you changed files in `_action_files` directory, you might need to rebuild the containers manually, without cache. 86 | 87 | ```bash 88 | make build 89 | ``` 90 | 91 | ### Removing all the containers 92 | Want to start from scratch and remove all the containers? 93 | 94 | ``` 95 | make remove 96 | ``` 97 | 98 | ### Attaching a shell to a container 99 | You can attach a terminal to a running service: 100 | 101 | ```bash 102 | 103 | # If the container is already running: 104 | 105 | # attach to a bash shell in the jekyll service 106 | make bash-jekyll 107 | 108 | # attach to a bash shell in the jupyter / watcher service. 109 | # they're essentially running the same software inside. 110 | make bash-nb 111 | ``` 112 | 113 | _Note: you can use `docker-compose run` instead of `make bash-nb` or `make bash-jekyll` to start a service and then attach to it. 114 | Or you can run all your services in the background, `make server-detached`, and then use `make bash-nb` or `make bash-jekyll` as in the examples above._ 115 | 116 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | _Adapted from [fastai/nbdev/CONTRIBUTING.md](https://github.com/fastai/nbdev/blob/master/CONTRIBUTING.md)_ 2 | 3 | # How to contribute to fastpages 4 | 5 | First, thanks a lot for wanting to help! Some things to keep in mind: 6 | 7 | - The jupyter to blog post conversion functionality relies on [fastai/nbdev](https://github.com/fastai/nbdev). For idiosyncratic uses of nbdev that only apply to blogs that would require a large refactor to nbdev, it might be acceptable to apply a [monkey patch](https://stackoverflow.com/questions/5626193/what-is-monkey-patching) in `fastpages`. However, it is encouraged to contribute to `nbdev` where possible if there is a change that could unlock a new feature. If you are unsure, please open an issue in this repo to discucss. 8 | 9 | 10 | ## Note for new contributors from Jeremy 11 | 12 | It can be tempting to jump into a new project by questioning the stylistic decisions that have been made, such as naming, formatting, and so forth. This can be especially so for python programmers contributing to this project, which is unusual in following a number of conventions that are common in other programming communities, but not in Python. However, please don’t do this, for (amongst others) the following reasons: 13 | 14 | - Contributing to [Parkinson’s law of triviality](https://www.wikiwand.com/en/Law_of_triviality) has negative consequences for a project. Let’s focus on deep learning! 15 | - It’s exhausting to repeat the same discussion over and over again, especially when it’s been well documented already. When you have a question about the project, please check the pages in the docs website linked here. 16 | - You’re likely to get a warmer welcome from the community if you start out by contributing something that’s been requested on the forum, since you’ll be solving someone’s current problem. 17 | - If you start out by just telling us your point of view, rather than studying the background behind the decisions that have been made, you’re unlikely to be contributing anything new or useful. 18 | - I’ve been writing code for nearly 40 years now, across dozens of languages, and other folks involved have quite a bit of experience too - the approaches used are based on significant experience and research. Whilst there’s always room for improvement, it’s much more likely you’ll be making a positive contribution if you spend a few weeks studying and working within the current framework before suggesting wholesale changes. 19 | 20 | 21 | ## Did you find a bug? 22 | 23 | * Nobody is perfect, especially not us. But first, please double-check the bug doesn't come from something on your side. The [forum](http://forums.fast.ai/) is a tremendous source for help, and we'd advise to use it as a first step. Be sure to include as much code as you can so that other people can easily help you. 24 | * Then, ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/fastai/fastpages/issues). 25 | * If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/fastai/fastpages/issues/new). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. 26 | * Be sure to add the complete error messages. 27 | 28 | #### Did you write a patch that fixes a bug? 29 | 30 | * Open a new GitHub pull request with the patch. 31 | * Ensure that your PR includes a test that fails without your patch, and pass with it. 32 | * Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. 33 | * Before submitting, please be sure you abide by our [coding style](https://docs.fast.ai/dev/style.html) (where appropriate) and [the guide on abbreviations](https://docs.fast.ai/dev/abbr.html) and clean-up your code accordingly. 34 | 35 | ## Do you intend to add a new feature or change an existing one? 36 | 37 | * You can suggest your change on the [fastai forum](http://forums.fast.ai/) to see if others are interested or want to help. 38 | * Once your approach has been discussed and confirmed on the forum, you are welcome to push a PR, including a complete description of the new feature and an example of how it's used. Be sure to document your code in the notabook. 39 | * Ensure that your code includes tests that exercise not only your feature, but also any other code that might be impacted. 40 | 41 | ## PR submission guidelines 42 | 43 | Some general rules of thumb that will make your life easier. 44 | 45 | * Test locally before opening a pull request. See [the development guide](DEVELOPMENT.md) for instructions on how to run fastpages on your local machine. 46 | * When you do open a pull request, please request a draft build of your PR by making a **comment with the magic command `/preview` in the pull request.** This will allow reviewers to see a live-preview of your changes without having to clone your branch. 47 | * You can do this multiple times, if necessary, to rebuild your preview due to changes. But please do not abuse this and test locally before doing this. 48 | 49 | * Keep each PR focused. While it's more convenient, do not combine several unrelated fixes together. Create as many branches as needing to keep each PR focused. 50 | * Do not mix style changes/fixes with "functional" changes. It's very difficult to review such PRs and it most likely get rejected. 51 | * Do not add/remove vertical whitespace. Preserve the original style of the file you edit as much as you can. 52 | * Do not turn an already submitted PR into your development playground. If after you submitted PR, you discovered that more work is needed - close the PR, do the required work and then submit a new PR. Otherwise each of your commits requires attention from maintainers of the project. 53 | * If, however, you submitted a PR and received a request for changes, you should proceed with commits inside that PR, so that the maintainer can see the incremental fixes and won't need to review the whole PR again. In the exception case where you realize it'll take many many commits to complete the requests, then it's probably best to close the PR, do the work and then submit it again. Use common sense where you'd choose one way over another. 54 | * When you open a pull request, you can generate a live preview build of how the blog site will look by making a comment in the PR that contains this command: `/preview`. GitHub will build your site and drop a temporary link for everyone to review. You can do this as multiple times if necessary, however as mentioned previously do not turn an already submitted PR inot a development playground. 55 | 56 | ## Do you have questions about the source code? 57 | 58 | * Please ask it on the [fastai forum](http://forums.fast.ai/) (after searching someone didn't ask the same one before with a quick search). We'd rather have the maximum of discussions there so that the largest number can benefit from it. 59 | 60 | ## Do you want to contribute to the documentation? 61 | 62 | * PRs are welcome for this. For any confusion about the documentation, please feel free to open an issue on this repo. 63 | 64 | -------------------------------------------------------------------------------- /assets/main.scss: -------------------------------------------------------------------------------- 1 | --- 2 | # Only the main Sass file needs front matter (the dashes are enough) 3 | --- 4 | 5 | @import "{{ site.theme }}"; 6 | 7 | .post img { 8 | display: block; 9 | // border:1px solid #021a40; 10 | vertical-align: top; 11 | margin-left: auto; 12 | margin-right: auto; 13 | } 14 | 15 | .post figcaption { 16 | text-align: center; 17 | font-size: .8rem; 18 | font-style: italic; 19 | color: light-grey; 20 | } 21 | 22 | .language-python + .language-plaintext { 23 | border-left: 1px solid grey; 24 | margin-left: 1rem !important; 25 | } 26 | 27 | // ensure dark background for code 28 | [class^="language-"]:not(.language-plaintext) pre, 29 | [class^="language-"]:not(.language-plaintext) code 30 | { 31 | background-color: #323443 !important; 32 | } 33 | 34 | .language-python + .language-plaintext code { background-color: white !important; } 35 | .language-python + .language-plaintext pre { background-color: white !important; } 36 | 37 | // for Jupyter Notebook HTML Code Cells modified from https://www.fast.ai/public/css/hyde.css 38 | 39 | .input_area pre, .input_area div { 40 | margin-bottom:2rem !important; 41 | margin-top:1.5rem !important; 42 | padding-bottom:0 !important; 43 | padding-top:0 !important; 44 | background: #323443 !important; 45 | -webkit-font-smoothing: antialiased; 46 | text-rendering: optimizeLegibility; 47 | font-family: Menlo, Monaco, Consolas, "Lucida Console", Roboto, Ubuntu, monospace; 48 | border-radius: 5px; 49 | } 50 | .output_area pre, .output_area div { 51 | margin-bottom:0.1rem !important; 52 | margin-top:0.1rem !important; 53 | padding-bottom:0 !important; 54 | padding-top:0 !important; 55 | } 56 | .input_area pre { 57 | border-left: 1px solid lightcoral; 58 | } 59 | .output_area pre { 60 | border-left: 1px solid grey; 61 | margin-left: 1rem !important; 62 | } 63 | 64 | .code_cell table { width: auto; } 65 | 66 | .page-content { 67 | -webkit-font-smoothing: antialiased !important; 68 | text-rendering: optimizeLegibility !important; 69 | font-family: "Segoe UI", SegoeUI, "Segoe WP", "Helvetica Neue", "Helvetica", "Tahoma", "Arial", sans-serif; 70 | } 71 | 72 | // make non-headings slightly lighter 73 | .post-content p, .post-content li { 74 | font-size: 20px; 75 | color: #515151; 76 | } 77 | 78 | // change padding of headings 79 | h1 { 80 | margin-top:2.5rem !important; 81 | } 82 | 83 | h2 { 84 | margin-top:2rem !important; 85 | } 86 | 87 | h3, h4 { 88 | margin-top:1.5rem !important; 89 | } 90 | 91 | // make sure the post title doesn't have too much spacing 92 | .post-title { margin-top: .5rem !important; } 93 | 94 | li { 95 | h3, h4 { 96 | margin-top:.05rem !important; 97 | margin-bottom:.05rem !important; 98 | } 99 | .post-meta-description { 100 | color: rgb(88, 88, 88); 101 | font-size: 15px; 102 | margin-bottom:.05rem !important; 103 | } 104 | } 105 | 106 | /* Dracula Theme v1.2.5 107 | * 108 | * https://github.com/zenorocha/dracula-theme 109 | * 110 | * Copyright 2016, All rights reserved 111 | * 112 | * Code licensed under the MIT license 113 | * 114 | */ 115 | 116 | /* 117 | * Variables 118 | */ 119 | 120 | $dt-gray-dark: #282a36; // Background 121 | $dt-gray: #44475a; // Current Line & Selection 122 | $dt-gray-light: #f8f8f2; // Foreground 123 | $dt-blue: #6272a4; // Comment 124 | $dt-cyan: #8be9fd; 125 | $dt-green: #50fa7b; 126 | $dt-orange: #ffb86c; 127 | $dt-pink: #ff79c6; 128 | $dt-purple: #bd93f9; 129 | $dt-red: #ff5555; 130 | $dt-yellow: #f1fa8c; 131 | $dt-green-light: rgb(172, 229, 145); 132 | 133 | /* 134 | * Styles 135 | */ 136 | 137 | .highlight { 138 | // background: $dt-gray-dark; 139 | // color: $dt-gray-light; 140 | 141 | .hll, 142 | .s, 143 | .sa, 144 | .sb, 145 | .sc, 146 | .dl, 147 | .sd, 148 | .s2, 149 | .se, 150 | .sh, 151 | .si, 152 | .sx, 153 | .sr, 154 | .s1, 155 | .ss { 156 | color:rgb(231, 153, 122); 157 | } 158 | 159 | .go { 160 | color: $dt-gray; 161 | } 162 | 163 | .err, 164 | .g, 165 | .l, 166 | .n, 167 | .x, 168 | .ge, 169 | .gr, 170 | .gh, 171 | .gi, 172 | .gp, 173 | .gs, 174 | .gu, 175 | .gt, 176 | .ld, 177 | .no, 178 | .nd, 179 | .pi, 180 | .ni, 181 | .ne, 182 | .nn, 183 | .nx, 184 | .py, 185 | .w, 186 | .bp { 187 | color: $dt-gray-light; 188 | } 189 | 190 | .p { 191 | font-weight: bold; 192 | color: rgb(102, 217, 239); 193 | } 194 | 195 | // .gh, 196 | // .gi, 197 | // .gu { 198 | // font-weight: bold; 199 | // } 200 | 201 | .ge { 202 | text-decoration: underline; 203 | } 204 | 205 | .bp { 206 | font-style: italic; 207 | } 208 | 209 | .c, 210 | .ch, 211 | .cm, 212 | .cpf, 213 | .c1, 214 | .cs { 215 | color: $dt-blue; 216 | } 217 | 218 | .kd, 219 | .kt, 220 | .nb, 221 | .nl, 222 | .nv, 223 | .vc, 224 | .vg, 225 | .vi, 226 | .vm { 227 | color: $dt-cyan; 228 | } 229 | 230 | .kd, 231 | .nb, 232 | .nl, 233 | .nv, 234 | .vc, 235 | .vg, 236 | .vi, 237 | .vm { 238 | font-style: italic; 239 | } 240 | 241 | .fm, 242 | .na, 243 | .nc, 244 | .nf 245 | { 246 | color: $dt-green-light; 247 | } 248 | 249 | .k, 250 | .o, 251 | .cp, 252 | .kc, 253 | .kn, 254 | .kp, 255 | .kr, 256 | .nt, 257 | .ow { 258 | color: $dt-pink; 259 | } 260 | 261 | .kc { 262 | color: $dt-green-light; 263 | } 264 | 265 | .m, 266 | .mb, 267 | .mf, 268 | .mh, 269 | .mi, 270 | .mo, 271 | .il { 272 | color: $dt-purple; 273 | } 274 | 275 | .gd { 276 | color: $dt-red; 277 | } 278 | } 279 | 280 | // Code Folding 281 | 282 | details.description[open] summary::after { 283 | content: attr(data-open); 284 | } 285 | 286 | details.description:not([open]) summary::after { 287 | content: attr(data-close); 288 | } 289 | 290 | .notebook-badge-image { 291 | border:0 !important; 292 | } 293 | 294 | .footnotes { 295 | font-size: 12px !important; 296 | p{ 297 | font-size: 12px !important; 298 | } 299 | } 300 | 301 | .social.svg-icon { 302 | width: 21px !important; 303 | } 304 | 305 | .anchor-link { 306 | opacity: 0; 307 | padding-left: 0.375em; 308 | \-webkit-text-stroke: 1.75px white; 309 | \-webkit-transition: opacity 0.2s ease-in-out 0.1s; 310 | \-moz-transition: opacity 0.2s ease-in-out 0.1s; 311 | \-ms-transition: opacity 0.2s ease-in-out 0.1s; 312 | } 313 | 314 | h1:hover .anchor-link, 315 | h2:hover .anchor-link, 316 | h3:hover .anchor-link, 317 | h4:hover .anchor-link, 318 | h5:hover .anchor-link, 319 | h6:hover .anchor-link { 320 | opacity: 1; 321 | } 322 | 323 | .page-description { 324 | color: #585858; 325 | font-size: 110%; 326 | } 327 | 328 | // category tags 329 | .category-tags { 330 | margin-top: .25rem !important; 331 | margin-bottom: .25rem !important; 332 | } 333 | 334 | .post-meta-title{ 335 | margin-top: .25em; 336 | margin-bottom: .25em; 337 | } 338 | 339 | .category-tags-icon { 340 | font-size: 75% !important; 341 | padding-left: 0.375em; 342 | opacity: 35%; 343 | } 344 | .category-tags-link { 345 | color:rgb(187, 129, 129) !important; 346 | font-size: 13px !important; 347 | } 348 | 349 | // lunr search styles 350 | #lunrsearchresults {padding-top: 0.2rem;} 351 | .lunrsearchresult {padding-bottom: 1rem;} 352 | .lunrsearchresult .title {color: #d9230f;} 353 | .lunrsearchresult .url {color: silver;} 354 | .lunrsearchresult a {display: block; color: #777;} 355 | .lunrsearchresult a:hover, .lunrsearchresult a:focus {text-decoration: none;} 356 | .lunrsearchresult a:hover .title {text-decoration: underline;} 357 | -------------------------------------------------------------------------------- /.github/workflows/chatops.yaml: -------------------------------------------------------------------------------- 1 | name: Chatops 2 | on: [issue_comment] 3 | 4 | jobs: 5 | trigger-chatops: 6 | if: github.event.issue.pull_request != null && contains(github.event.comment.body, '/preview') 7 | env: 8 | NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} 9 | NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} 10 | CHECK_RUN_NAME: "Draft-Site-Build" 11 | runs-on: ubuntu-latest 12 | steps: 13 | 14 | - name: see payload 15 | run: | 16 | echo "FULL PAYLOAD:\n${PAYLOAD}\n" 17 | echo "PR_PAYLOAD PAYLOAD:\n${PR_PAYLOAD}" 18 | env: 19 | PAYLOAD: ${{ toJSON(github.event) }} 20 | PR_PAYLOAD: ${{ github.event.pull_request }} 21 | 22 | - name: verify env exists 23 | id: get_status 24 | run: | 25 | if [ -z ${NETLIFY_AUTH_TOKEN} ]; then echo "::set-output name=status::public"; else echo "::set-output name=status::private"; fi 26 | 27 | - name: make comment on PR if env does not exist 28 | if: steps.get_status.outputs.status == 'public' 29 | run: | 30 | ./_action_files/pr_comment.sh "Was not able to generate site preview due to absent credentials." 31 | env: 32 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 33 | ISSUE_NUMBER: ${{ github.event.issue.number }} 34 | 35 | - name: Fetch context about the PR that has been commented on 36 | id: chatops 37 | uses: machine-learning-apps/actions-chatops@master 38 | with: 39 | TRIGGER_PHRASE: "/preview" 40 | env: # you must supply GITHUB_TOKEN 41 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 42 | 43 | - name: Set up Python 44 | uses: actions/setup-python@v1 45 | with: 46 | python-version: 3.6 47 | 48 | - name: install requests 49 | run: pip3 install requests 50 | 51 | - name: add check run 52 | id: create_check 53 | if: steps.get_status.outputs.status == 'private' 54 | shell: python 55 | run: | 56 | import os, requests 57 | 58 | sha = os.getenv('SHA') 59 | token = os.getenv('GITHUB_TOKEN') 60 | nwo = os.getenv('GITHUB_REPOSITORY') 61 | name = os.getenv('CHECK_RUN_NAME') 62 | 63 | url = f'https://api.github.com/repos/{nwo}/check-runs' 64 | 65 | headers = {'authorization': f'token {token}', 66 | 'accept': 'application/vnd.github.antiope-preview+json'} 67 | 68 | payload = { 69 | 'name': f'{name}', 70 | 'head_sha': f'{sha}', 71 | 'status': 'in_progress', 72 | 'output':{ 73 | 'title': f'Building preview of site for {sha}.', 74 | 'summary': ' ', 75 | 'text': ' ' 76 | }, 77 | } 78 | response = requests.post(url=url, headers=headers, json=payload) 79 | print(response) 80 | id = response.json()['id'] 81 | print(f"::set-output name=id::{id}") 82 | env: 83 | SHA: ${{ steps.chatops.outputs.SHA }} 84 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 85 | 86 | - name: add label 87 | if: steps.get_status.outputs.status == 'private' 88 | run: | 89 | import os, requests 90 | nwo = os.getenv('GITHUB_REPOSITORY') 91 | token = os.getenv('GITHUB_TOKEN') 92 | pr_num = os.getenv('PR_NUM') 93 | headers = {'Accept': 'application/vnd.github.symmetra-preview+json', 94 | 'Authorization': f'token {token}'} 95 | url = f"https://api.github.com/repos/{nwo}/issues/{pr_num}/labels" 96 | data = {"labels": ["draft build pending"]} 97 | result = requests.post(url=url, headers=headers, json=data) 98 | # assert response.status_code == 201, f"Received status code of {response.status_code}" 99 | print(result) 100 | shell: python 101 | env: 102 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 103 | PR_NUM: ${{ steps.chatops.outputs.PULL_REQUEST_NUMBER }} 104 | GITHUB_REPOSITORY: $GITHUB_REPOSITORY 105 | 106 | - name: Copy The PR's Branch Repository Contents 107 | uses: actions/checkout@master 108 | if: steps.get_status.outputs.status == 'private' 109 | with: 110 | ref: ${{ steps.chatops.outputs.SHA }} 111 | 112 | - name: convert notebooks and word docs to posts 113 | uses: ./ # use the code in this repo to instead of fastai/fastpages@master 114 | 115 | - name: setup directories for Jekyll build 116 | if: steps.get_status.outputs.status == 'private' 117 | run: | 118 | rm -rf _site 119 | sudo chmod -R 777 . 120 | 121 | - name: Jekyll build with baseurl as root for netifly 122 | if: steps.get_status.outputs.status == 'private' 123 | uses: docker://jekyll/jekyll 124 | with: 125 | args: jekyll build --baseurl / 126 | 127 | - name: deploy to netlify 128 | if: steps.get_status.outputs.status == 'private' 129 | id: py 130 | run: | 131 | sudo npm install netlify-cli -g 132 | netlify deploy --dir _site | tee _netlify_logs.txt 133 | cat _netlify_logs.txt | python _action_files/parse_netlify.py 134 | 135 | - name: make comment on PR 136 | if: steps.get_status.outputs.status == 'private' 137 | run: | 138 | MSG="A preview build of this branch has been generated for SHA: $SHA and can be viewed **live** at: ${URL}\n\nThe current fastpages site built from master can be viewed for comparison [here](https://fastpages.fast.ai/)" 139 | echo "$MSG" 140 | ./_action_files/pr_comment.sh "${MSG}" 141 | env: 142 | URL: ${{ steps.py.outputs.draft_url }} 143 | SHA: ${{ steps.chatops.outputs.SHA }} 144 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 145 | ISSUE_NUMBER: ${{ github.event.issue.number }} 146 | 147 | - name: remove label 148 | if: always() 149 | run: | 150 | import os, requests 151 | nwo = os.getenv('GITHUB_REPOSITORY') 152 | token = os.getenv('GITHUB_TOKEN') 153 | pr_num = os.getenv('PR_NUM') 154 | headers = {'Accept': 'application/vnd.github.symmetra-preview+json', 155 | 'Authorization': f'token {token}'} 156 | url = f"https://api.github.com/repos/{nwo}/issues/{pr_num}/labels/draft%20build%20pending" 157 | result = requests.delete(url=url, headers=headers) 158 | print(result) 159 | shell: python 160 | env: 161 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 162 | PR_NUM: ${{ steps.chatops.outputs.PULL_REQUEST_NUMBER }} 163 | GITHUB_REPOSITORY: $GITHUB_REPOSITORY 164 | 165 | # defensively clear check run each time 166 | - name: clear check run 167 | if: always() 168 | continue-on-error: true 169 | shell: python 170 | run: | 171 | import os, requests 172 | 173 | sha = os.getenv('SHA') 174 | conclusion = os.getenv('WORKFLOW_CONCLUSION').lower() 175 | token = os.getenv('GITHUB_TOKEN') 176 | nwo = os.getenv('GITHUB_REPOSITORY') 177 | check_run_id = os.getenv('CHECK_RUN_ID') 178 | if not check_run_id: 179 | quit() 180 | 181 | url = f'https://api.github.com/repos/{nwo}/check-runs/{check_run_id}' 182 | headers = {'authorization': f'token {token}', 183 | 'accept': 'application/vnd.github.antiope-preview+json'} 184 | 185 | data = { 186 | 'conclusion': f'{conclusion}', 187 | } 188 | response = requests.patch(url=url, headers=headers, json=data) 189 | print(response) 190 | env: 191 | SHA: ${{ steps.chatops.outputs.SHA }} 192 | WORKFLOW_CONCLUSION: ${{ job.status }} 193 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 194 | CHECK_RUN_ID: ${{ steps.create_check.outputs.id }} 195 | 196 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | activesupport (6.0.2.1) 5 | concurrent-ruby (~> 1.0, >= 1.0.2) 6 | i18n (>= 0.7, < 2) 7 | minitest (~> 5.1) 8 | tzinfo (~> 1.1) 9 | zeitwerk (~> 2.2) 10 | addressable (2.7.0) 11 | public_suffix (>= 2.0.2, < 5.0) 12 | coffee-script (2.4.1) 13 | coffee-script-source 14 | execjs 15 | coffee-script-source (1.11.1) 16 | colorator (1.1.0) 17 | commonmarker (0.17.13) 18 | ruby-enum (~> 0.5) 19 | concurrent-ruby (1.1.5) 20 | dnsruby (1.61.3) 21 | addressable (~> 2.5) 22 | em-websocket (0.5.1) 23 | eventmachine (>= 0.12.9) 24 | http_parser.rb (~> 0.6.0) 25 | ethon (0.12.0) 26 | ffi (>= 1.3.0) 27 | eventmachine (1.2.7) 28 | execjs (2.7.0) 29 | faraday (0.17.3) 30 | multipart-post (>= 1.2, < 3) 31 | ffi (1.12.2) 32 | forwardable-extended (2.6.0) 33 | gemoji (3.0.1) 34 | github-pages (204) 35 | github-pages-health-check (= 1.16.1) 36 | jekyll (= 3.8.5) 37 | jekyll-avatar (= 0.7.0) 38 | jekyll-coffeescript (= 1.1.1) 39 | jekyll-commonmark-ghpages (= 0.1.6) 40 | jekyll-default-layout (= 0.1.4) 41 | jekyll-feed (= 0.13.0) 42 | jekyll-gist (= 1.5.0) 43 | jekyll-github-metadata (= 2.13.0) 44 | jekyll-mentions (= 1.5.1) 45 | jekyll-optional-front-matter (= 0.3.2) 46 | jekyll-paginate (= 1.1.0) 47 | jekyll-readme-index (= 0.3.0) 48 | jekyll-redirect-from (= 0.15.0) 49 | jekyll-relative-links (= 0.6.1) 50 | jekyll-remote-theme (= 0.4.1) 51 | jekyll-sass-converter (= 1.5.2) 52 | jekyll-seo-tag (= 2.6.1) 53 | jekyll-sitemap (= 1.4.0) 54 | jekyll-swiss (= 1.0.0) 55 | jekyll-theme-architect (= 0.1.1) 56 | jekyll-theme-cayman (= 0.1.1) 57 | jekyll-theme-dinky (= 0.1.1) 58 | jekyll-theme-hacker (= 0.1.1) 59 | jekyll-theme-leap-day (= 0.1.1) 60 | jekyll-theme-merlot (= 0.1.1) 61 | jekyll-theme-midnight (= 0.1.1) 62 | jekyll-theme-minimal (= 0.1.1) 63 | jekyll-theme-modernist (= 0.1.1) 64 | jekyll-theme-primer (= 0.5.4) 65 | jekyll-theme-slate (= 0.1.1) 66 | jekyll-theme-tactile (= 0.1.1) 67 | jekyll-theme-time-machine (= 0.1.1) 68 | jekyll-titles-from-headings (= 0.5.3) 69 | jemoji (= 0.11.1) 70 | kramdown (= 1.17.0) 71 | liquid (= 4.0.3) 72 | mercenary (~> 0.3) 73 | minima (= 2.5.1) 74 | nokogiri (>= 1.10.4, < 2.0) 75 | rouge (= 3.13.0) 76 | terminal-table (~> 1.4) 77 | github-pages-health-check (1.16.1) 78 | addressable (~> 2.3) 79 | dnsruby (~> 1.60) 80 | octokit (~> 4.0) 81 | public_suffix (~> 3.0) 82 | typhoeus (~> 1.3) 83 | html-pipeline (2.12.3) 84 | activesupport (>= 2) 85 | nokogiri (>= 1.4) 86 | http_parser.rb (0.6.0) 87 | i18n (0.9.5) 88 | concurrent-ruby (~> 1.0) 89 | jekyll (3.8.5) 90 | addressable (~> 2.4) 91 | colorator (~> 1.0) 92 | em-websocket (~> 0.5) 93 | i18n (~> 0.7) 94 | jekyll-sass-converter (~> 1.0) 95 | jekyll-watch (~> 2.0) 96 | kramdown (~> 1.14) 97 | liquid (~> 4.0) 98 | mercenary (~> 0.3.3) 99 | pathutil (~> 0.9) 100 | rouge (>= 1.7, < 4) 101 | safe_yaml (~> 1.0) 102 | jekyll-avatar (0.7.0) 103 | jekyll (>= 3.0, < 5.0) 104 | jekyll-coffeescript (1.1.1) 105 | coffee-script (~> 2.2) 106 | coffee-script-source (~> 1.11.1) 107 | jekyll-commonmark (1.3.1) 108 | commonmarker (~> 0.14) 109 | jekyll (>= 3.7, < 5.0) 110 | jekyll-commonmark-ghpages (0.1.6) 111 | commonmarker (~> 0.17.6) 112 | jekyll-commonmark (~> 1.2) 113 | rouge (>= 2.0, < 4.0) 114 | jekyll-default-layout (0.1.4) 115 | jekyll (~> 3.0) 116 | jekyll-feed (0.13.0) 117 | jekyll (>= 3.7, < 5.0) 118 | jekyll-gist (1.5.0) 119 | octokit (~> 4.2) 120 | jekyll-github-metadata (2.13.0) 121 | jekyll (>= 3.4, < 5.0) 122 | octokit (~> 4.0, != 4.4.0) 123 | jekyll-mentions (1.5.1) 124 | html-pipeline (~> 2.3) 125 | jekyll (>= 3.7, < 5.0) 126 | jekyll-octicons (9.4.0) 127 | jekyll (>= 3.6, < 5.0) 128 | octicons (= 9.4.0) 129 | jekyll-optional-front-matter (0.3.2) 130 | jekyll (>= 3.0, < 5.0) 131 | jekyll-paginate (1.1.0) 132 | jekyll-readme-index (0.3.0) 133 | jekyll (>= 3.0, < 5.0) 134 | jekyll-redirect-from (0.15.0) 135 | jekyll (>= 3.3, < 5.0) 136 | jekyll-relative-links (0.6.1) 137 | jekyll (>= 3.3, < 5.0) 138 | jekyll-remote-theme (0.4.1) 139 | addressable (~> 2.0) 140 | jekyll (>= 3.5, < 5.0) 141 | rubyzip (>= 1.3.0) 142 | jekyll-sass-converter (1.5.2) 143 | sass (~> 3.4) 144 | jekyll-seo-tag (2.6.1) 145 | jekyll (>= 3.3, < 5.0) 146 | jekyll-sitemap (1.4.0) 147 | jekyll (>= 3.7, < 5.0) 148 | jekyll-swiss (1.0.0) 149 | jekyll-theme-architect (0.1.1) 150 | jekyll (~> 3.5) 151 | jekyll-seo-tag (~> 2.0) 152 | jekyll-theme-cayman (0.1.1) 153 | jekyll (~> 3.5) 154 | jekyll-seo-tag (~> 2.0) 155 | jekyll-theme-dinky (0.1.1) 156 | jekyll (~> 3.5) 157 | jekyll-seo-tag (~> 2.0) 158 | jekyll-theme-hacker (0.1.1) 159 | jekyll (~> 3.5) 160 | jekyll-seo-tag (~> 2.0) 161 | jekyll-theme-leap-day (0.1.1) 162 | jekyll (~> 3.5) 163 | jekyll-seo-tag (~> 2.0) 164 | jekyll-theme-merlot (0.1.1) 165 | jekyll (~> 3.5) 166 | jekyll-seo-tag (~> 2.0) 167 | jekyll-theme-midnight (0.1.1) 168 | jekyll (~> 3.5) 169 | jekyll-seo-tag (~> 2.0) 170 | jekyll-theme-minimal (0.1.1) 171 | jekyll (~> 3.5) 172 | jekyll-seo-tag (~> 2.0) 173 | jekyll-theme-modernist (0.1.1) 174 | jekyll (~> 3.5) 175 | jekyll-seo-tag (~> 2.0) 176 | jekyll-theme-primer (0.5.4) 177 | jekyll (> 3.5, < 5.0) 178 | jekyll-github-metadata (~> 2.9) 179 | jekyll-seo-tag (~> 2.0) 180 | jekyll-theme-slate (0.1.1) 181 | jekyll (~> 3.5) 182 | jekyll-seo-tag (~> 2.0) 183 | jekyll-theme-tactile (0.1.1) 184 | jekyll (~> 3.5) 185 | jekyll-seo-tag (~> 2.0) 186 | jekyll-theme-time-machine (0.1.1) 187 | jekyll (~> 3.5) 188 | jekyll-seo-tag (~> 2.0) 189 | jekyll-titles-from-headings (0.5.3) 190 | jekyll (>= 3.3, < 5.0) 191 | jekyll-toc (0.13.1) 192 | jekyll (>= 3.7) 193 | nokogiri (~> 1.9) 194 | jekyll-twitter-plugin (2.1.0) 195 | jekyll-watch (2.2.1) 196 | listen (~> 3.0) 197 | jemoji (0.11.1) 198 | gemoji (~> 3.0) 199 | html-pipeline (~> 2.2) 200 | jekyll (>= 3.0, < 5.0) 201 | kramdown (1.17.0) 202 | liquid (4.0.3) 203 | listen (3.2.1) 204 | rb-fsevent (~> 0.10, >= 0.10.3) 205 | rb-inotify (~> 0.9, >= 0.9.10) 206 | mercenary (0.3.6) 207 | mini_portile2 (2.4.0) 208 | minima (2.5.1) 209 | jekyll (>= 3.5, < 5.0) 210 | jekyll-feed (~> 0.9) 211 | jekyll-seo-tag (~> 2.1) 212 | minitest (5.14.0) 213 | multipart-post (2.1.1) 214 | nokogiri (1.10.8) 215 | mini_portile2 (~> 2.4.0) 216 | octicons (9.4.0) 217 | nokogiri (>= 1.6.3.1) 218 | octokit (4.16.0) 219 | faraday (>= 0.9) 220 | sawyer (~> 0.8.0, >= 0.5.3) 221 | pathutil (0.16.2) 222 | forwardable-extended (~> 2.6) 223 | public_suffix (3.1.1) 224 | rb-fsevent (0.10.3) 225 | rb-inotify (0.10.1) 226 | ffi (~> 1.0) 227 | rouge (3.13.0) 228 | ruby-enum (0.7.2) 229 | i18n 230 | rubyzip (2.2.0) 231 | safe_yaml (1.0.5) 232 | sass (3.7.4) 233 | sass-listen (~> 4.0.0) 234 | sass-listen (4.0.0) 235 | rb-fsevent (~> 0.9, >= 0.9.4) 236 | rb-inotify (~> 0.9, >= 0.9.7) 237 | sawyer (0.8.2) 238 | addressable (>= 2.3.5) 239 | faraday (> 0.8, < 2.0) 240 | terminal-table (1.8.0) 241 | unicode-display_width (~> 1.1, >= 1.1.1) 242 | thread_safe (0.3.6) 243 | typhoeus (1.3.1) 244 | ethon (>= 0.9.0) 245 | tzinfo (1.2.6) 246 | thread_safe (~> 0.1) 247 | tzinfo-data (1.2019.3) 248 | tzinfo (>= 1.0.0) 249 | unicode-display_width (1.6.1) 250 | wdm (0.1.1) 251 | zeitwerk (2.2.2) 252 | 253 | PLATFORMS 254 | ruby 255 | 256 | DEPENDENCIES 257 | faraday (< 1.0) 258 | github-pages 259 | jekyll-feed (~> 0.12) 260 | jekyll-github-metadata 261 | jekyll-octicons 262 | jekyll-relative-links 263 | jekyll-seo-tag 264 | jekyll-toc 265 | jekyll-twitter-plugin 266 | minima (~> 2.5) 267 | tzinfo (~> 1.2) 268 | tzinfo-data 269 | wdm (~> 0.1.1) 270 | 271 | BUNDLED WITH 272 | 2.1.4 273 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020 onwards, fast.ai, Inc 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [//]: # (BADGES SECTION: change `fastai` with your GitHub username and `fastpages` with the name of your repo) 2 | 3 | ![](https://github.com/fastai/fastpages/workflows/CI/badge.svg) 4 | ![](https://github.com/fastai/fastpages/workflows/GH-Pages%20Status/badge.svg) 5 | [![](https://img.shields.io/static/v1?label=fastai&message=nbdev&color=57aeac&labelColor=black&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAjCAYAAABhCKGoAAAGMklEQVR42q1Xa0xTVxyfKExlui9blszoB12yDzPGzJhtyT5s+zBxUxELBQSHm2ZzU5epBF/LclXae29pCxR5VEGgLQUuIOKDuClhm8oUK7S9ve19tLTl/fA5p9MNc/Y/hRYEzGLxJL/87zk9Ob/zf5++NGHMALzYgdDYmWh0Qly3Lybtwi6lXdpN2cWN5A0+hrQKe5R2PoN2uD+OKcn/UF5ZsVduMmyXVRi+jzebdmI5/juhwrgj3mTI2GA0vvsUIcMwM7GkOD42t7Mf6bqHkFry2yk7X5PXcxMVDN5DGtFf9NkJfe6W5iaUyFShjfV1KPlk7VPAa0k11WjzL+eRvMJ4IKQO0dw8SydJL+Op0u5cn+3tQTn+fqTivTbQpiavF0iG7iGt6NevKjpKpTbUo3hj+QO47XB8hfHfIGAelA+T6mqQzFi+e0oTKm3iexQnXaU56ZrK5SlVsq70LMF7TuX0XNTyvi1rThzLST3TgOCgxwD0DPwDGoE07QkcSl/m5ynbHWmZVm6b0sp9o2DZN8aTZtqk9w9b2G2HLbbvsjlx+fry0vwU0OS5SH68Ylmilny3c3x9SOvpRuQN7hO8vqulZQ6WJMuXFAzcRfkDd5BG8B1bpc+nU0+fQtgkYLIngOEJwGt/J9UxCIJg1whJ05Ul4IMejbsLqUUfOjJKQnCDr4ySHMeO1/UMIa3UmR9TUpj7ZdMFJK8yo6RaZjLAF/JqM/rifCO+yP4AycGmlgUaT9cZ0OYP2um5prjBLhtvLhy68Fs7RFqbRvSlf15ybGdyLcPJmcpfIcIuT4nqqt+Sa2vaZaby1FB+JGi1c9INhuiv9fpIysItIh3CVgVAzXfEE1evzse/bwr8bolcAXs+zcqKXksQc5+FD2D/svT06I8IYtaUeZLZzsVm+3oRDmON1Ok/2NKyIJSs0xnj84RknXG6zgGEE1It+rsPtrYuDOxBKAJLrO1qnW7+OpqeNxF4HWv6v4Rql3uFRvL/DATnc/29x4lmy2t4fXVjY+ASGwylm8DBvkSm2gpgx1Bpg4hyyysqVoUuFRw0z8+jXe40yiFsp1lpC9navlJpE9JIh7RVwfJywmKZO4Hkh02NZ1FilfkJLi1B4GhLPduAZGazHO9LGDX/WAj7+npzwUQqvuOBoo1Va91dj3Tdgyinc0Dae+HyIrxvc2npbCxlxrJvcW3CeSKDMhKCoexRYnUlSqg0xU0iIS5dXwzm6c/x9iKKEx8q2lkV5RARJCcm9We2sgsZhGZmgMYjJOU7UhpOIqhRwwlmEwrBZHgCBRKkKX4ySVvbmzQnXoSDHWCyS6SV20Ha+VaSFTiSE8/ttVheDe4NarLxVB1kdE0fYAgjGaOWGYD1vxKrqmInkSBchRkmiuC4KILhonAo4+9gWVHYnElQMEsAxbRDSHtp7dq5CRWly2VlZe/EFRcvDcBQvBTPZeXly1JMpvlThzBBRASBoDsSBIpgOBQV6C+sUJzffwflQX8BTevCTZMZeoslUo9QJJZYTZDw3RuIKtIhlhXdfhDoJ7TTXY/XdBBpgUshwFMSRYTVwim7FJvt6aFyOnoVKqc7MZQDzzNwsmnd3UegCudl8R2qzHZ7bJbQoYGyn692+zMULCfXenoOacTOTBUnJYRFsq+5+a3sjp5BXM6hEz7ObHNoVEIHyocekiX6WIiykwWDd1HhzT8RzY2YqxnK0HNQBJtW500ddiwrDgdIeCABZ4MPnKQdk9xDhUP3wfHSqbBI9v/e9jo0Iy30cCOgAMyVgMMVCMwql/cQxfKp2R1dWWrRm0PzUkrIXC9ykDY+hnJ5DqkE709guriwSRgGzWTQCPABWJZ6vbNHQlgo099+CCEMPnF6xnwynYETEWd8ls0WPUpSWnTrfuAhAWacPslUiQRNLBGXFSA7TrL8V3gNhesTnLFY0jb+bYWVp0i7SClY184jVtcayi7so2yuA0r4npbjsV8CJHZhPQ7no323cJ5w8FqpLwR/YJNRnHs0hNGs6ZFw/Lpsb+9oj/dZSbuL0XUNojx4d9Gch5mOT0ImINsdKyHzT9Muz1lcXhRWbo9a8J3B72H8Lg6+bKb1hyWMPeERBXMGRxEBCM7Ddfh/1jDuWhb5+QkAAAAASUVORK5CYII=)](https://github.com/fastai/nbdev) 6 | [![](https://img.shields.io/static/v1?label=View%20Demo%20Site&message=link&labelColor=2f363d&color=blue&style=flat&logo=github&logoColor=959da5)](https://fastpages.fast.ai/) 7 | 8 | [//]: # (END OF BADGES SECTION) 9 | 10 | # Welcome To `fastpages` 11 | 12 | > An easy to use blogging platform, with support for Jupyter notebooks, Word docs, and Markdown. 13 | 14 | ![](images/diagram.png) 15 | 16 | `fastpages` uses [GitHub Actions](https://github.com/features/actions) to simplify the process of of creating [Jekyll blog posts](https://jekyllrb.com/) on [GitHub Pages](https://pages.github.com/) from a variety of input formats. 17 | 18 | ### `fastpages` provides the following features: 19 | 20 | - Create posts containing code, outputs of code (which can be interactive), formatted text, etc directly from [Jupyter Notebooks](https://jupyter.org/); Notebook posts support features such as: 21 | - Interactive visualizations made with [Altair](https://altair-viz.github.io/) remain interactive. 22 | - Hide or show cell input and output. 23 | - Collapsable code cells that are either open or closed by default. 24 | - Define the Title, Summary and other metadata via a special markdown cells 25 | - Ability to add links to [Colab](https://colab.research.google.com/) and GitHub automatically. 26 | - Write posts on your local machine and [preview them with live reload](#running-the-blog-on-your-local-machine). 27 | - Create posts, including formatting and images, directly from Microsoft Word documents. 28 | - Create and edit [Markdown](https://guides.github.com/features/mastering-markdown/) posts entirely online using GitHub's built-in markdown editor. 29 | - Embed Twitter cards and YouTube videos. 30 | - Categorization of blog posts by user-supplied tags for discoverability. 31 | 32 | See below for a more detailed list of features. 33 | 34 | 35 | **[See the demo site](https://fastpages.fast.ai/)** 36 | 37 | --- 38 | 39 | 40 | 41 | - [Welcome To `fastpages`](#welcome-to-fastpages) 42 | - [Setup Instructions](#setup-instructions) 43 | - [Front-Matter related options](#front-matter-related-options) 44 | - [Configure Title & Summary](#configure-title--summary) 45 | - [Table of Contents](#table-of-contents) 46 | - [Colab And GitHub Badges](#colab-and-github-badges) 47 | - [Tags](#categories) 48 | - [Enabling Comments](#enabling-comments) 49 | - [Setting an Image For Social Media](#setting-an-image-for-social-media) 50 | - [Writing Blog Posts With Jupyter](#writing-blog-posts-with-jupyter) 51 | - [Hide Input/Output Cells](#hide-inputoutput-cells) 52 | - [Collapsable Code Cells](#collapsable-code-cells) 53 | - [Embedded Twitter and YouTube Content](#embedded-twitter-and-youtube-content) 54 | - [Automatically Convert Notebooks To Blog Posts](#automatically-convert-notebooks-to-blog-posts) 55 | - [Writing Blog Posts With Markdown](#writing-blog-posts-with-markdown) 56 | - [Writing Blog Posts With Microsoft Word](#writing-blog-posts-with-microsoft-word) 57 | - [Running the blog on your local machine](#running-the-blog-on-your-local-machine) 58 | - [Using The GitHub Action & Your Own Custom Blog](#using-the-github-action-your-own-custom-blog) 59 | - [Optional Inputs](#optional-inputs) 60 | - [Contributing To Fastpages](#contributing-to-fastpages) 61 | - [FAQ](#faq) 62 | 63 | 64 | 65 | 66 | ## Setup Instructions 67 | 68 | 1. Generate a copy of this repo by clicking [on this link](https://github.com/fastai/fastpages/generate). Name your repo anything you like **except** {your-username}.github.io. 69 | 70 | 2. **GitHub Actions will automatically open a PR** on your new repository ~ 30 seconds after the copy is created. Follow the instructions in that PR to continue. 71 | 72 | 73 | ## Front-Matter related options 74 | 75 | In a notebook, [front matter](https://jekyllrb.com/docs/front-matter/) is defined as a markdown cell at the beginning of the notebook with the following contents: 76 | 77 | ```markdown 78 | # "Title" 79 | > "Awesome summary" 80 | - toc: false 81 | - branch: master 82 | - badges: true 83 | - comments: true 84 | - categories: [fastpages, jupyter] 85 | - image: images/some_folder/your_image.png 86 | - metadata_key1: metadata_value1 87 | - metadata_key2: metadata_value2 88 | ``` 89 | 90 | Similarly, in a markdown document the same front matter would be defined like this at the beginning of the document: 91 | 92 | ```yaml 93 | --- 94 | - title: "My Title" 95 | - summary: "Awesome summary" 96 | - toc: false 97 | - branch: master 98 | - badges: true 99 | - comments: true 100 | - image: images/some_folder/your_image.png 101 | - categories: [fastpages, jupyter] 102 | - metadata_key1: metadata_value1 103 | - metadata_key2: metadata_value2 104 | --- 105 | ``` 106 | 107 | Additional metadata is optional and allows you to set custom [front matter](https://jekyllrb.com/docs/front-matter/). 108 | 109 | Note that anything defined in front matter must be valid YAML. **Failure to provide valid YAML could result in your page not rendering** in your blog. For example, if you want a colon in your title you must escape it with double quotes like this: 110 | 111 | ` - title: "Deep learning: A tutorial"` 112 | 113 | See this [tutorial on YAML](https://rollout.io/blog/yaml-tutorial-everything-you-need-get-started/) for more information. 114 | 115 | ### Configure Title & Summary 116 | - Replace `Title`, with your desired title, and `Awesome summary` with your desired summary. 117 | 118 | **Note:** It is recommended to enclose these values in double quotes, so that you can escape colons and other characters that may break the YAML parser. 119 | 120 | ### Table of Contents 121 | - `fast_template` will automatically generate a table of contents for you based on [markdown headers](https://guides.github.com/features/mastering-markdown/)! You can toggle this feature on or off by setting `toc:` to either `true` or `false`. 122 | 123 | ### Colab And GitHub Badges 124 | 125 | This option works for **notebooks only** 126 | 127 | - The `branch` field is used to optionally render a link your notebook to Colab and GitHub in your blog post post. It'll default to `master` if you don't specify it in the notebook. 128 | - If you do not want to show Colab / GitHub badges on your blog post (perhaps because your repo is private and the links would be broken) set `badges` to `false`. This defaults to `true` 129 | 130 | ### Categories 131 | - You can have a comma seperated list inside square brackets of categories for a blog post, which will make the post visible on the tags page of your blog's site. For example: 132 | 133 | ` - categories: [fastpages, jupyter]` 134 | 135 | 136 | You can see a preview of what this looks like [here](https://fastpages.fast.ai/categories/). 137 | 138 | 139 | - You can toggle the display of tags on/off by setting `show_tags` to `true` or `false` in `_config.yml`: 140 | 141 | ```yaml 142 | # Set this to true to display tags on each post 143 | show_tags: true 144 | ``` 145 | 146 | ### Enabling Comments 147 | 148 | Blog posting is powered by [Utterances](https://github.com/utterance/utterances), an open-source and ad-free way of implementing comments. All comments are stored in issues on your blog's GitHub repo. You can turn this on setting `comments` to `true`. This defaults to `false`. 149 | 150 | To enable comments with [Utterances](https://github.com/utterance/utterances) you will need to do the following: 151 | 152 | - Make sure the repo is public, otherwise your readers will not be able to view the issues/comments. 153 | - Make sure the [utterances app](https://github.com/apps/utterances) is installed on the repo, otherwise users will not be able to post comments. 154 | - If your repo is a fork, navigate to it's settings tab and confirm the issues feature is turned on. 155 | 156 | ### Setting an Image For Social Media 157 | 158 | On social media sites like Twitter, an image preview can be automatically shown with your URL. Specifying the front matter `image` provides this metadata to social media sites to render this image for you. You can set this value as follows: 159 | 160 | `- image: images/diagram.png` 161 | 162 | Note: for this setting **you can only reference image files and folders in the `/images` folder of your repo.** 163 | 164 | 165 | ## Writing Blog Posts With Jupyter 166 | 167 | ### Hide Input/Output Cells 168 | 169 | Place the comment `#hide` at the beginning of a code cell and it wil **hide both the input and the output** of that cell. If you only want to hide just the input or the output, use the `hide input` [Jupyter Extension](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/hide_input/readme.html) 170 | 171 | ### Collapsable Code Cells 172 | 173 | You may want to have code code be hidden from view under a collapsed element that the user can expand, rather than completely hiding the code from the reader. 174 | 175 | - To include code in a collapsable cell that **is collapsed by default**, place the comment `#collapse` at the top of the code cell. 176 | - To include code in a collapsable cell that **is open by default**, place the comment `#collapse_show` or `#collapse-show` at the top of the code cell. 177 | 178 | ### Embedded Twitter and YouTube Content 179 | In a markdown cell in your notebook, use the following markdown shortcuts to embed Twitter cards and YouTube Videos. 180 | 181 | 182 | ```markdown 183 | > youtube: https://youtu.be/your-link 184 | > twitter: https://twitter.com/some-link 185 | ``` 186 | 187 | ### Automatically Convert Notebooks To Blog Posts 188 | 189 | 1. Save your notebook with the naming convention `YYYY-MM-DD-*.` into the `/_notebooks` or `/_word` folder of this repo, respectively. For example `2020-01-28-My-First-Post.ipynb`. This [naming convention is required by Jekyll](https://jekyllrb.com/docs/posts/) to render your blog post. 190 | - Be careful to name your file correctly! It is easy to forget the last dash in `YYYY-MM-DD-`. Furthermore, the character immediately following the dash should only be an alphabetical letter. Examples of valid filenames are: 191 | 192 | ```shell 193 | 2020-01-28-My-First-Post.ipynb 194 | 2012-09-12-how-to-write-a-blog.ipynb 195 | ``` 196 | 197 | - If you fail to name your file correctly, `fastpages` will automatically attempt to fix the problem by prepending the last modified date of your file to your generated blog post, however, it is recommended that you name your files properly yourself for more transparency. 198 | 199 | 200 | 2. [Commit and push](https://help.github.com/en/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line) your file(s) to GitHub in your repository's master branch. 201 | 202 | 3. GitHub will automatically convert your files to blog posts. **It will take ~5 minutes for the conversion process to take place**. You can click on the Actions tab of your repo to view the logs of this process. There will be two workflows that are triggered with each push you make to your master branch: (1) "CI" and (2) "GH Pages Status". Both workflows must complete with a green checkmark for your latest commit before your site is updated. 203 | 204 | 4. If you wish, you can preview how your blog will look locally before commiting to GitHub. See [this section](#running-the-blog-on-your-local-machine) for a detailed guide on running the preview locally. 205 | 206 | 207 | ## Writing Blog Posts With Markdown 208 | 209 | If you are writing your blog post in markdown, save your `.md` file into the `/_posts` folder with the same naming convention (`YYYY-MM-DD-*.md`) specified for notebooks. 210 | 211 | ## Writing Blog Posts With Microsoft Word 212 | 213 | Save your Microsoft Word documents into the `/_word` folder with the same naming convention (`YYYY-MM-DD-*.docx`) specified for notebooks. 214 | 215 | # Running the blog on your local machine 216 | 217 | See the [development guide](DEVELOPMENT.md). 218 | 219 | 220 | # Using The GitHub Action & Your Own Custom Blog 221 | 222 | The `fastpages` action allows you to convert notebooks from `/_notebooks` and word documents from `/_word` directories in your repo into [Jekyll](https://jekyllrb.com/) compliant blog post markdown files located in `/_posts`. **Note: This directory structure is currently inflexible** for this Action, as it is designed to be used with Jekyll. 223 | 224 | If you already have sufficient familiarity with [Jekyll](https://jekyllrb.com/) and wish to use this automation in your own theme, you can use this GitHub Action by referencing `fastai/fastpages@master` as follows: 225 | 226 | ```yaml 227 | ... 228 | 229 | uses: fastai/fastpages@master 230 | 231 | ... 232 | ``` 233 | An illustrative example of what a complete workflow may look like: 234 | 235 | 236 | 237 | ```yaml 238 | jobs: 239 | build-site: 240 | runs-on: ubuntu-latest 241 | ... 242 | 243 | - name: convert notebooks and word docs to posts 244 | uses: fastai/fastpages@master 245 | 246 | ... 247 | 248 | - name: Jekyll build 249 | uses: docker://jekyll/jekyll 250 | with: 251 | args: jekyll build 252 | 253 | - name: Deploy 254 | uses: peaceiris/actions-gh-pages@v3 255 | if: github.event_name == 'push' 256 | with: 257 | deploy_key: ${{ secrets.SSH_DEPLOY_KEY }} 258 | publish_branch: gh-pages 259 | publish_dir: ./_site 260 | ``` 261 | 262 | Note that this Action **does not have any required inputs, and has no output variables**. 263 | 264 | ### Optional Inputs 265 | 266 | - `BOOL_SAVE_MARKDOWN`: Either 'true' or 'false'. Whether or not to commit converted markdown files from notebooks and word documents into the _posts directory in your repo. This is useful for debugging. _default: false_ 267 | - `SSH_DEPLOY_KEY`: a ssh deploy key is required if BOOL_SAVE_MARKDOWN = 'true' 268 | 269 | See the API spec for this action in [action.yml](action.yml) 270 | 271 | Detailed instructions on how to customize this blog are beyond the scope of this README. ( We invite someone from the community to contribute a blog post on how to do this in this repo! ) 272 | 273 | # Contributing To Fastpages 274 | 275 | Please see the [contributing guide](CONTRIBUTING.md). 276 | 277 | 278 | # FAQ 279 | 280 | - **Q:** Where are the markdown files in `_posts/` that are generated from my Jupyter notebooks or word documents? **A:** The GitHub Actions workflow in this repo converts your notebook and word documents to markdown on the fly before building your site, but never commits these intermediate markdown files to this repo. This is in order to save you from the annoyance of your local environment being constantly out of sync with your repository. You can optionally see these intermediate markdown files by setting the `BOOL_SAVE_MARKDOWN` and `SSH_DEPLOY_KEY` inputs to the fastpages action in your `.github/workflows/ci.yaml` file as follows: 281 | 282 | ```yaml 283 | ... 284 | 285 | - name: convert notebooks and word docs to posts 286 | uses: fastai/fastpages@master 287 | with: 288 | BOOL_SAVE_MARKDOWN: true 289 | SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }} 290 | 291 | ... 292 | ``` 293 | 294 | - **Q:** Can I use `fastpages` for Jekyll docs sites or for things that are not Jekyll blog posts? **A:** At the moment, `fastpages` is a highly opinionated solution that works only for Jekyll blog posts. If you want to write documentation for your module or library with Jupyter notebooks, we suggest you use [fastai/nbdev](https://github.com/fastai/nbdev) which is expressly built for this purpose. 295 | 296 | - **Q:** What is the difference between [fast_template](https://github.com/fastai/fast_template) and fastpages? Which one should I use? **A:** Because `fastpages` is more flexible and extensible, we recommend using it where possible. `fast_template` may be a better option for getting folks blogging who have no technical expertise at all, and will only be creating posts using Github's integrated online editor. 297 | 298 | -------------------------------------------------------------------------------- /_notebooks/2020-02-21-introducing-fastpages.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "cell_type": "markdown", 5 | "metadata": {}, 6 | "source": [ 7 | "# Introducing fastpages\n", 8 | "> An easy to use blogging platform with extra features for Jupyter Notebooks.\n", 9 | "\n", 10 | "- toc: true \n", 11 | "- badges: true\n", 12 | "- comments: true\n", 13 | "- author: Jeremy Howard & Hamel Husain\n", 14 | "- image: images/diagram.png\n", 15 | "- categories: [fastpages, jupyter]" 16 | ] 17 | }, 18 | { 19 | "cell_type": "markdown", 20 | "metadata": {}, 21 | "source": [ 22 | "![](https://github.com/fastai/fastpages/raw/master/images/diagram.png \"https://github.com/fastai/fastpages\")\n", 23 | "\n", 24 | "We are very pleased to announce the immediate availability of [fastpages](https://github.com/fastai/fastpages). `fastpages` is a platform which allows you to create and host a blog for free, with no ads and many useful features, such as:\n", 25 | "\n", 26 | "- Create posts containing code, outputs of code (which can be interactive), formatted text, etc directly from [Jupyter Notebooks](https://jupyter.org/); for instance see this great [example post](https://drscotthawley.github.io/devblog3/2019/02/08/My-1st-NN-Part-3-Multi-Layer-and-Backprop.html) from Scott Hawley. Notebook posts support features such as:\n", 27 | " - Interactive visualizations made with [Altair](https://altair-viz.github.io/) remain interactive.\n", 28 | " - Hide or show cell input and output.\n", 29 | " - Collapsable code cells that are either open or closed by default.\n", 30 | " - Define the Title, Summary and other metadata via a special markdown cells\n", 31 | " - Ability to add links to [Colab](https://colab.research.google.com/) and GitHub automatically.\n", 32 | "- Create posts, including formatting and images, directly from Microsoft Word documents.\n", 33 | "- Create and edit [Markdown](https://guides.github.com/features/mastering-markdown/) posts entirely online using GitHub's built-in markdown editor.\n", 34 | "- Embed Twitter cards and YouTube videos.\n", 35 | "- Categorization of blog posts by user-supplied tags for discoverability.\n", 36 | "- ... and [much more](https://github.com/fastai/fastpages)\n", 37 | "\n", 38 | "[fastpages](https://github.com/fastai/fastpages) relies on Github pages for hosting, and [Github Actions](https://github.com/features/actions) to automate the creation of your blog. The setup takes around three minutes, and does not require any technical knowledge or expertise. Due to built-in automation of fastpages, you don't have to fuss with conversion scripts. All you have to do is save your Jupyter notebook, Word document or markdown file into a specified directory and the rest happens automatically. Infact, this blog post is written in a Jupyter notebook, which you can see with the \"View on GitHub\" link above.\n", 39 | "\n", 40 | "[fast.ai](https://www.fast.ai/) have previously released a similar project called [fast_template](https://www.fast.ai/2020/01/16/fast_template/), which is even easier to set up, but does not support automatic creation of posts from Microsoft Word or Jupyter notebooks, including many of the features outlined above.\n", 41 | "\n", 42 | "**Because `fastpages` is more flexible and extensible, we recommend using it where possible.** `fast_template` may be a better option for getting folks blogging who have no technical expertise at all, and will only be creating posts using Github's integrated online editor." 43 | ] 44 | }, 45 | { 46 | "cell_type": "markdown", 47 | "metadata": {}, 48 | "source": [ 49 | "# Setting Up Fastpages\n", 50 | "\n", 51 | "[The setup process](https://github.com/fastai/fastpages#setup-instructions) of fastpages is automated with GitHub Actions, too! Upon creating a repo from the fastpages template, a pull request will automatically be opened (after ~ 30 seconds) configuring your blog so it can start working. The automated pull request will greet you with instructions like this:\n", 52 | "\n", 53 | "![Imgur](https://i.imgur.com/JhkIip8.png)\n" 54 | ] 55 | }, 56 | { 57 | "cell_type": "markdown", 58 | "metadata": {}, 59 | "source": [ 60 | "All you have to do is follow these instructions (in the PR you receive) and your new blogging site will be up and running!" 61 | ] 62 | }, 63 | { 64 | "cell_type": "markdown", 65 | "metadata": {}, 66 | "source": [ 67 | "# Jupyter Notebooks & Fastpages\n", 68 | "\n", 69 | "In this post, we will cover special features that fastpages provides has for Jupyter notebooks. You can also write your blog posts with Word documents or markdown in fastpages, which contain many, but not all the same features. " 70 | ] 71 | }, 72 | { 73 | "cell_type": "markdown", 74 | "metadata": {}, 75 | "source": [ 76 | "## Options via FrontMatter\n", 77 | "\n", 78 | "The first cell in your Jupyter Notebook or markdown blog post contains front matter. Front matter is metadata that can turn on/off options in your Notebook. It is formatted like this:\n", 79 | "\n", 80 | "```\n", 81 | "# Title\n", 82 | "> Awesome summary\n", 83 | "- toc: true\n", 84 | "- branch: master\n", 85 | "- badges: true\n", 86 | "- comments: true\n", 87 | "- author: Hamel Husain & Jeremy Howard\n", 88 | "- categories: [fastpages, jupyter]\n", 89 | "```\n", 90 | "\n", 91 | "**All of the above settings are enabled in this post, so you can see what they look like!**\n", 92 | "\n", 93 | "- the summary field (preceeded by `>`) will be displayed under your title, and will also be used by social media to display as the description of your page.\n", 94 | "- `toc`: setting this to `true` will automatically generate a table of contents\n", 95 | "- `badges`: setting this to `true` will display Google Colab and GitHub links on your blog post.\n", 96 | "- `comments`: setting this to `true` will enable comments. See [these instructions](https://github.com/fastai/fastpages#enabling-comments) for more details.\n", 97 | "- `author` this will display the authors names. \n", 98 | "- `categories` will allow your post to be categorized on a \"Tags\" page, where readers can browse your post by categories.\n", 99 | "\n", 100 | "\n", 101 | "_Markdown front matter is formatted similarly to notebooks. The differences between the two can be [viewed on the fastpages README](https://github.com/fastai/fastpages#front-matter-related-options)._" 102 | ] 103 | }, 104 | { 105 | "cell_type": "markdown", 106 | "metadata": {}, 107 | "source": [ 108 | "## Code Folding" 109 | ] 110 | }, 111 | { 112 | "cell_type": "markdown", 113 | "metadata": {}, 114 | "source": [ 115 | "put a `#collapse_show` flag at the top of any cell if you want to **show** that cell by default, but give the reader the option to hide it:" 116 | ] 117 | }, 118 | { 119 | "cell_type": "code", 120 | "execution_count": 4, 121 | "metadata": {}, 122 | "outputs": [], 123 | "source": [ 124 | "#collapse\n", 125 | "import pandas as pd\n", 126 | "import altair as alt" 127 | ] 128 | }, 129 | { 130 | "cell_type": "markdown", 131 | "metadata": {}, 132 | "source": [ 133 | "put a `#collapse_show` flag at the top of any cell if you want to **show** that cell by default, but give the reader the option to hide it:" 134 | ] 135 | }, 136 | { 137 | "cell_type": "code", 138 | "execution_count": 5, 139 | "metadata": {}, 140 | "outputs": [], 141 | "source": [ 142 | "#collapse_show\n", 143 | "cars = 'https://vega.github.io/vega-datasets/data/cars.json'\n", 144 | "movies = 'https://vega.github.io/vega-datasets/data/movies.json'\n", 145 | "sp500 = 'https://vega.github.io/vega-datasets/data/sp500.csv'\n", 146 | "stocks = 'https://vega.github.io/vega-datasets/data/stocks.csv'\n", 147 | "flights = 'https://vega.github.io/vega-datasets/data/flights-5k.json'" 148 | ] 149 | }, 150 | { 151 | "cell_type": "markdown", 152 | "metadata": {}, 153 | "source": [ 154 | "If you want to completely hide cells (not just collapse them), [read these instructions](https://github.com/fastai/fastpages#hide-inputoutput-cells)" 155 | ] 156 | }, 157 | { 158 | "cell_type": "code", 159 | "execution_count": 6, 160 | "metadata": {}, 161 | "outputs": [], 162 | "source": [ 163 | "# hide\n", 164 | "df = pd.read_json(movies) # load movies data\n", 165 | "genres = df['Major_Genre'].unique() # get unique field values\n", 166 | "genres = list(filter(lambda d: d is not None, genres)) # filter out None values\n", 167 | "genres.sort() # sort alphabetically" 168 | ] 169 | }, 170 | { 171 | "cell_type": "markdown", 172 | "metadata": {}, 173 | "source": [ 174 | "## Interactive Charts With Altair\n", 175 | "\n", 176 | "Interactive visualizations made with [Altair](https://altair-viz.github.io/) remain interactive! \n", 177 | "\n", 178 | "We leave this below cell unhidden so you can enjoy a preview of syntax highlighting in fastpages, which uses the [Dracula theme](https://draculatheme.com/)." 179 | ] 180 | }, 181 | { 182 | "cell_type": "code", 183 | "execution_count": 11, 184 | "metadata": {}, 185 | "outputs": [ 186 | { 187 | "data": { 188 | "text/html": [ 189 | "\n", 190 | "

\n", 191 | "" 236 | ], 237 | "text/plain": [ 238 | "alt.LayerChart(...)" 239 | ] 240 | }, 241 | "execution_count": 11, 242 | "metadata": {}, 243 | "output_type": "execute_result" 244 | } 245 | ], 246 | "source": [ 247 | "# select a point for which to provide details-on-demand\n", 248 | "label = alt.selection_single(\n", 249 | " encodings=['x'], # limit selection to x-axis value\n", 250 | " on='mouseover', # select on mouseover events\n", 251 | " nearest=True, # select data point nearest the cursor\n", 252 | " empty='none' # empty selection includes no data points\n", 253 | ")\n", 254 | "\n", 255 | "# define our base line chart of stock prices\n", 256 | "base = alt.Chart().mark_line().encode(\n", 257 | " alt.X('date:T'),\n", 258 | " alt.Y('price:Q', scale=alt.Scale(type='log')),\n", 259 | " alt.Color('symbol:N')\n", 260 | ")\n", 261 | "\n", 262 | "alt.layer(\n", 263 | " base, # base line chart\n", 264 | " \n", 265 | " # add a rule mark to serve as a guide line\n", 266 | " alt.Chart().mark_rule(color='#aaa').encode(\n", 267 | " x='date:T'\n", 268 | " ).transform_filter(label),\n", 269 | " \n", 270 | " # add circle marks for selected time points, hide unselected points\n", 271 | " base.mark_circle().encode(\n", 272 | " opacity=alt.condition(label, alt.value(1), alt.value(0))\n", 273 | " ).add_selection(label),\n", 274 | "\n", 275 | " # add white stroked text to provide a legible background for labels\n", 276 | " base.mark_text(align='left', dx=5, dy=-5, stroke='white', strokeWidth=2).encode(\n", 277 | " text='price:Q'\n", 278 | " ).transform_filter(label),\n", 279 | "\n", 280 | " # add text labels for stock prices\n", 281 | " base.mark_text(align='left', dx=5, dy=-5).encode(\n", 282 | " text='price:Q'\n", 283 | " ).transform_filter(label),\n", 284 | " \n", 285 | " data=stocks\n", 286 | ").properties(\n", 287 | " width=700,\n", 288 | " height=400\n", 289 | ")" 290 | ] 291 | }, 292 | { 293 | "cell_type": "markdown", 294 | "metadata": {}, 295 | "source": [ 296 | "## Data Tables\n", 297 | "\n", 298 | "You can display tables per the usual way in your blog:" 299 | ] 300 | }, 301 | { 302 | "cell_type": "code", 303 | "execution_count": 8, 304 | "metadata": {}, 305 | "outputs": [ 306 | { 307 | "data": { 308 | "text/html": [ 309 | "

\n", 310 | "\n", 323 | "\n", 324 | " \n", 325 | " \n", 326 | " \n", 327 | " \n", 328 | " \n", 329 | " \n", 330 | " \n", 331 | " \n", 332 | " \n", 333 | " \n", 334 | " \n", 335 | " \n", 336 | " \n", 337 | " \n", 338 | " \n", 339 | " \n", 340 | " \n", 341 | " \n", 342 | " \n", 343 | " \n", 344 | " \n", 345 | " \n", 346 | " \n", 347 | " \n", 348 | " \n", 349 | " \n", 350 | " \n", 351 | " \n", 352 | " \n", 353 | " \n", 354 | " \n", 355 | " \n", 356 | " \n", 357 | " \n", 358 | " \n", 359 | " \n", 360 | " \n", 361 | " \n", 362 | " \n", 363 | " \n", 364 | " \n", 365 | " \n", 366 | " \n", 367 | " \n", 368 | " \n", 369 | " \n", 370 | "

	Title	Worldwide_Gross	Production_Budget	IMDB_Rating
0	The Land Girls	146083.0	8000000.0	6.1
1	First Love, Last Rites	10876.0	300000.0	6.9
2	I Married a Strange Person	203134.0	250000.0	6.8
3	Let's Talk About Sex	373615.0	300000.0	NaN
4	Slam	1087521.0	1000000.0	3.4

\n", 371 | "

" 372 | ], 373 | "text/plain": [ 374 | " Title Worldwide_Gross Production_Budget IMDB_Rating\n", 375 | "0 The Land Girls 146083.0 8000000.0 6.1\n", 376 | "1 First Love, Last Rites 10876.0 300000.0 6.9\n", 377 | "2 I Married a Strange Person 203134.0 250000.0 6.8\n", 378 | "3 Let's Talk About Sex 373615.0 300000.0 NaN\n", 379 | "4 Slam 1087521.0 1000000.0 3.4" 380 | ] 381 | }, 382 | "execution_count": 8, 383 | "metadata": {}, 384 | "output_type": "execute_result" 385 | } 386 | ], 387 | "source": [ 388 | "movies = 'https://vega.github.io/vega-datasets/data/movies.json'\n", 389 | "df = pd.read_json(movies)\n", 390 | "# display table with pandas\n", 391 | "df[['Title', 'Worldwide_Gross', \n", 392 | " 'Production_Budget', 'IMDB_Rating']].head()" 393 | ] 394 | }, 395 | { 396 | "cell_type": "markdown", 397 | "metadata": {}, 398 | "source": [ 399 | "# Images w/Captions\n", 400 | "\n", 401 | "You can include markdown images with captions like this:\n", 402 | "\n", 403 | "```\n", 404 | "![](https://www.fast.ai/images/fastai_paper/show_batch.png \"Credit: https://www.fast.ai/2020/02/13/fastai-A-Layered-API-for-Deep-Learning/\")\n", 405 | "```\n", 406 | "\n", 407 | "\n", 408 | "![](https://www.fast.ai/images/fastai_paper/show_batch.png \"Credit: https://www.fast.ai/2020/02/13/fastai-A-Layered-API-for-Deep-Learning/\")\n", 409 | "\n", 410 | "Of course, the caption is optional." 411 | ] 412 | }, 413 | { 414 | "cell_type": "markdown", 415 | "metadata": {}, 416 | "source": [ 417 | "## Tweetcards\n", 418 | "\n", 419 | "Typing `> twitter: https://twitter.com/jakevdp/status/1204765621767901185?s=20` will render this:\n", 420 | "\n", 421 | "> twitter: https://twitter.com/jakevdp/status/1204765621767901185?s=20" 422 | ] 423 | }, 424 | { 425 | "cell_type": "markdown", 426 | "metadata": {}, 427 | "source": [ 428 | "## Youtube Videos\n", 429 | "\n", 430 | "Typing `> youtube: https://youtu.be/XfoYk_Z5AkI` will render this:\n", 431 | "\n", 432 | "\n", 433 | "> youtube: https://youtu.be/XfoYk_Z5AkI" 434 | ] 435 | }, 436 | { 437 | "cell_type": "markdown", 438 | "metadata": {}, 439 | "source": [ 440 | "## Boxes / Callouts \n", 441 | "\n", 442 | "Typing `> Warning: There will be no second warning!` will render this:\n", 443 | "\n", 444 | "\n", 445 | "> Warning: There will be no second warning!\n", 446 | "\n", 447 | "\n", 448 | "\n", 449 | "Typing `> Important: Pay attention! It's important.` will render this:\n", 450 | "\n", 451 | "> Important: Pay attention! It's important.\n", 452 | "\n", 453 | "\n", 454 | "\n", 455 | "Typing `> Tip: This is my tip.` will render this:\n", 456 | "\n", 457 | "> Tip: This is my tip.\n", 458 | "\n", 459 | "\n", 460 | "\n", 461 | "Typing `> Note: Take note of this.` will render this:\n", 462 | "\n", 463 | "> Note: Take note of this.\n", 464 | "\n", 465 | "\n", 466 | "\n", 467 | "Typing `> Note: A doc link to [an example website: fast.ai](https://www.fast.ai/) should also work fine.` will render in the docs:\n", 468 | "\n", 469 | "> Note: A doc link to [an example website: fast.ai](https://www.fast.ai/) should also work fine." 470 | ] 471 | }, 472 | { 473 | "cell_type": "markdown", 474 | "metadata": {}, 475 | "source": [ 476 | "## More Examples\n", 477 | "\n", 478 | "This [tutorial](https://fastpages.fast.ai/fastpages/jupyter/2020/02/20/test.html) contains more examples of what you can do with notebooks. " 479 | ] 480 | }, 481 | { 482 | "cell_type": "markdown", 483 | "metadata": {}, 484 | "source": [ 485 | "# How fastpages Converts Notebooks to Blog Posts" 486 | ] 487 | }, 488 | { 489 | "cell_type": "markdown", 490 | "metadata": {}, 491 | "source": [ 492 | "fastpages uses [nbdev](https://nbdev.fast.ai/index.html) to power the conversion process of Jupyter Notebooks to blog posts. When you save a notebook into the `/_notebooks` folder of your repository, GitHub Actions applies `nbdev` against those notebooks automatically. The same process occurs when you save Word documents or markdown files into the `_word` or `_posts` directory, respectively.\n", 493 | "\n", 494 | "We will discuss how GitHub Actions work in a follow up blog post." 495 | ] 496 | }, 497 | { 498 | "cell_type": "markdown", 499 | "metadata": {}, 500 | "source": [ 501 | "# Resources & Next Steps" 502 | ] 503 | }, 504 | { 505 | "cell_type": "markdown", 506 | "metadata": {}, 507 | "source": [ 508 | "We highly encourage you to start blogging with `fastpages`! Some resources that may be helpful:\n", 509 | "\n", 510 | "- [fastpages repo](https://github.com/fastai/fastpages) - this is where you can go to create your own fastpages blog!\n", 511 | "- Fastai forums - [nbdev & blogging category](https://forums.fast.ai/c/fastai-users/nbdev/). You can ask questions about fastpages here, as well as suggest new features.\n", 512 | "- [nbdev](https://github.com/fastai/nbdev): this project powers the conversion of Jupyter notebooks to blog posts.\n", 513 | "\n", 514 | "If you end up writing a blog post using fastpages, please let us know on Twitter: [@jeremyphoward](https://twitter.com/jeremyphoward), [@HamelHusain](https://twitter.com/hamelhusain)." 515 | ] 516 | } 517 | ], 518 | "metadata": { 519 | "kernelspec": { 520 | "display_name": "Python 3", 521 | "language": "python", 522 | "name": "python3" 523 | }, 524 | "language_info": { 525 | "codemirror_mode": { 526 | "name": "ipython", 527 | "version": 3 528 | }, 529 | "file_extension": ".py", 530 | "mimetype": "text/x-python", 531 | "name": "python", 532 | "nbconvert_exporter": "python", 533 | "pygments_lexer": "ipython3", 534 | "version": "3.7.4" 535 | } 536 | }, 537 | "nbformat": 4, 538 | "nbformat_minor": 2 539 | } 540 | -------------------------------------------------------------------------------- /assets/js/vendor/lunr.min.js: -------------------------------------------------------------------------------- 1 | /** 2 | * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.6 3 | * Copyright (C) 2019 Oliver Nightingale 4 | * @license MIT 5 | */ 6 | !function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.6",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return void 0===e||null===e?"":e.toString()},e.utils.clone=function(e){if(null===e||void 0===e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i0){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); 7 | -------------------------------------------------------------------------------- /_notebooks/2020-02-20-test.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "cell_type": "markdown", 5 | "metadata": {}, 6 | "source": [ 7 | "# Fastpages Notebook Blog Post\n", 8 | "> A tutorial of fastpages for Jupyter notebooks.\n", 9 | "\n", 10 | "- toc: true \n", 11 | "- badges: true\n", 12 | "- comments: true\n", 13 | "- categories: [fastpages, jupyter]\n", 14 | "- image: images/chart-preview.png" 15 | ] 16 | }, 17 | { 18 | "cell_type": "markdown", 19 | "metadata": {}, 20 | "source": [ 21 | "# About\n", 22 | "\n", 23 | "This notebook is a demonstration of some of capabilities of [fastpages](https://github.com/fastai/fastpages) with notebooks.\n", 24 | "\n", 25 | "\n", 26 | "With `fastpages` you can save your jupyter notebooks into the `_notebooks` folder at the root of your repository, and they will be automatically be converted to Jekyll compliant blog posts!" 27 | ] 28 | }, 29 | { 30 | "cell_type": "markdown", 31 | "metadata": {}, 32 | "source": [ 33 | "## Front Matter\n", 34 | "\n", 35 | "Front Matter is a markdown cell at the beginning of your notebook that allows you to inject metadata into your notebook. For example:\n", 36 | "\n", 37 | "- Setting `toc: true` will automatically generate a table of contents\n", 38 | "- Setting `badges: true` will automatically include GitHub and Google Colab links to your notebook.\n", 39 | "- Setting `comments: true` will enable commenting on your blog post, powered by [utterances](https://github.com/utterance/utterances).\n", 40 | "\n", 41 | "More details and options for front matter can be viewed on the [front matter section](https://github.com/fastai/fastpages#front-matter-related-options) of the README." 42 | ] 43 | }, 44 | { 45 | "cell_type": "markdown", 46 | "metadata": {}, 47 | "source": [ 48 | "## Markdown Shortcuts" 49 | ] 50 | }, 51 | { 52 | "cell_type": "markdown", 53 | "metadata": {}, 54 | "source": [ 55 | "put a `#hide` flag at the top of any cell you want to completely hide in the docs" 56 | ] 57 | }, 58 | { 59 | "cell_type": "markdown", 60 | "metadata": {}, 61 | "source": [ 62 | "put a `#collapse` flag at the top of any cell if you want to hide that cell by default, but stil have it be visible to the reader:" 63 | ] 64 | }, 65 | { 66 | "cell_type": "code", 67 | "execution_count": 1, 68 | "metadata": {}, 69 | "outputs": [], 70 | "source": [ 71 | "#collapse\n", 72 | "import pandas as pd\n", 73 | "import altair as alt" 74 | ] 75 | }, 76 | { 77 | "cell_type": "markdown", 78 | "metadata": {}, 79 | "source": [ 80 | "put a `#collapse_show` flag at the top of any cell if you want to **show** that cell by default, but give the reader the option to hide it:" 81 | ] 82 | }, 83 | { 84 | "cell_type": "code", 85 | "execution_count": 2, 86 | "metadata": {}, 87 | "outputs": [], 88 | "source": [ 89 | "#collapse_show\n", 90 | "cars = 'https://vega.github.io/vega-datasets/data/cars.json'\n", 91 | "movies = 'https://vega.github.io/vega-datasets/data/movies.json'\n", 92 | "sp500 = 'https://vega.github.io/vega-datasets/data/sp500.csv'\n", 93 | "stocks = 'https://vega.github.io/vega-datasets/data/stocks.csv'\n", 94 | "flights = 'https://vega.github.io/vega-datasets/data/flights-5k.json'" 95 | ] 96 | }, 97 | { 98 | "cell_type": "markdown", 99 | "metadata": {}, 100 | "source": [ 101 | "## Interactive Charts With Altair\n", 102 | "\n", 103 | "Charts made with Altair remain interactive. Example charts taken from [this repo](https://github.com/uwdata/visualization-curriculum), specifically [this notebook](https://github.com/uwdata/visualization-curriculum/blob/master/altair_interaction.ipynb)." 104 | ] 105 | }, 106 | { 107 | "cell_type": "code", 108 | "execution_count": 3, 109 | "metadata": {}, 110 | "outputs": [], 111 | "source": [ 112 | "# hide\n", 113 | "df = pd.read_json(movies) # load movies data\n", 114 | "genres = df['Major_Genre'].unique() # get unique field values\n", 115 | "genres = list(filter(lambda d: d is not None, genres)) # filter out None values\n", 116 | "genres.sort() # sort alphabetically" 117 | ] 118 | }, 119 | { 120 | "cell_type": "code", 121 | "execution_count": 4, 122 | "metadata": {}, 123 | "outputs": [], 124 | "source": [ 125 | "#hide\n", 126 | "mpaa = ['G', 'PG', 'PG-13', 'R', 'NC-17', 'Not Rated']" 127 | ] 128 | }, 129 | { 130 | "cell_type": "markdown", 131 | "metadata": {}, 132 | "source": [ 133 | "### Example 1: DropDown" 134 | ] 135 | }, 136 | { 137 | "cell_type": "code", 138 | "execution_count": 5, 139 | "metadata": {}, 140 | "outputs": [ 141 | { 142 | "data": { 143 | "text/html": [ 144 | "\n", 145 | "

\n", 146 | "" 191 | ], 192 | "text/plain": [ 193 | "alt.Chart(...)" 194 | ] 195 | }, 196 | "execution_count": 5, 197 | "metadata": {}, 198 | "output_type": "execute_result" 199 | } 200 | ], 201 | "source": [ 202 | "# single-value selection over [Major_Genre, MPAA_Rating] pairs\n", 203 | "# use specific hard-wired values as the initial selected values\n", 204 | "selection = alt.selection_single(\n", 205 | " name='Select',\n", 206 | " fields=['Major_Genre', 'MPAA_Rating'],\n", 207 | " init={'Major_Genre': 'Drama', 'MPAA_Rating': 'R'},\n", 208 | " bind={'Major_Genre': alt.binding_select(options=genres), 'MPAA_Rating': alt.binding_radio(options=mpaa)}\n", 209 | ")\n", 210 | " \n", 211 | "# scatter plot, modify opacity based on selection\n", 212 | "alt.Chart(movies).mark_circle().add_selection(\n", 213 | " selection\n", 214 | ").encode(\n", 215 | " x='Rotten_Tomatoes_Rating:Q',\n", 216 | " y='IMDB_Rating:Q',\n", 217 | " tooltip='Title:N',\n", 218 | " opacity=alt.condition(selection, alt.value(0.75), alt.value(0.05))\n", 219 | ")" 220 | ] 221 | }, 222 | { 223 | "cell_type": "markdown", 224 | "metadata": {}, 225 | "source": [ 226 | "### Example 2: Tooltips" 227 | ] 228 | }, 229 | { 230 | "cell_type": "code", 231 | "execution_count": 6, 232 | "metadata": {}, 233 | "outputs": [ 234 | { 235 | "data": { 236 | "text/html": [ 237 | "\n", 238 | "

\n", 239 | "" 284 | ], 285 | "text/plain": [ 286 | "alt.Chart(...)" 287 | ] 288 | }, 289 | "execution_count": 6, 290 | "metadata": {}, 291 | "output_type": "execute_result" 292 | } 293 | ], 294 | "source": [ 295 | "alt.Chart(movies).mark_circle().add_selection(\n", 296 | " alt.selection_interval(bind='scales', encodings=['x'])\n", 297 | ").encode(\n", 298 | " x='Rotten_Tomatoes_Rating:Q',\n", 299 | " y=alt.Y('IMDB_Rating:Q', axis=alt.Axis(minExtent=30)), # use min extent to stabilize axis title placement\n", 300 | " tooltip=['Title:N', 'Release_Date:N', 'IMDB_Rating:Q', 'Rotten_Tomatoes_Rating:Q']\n", 301 | ").properties(\n", 302 | " width=600,\n", 303 | " height=400\n", 304 | ")" 305 | ] 306 | }, 307 | { 308 | "cell_type": "markdown", 309 | "metadata": {}, 310 | "source": [ 311 | "### Example 3: More Tooltips" 312 | ] 313 | }, 314 | { 315 | "cell_type": "code", 316 | "execution_count": 7, 317 | "metadata": { 318 | "scrolled": true 319 | }, 320 | "outputs": [ 321 | { 322 | "data": { 323 | "text/html": [ 324 | "\n", 325 | "

\n", 326 | "" 371 | ], 372 | "text/plain": [ 373 | "alt.LayerChart(...)" 374 | ] 375 | }, 376 | "execution_count": 7, 377 | "metadata": {}, 378 | "output_type": "execute_result" 379 | } 380 | ], 381 | "source": [ 382 | "# select a point for which to provide details-on-demand\n", 383 | "label = alt.selection_single(\n", 384 | " encodings=['x'], # limit selection to x-axis value\n", 385 | " on='mouseover', # select on mouseover events\n", 386 | " nearest=True, # select data point nearest the cursor\n", 387 | " empty='none' # empty selection includes no data points\n", 388 | ")\n", 389 | "\n", 390 | "# define our base line chart of stock prices\n", 391 | "base = alt.Chart().mark_line().encode(\n", 392 | " alt.X('date:T'),\n", 393 | " alt.Y('price:Q', scale=alt.Scale(type='log')),\n", 394 | " alt.Color('symbol:N')\n", 395 | ")\n", 396 | "\n", 397 | "alt.layer(\n", 398 | " base, # base line chart\n", 399 | " \n", 400 | " # add a rule mark to serve as a guide line\n", 401 | " alt.Chart().mark_rule(color='#aaa').encode(\n", 402 | " x='date:T'\n", 403 | " ).transform_filter(label),\n", 404 | " \n", 405 | " # add circle marks for selected time points, hide unselected points\n", 406 | " base.mark_circle().encode(\n", 407 | " opacity=alt.condition(label, alt.value(1), alt.value(0))\n", 408 | " ).add_selection(label),\n", 409 | "\n", 410 | " # add white stroked text to provide a legible background for labels\n", 411 | " base.mark_text(align='left', dx=5, dy=-5, stroke='white', strokeWidth=2).encode(\n", 412 | " text='price:Q'\n", 413 | " ).transform_filter(label),\n", 414 | "\n", 415 | " # add text labels for stock prices\n", 416 | " base.mark_text(align='left', dx=5, dy=-5).encode(\n", 417 | " text='price:Q'\n", 418 | " ).transform_filter(label),\n", 419 | " \n", 420 | " data=stocks\n", 421 | ").properties(\n", 422 | " width=700,\n", 423 | " height=400\n", 424 | ")" 425 | ] 426 | }, 427 | { 428 | "cell_type": "markdown", 429 | "metadata": {}, 430 | "source": [ 431 | "## Data Tables\n", 432 | "\n", 433 | "You can display tables per the usual way in your blog:" 434 | ] 435 | }, 436 | { 437 | "cell_type": "code", 438 | "execution_count": 18, 439 | "metadata": {}, 440 | "outputs": [ 441 | { 442 | "data": { 443 | "text/html": [ 444 | "

\n", 445 | "\n", 458 | "\n", 459 | " \n", 460 | " \n", 461 | " \n", 462 | " \n", 463 | " \n", 464 | " \n", 465 | " \n", 466 | " \n", 467 | " \n", 468 | " \n", 469 | " \n", 470 | " \n", 471 | " \n", 472 | " \n", 473 | " \n", 474 | " \n", 475 | " \n", 476 | " \n", 477 | " \n", 478 | " \n", 479 | " \n", 480 | " \n", 481 | " \n", 482 | " \n", 483 | " \n", 484 | " \n", 485 | " \n", 486 | " \n", 487 | " \n", 488 | " \n", 489 | " \n", 490 | " \n", 491 | " \n", 492 | " \n", 493 | " \n", 494 | " \n", 495 | " \n", 496 | " \n", 497 | " \n", 498 | " \n", 499 | " \n", 500 | " \n", 501 | " \n", 502 | " \n", 503 | " \n", 504 | " \n", 505 | "

	Title	Worldwide_Gross	Production_Budget	IMDB_Rating
0	The Land Girls	146083.0	8000000.0	6.1
1	First Love, Last Rites	10876.0	300000.0	6.9
2	I Married a Strange Person	203134.0	250000.0	6.8
3	Let's Talk About Sex	373615.0	300000.0	NaN
4	Slam	1087521.0	1000000.0	3.4

\n", 506 | "

" 507 | ], 508 | "text/plain": [ 509 | " Title Worldwide_Gross Production_Budget IMDB_Rating\n", 510 | "0 The Land Girls 146083.0 8000000.0 6.1\n", 511 | "1 First Love, Last Rites 10876.0 300000.0 6.9\n", 512 | "2 I Married a Strange Person 203134.0 250000.0 6.8\n", 513 | "3 Let's Talk About Sex 373615.0 300000.0 NaN\n", 514 | "4 Slam 1087521.0 1000000.0 3.4" 515 | ] 516 | }, 517 | "execution_count": 18, 518 | "metadata": {}, 519 | "output_type": "execute_result" 520 | } 521 | ], 522 | "source": [ 523 | "movies = 'https://vega.github.io/vega-datasets/data/movies.json'\n", 524 | "df = pd.read_json(movies)\n", 525 | "# display table with pandas\n", 526 | "df[['Title', 'Worldwide_Gross', \n", 527 | " 'Production_Budget', 'IMDB_Rating']].head()" 528 | ] 529 | }, 530 | { 531 | "cell_type": "markdown", 532 | "metadata": {}, 533 | "source": [ 534 | "## Images\n", 535 | "\n", 536 | "### Local Images\n", 537 | "\n", 538 | "You can reference local images and they will be copied and rendered on your blog automatically. You can include these with the following markdown syntax:\n", 539 | "\n", 540 | "`![](my_icons/fastai_logo.png)`" 541 | ] 542 | }, 543 | { 544 | "cell_type": "markdown", 545 | "metadata": {}, 546 | "source": [ 547 | "![](my_icons/fastai_logo.png)" 548 | ] 549 | }, 550 | { 551 | "cell_type": "markdown", 552 | "metadata": {}, 553 | "source": [ 554 | "### Remote Images\n", 555 | "\n", 556 | "Remote images can be included with the following markdown syntax:\n", 557 | "\n", 558 | "`![](https://image.flaticon.com/icons/svg/36/36686.svg)`" 559 | ] 560 | }, 561 | { 562 | "cell_type": "markdown", 563 | "metadata": {}, 564 | "source": [ 565 | "![](https://image.flaticon.com/icons/svg/36/36686.svg)" 566 | ] 567 | }, 568 | { 569 | "cell_type": "markdown", 570 | "metadata": {}, 571 | "source": [ 572 | "### Animated Gifs\n", 573 | "\n", 574 | "Animated Gifs work, too!\n", 575 | "\n", 576 | "`![](https://upload.wikimedia.org/wikipedia/commons/7/71/ChessPawnSpecialMoves.gif)`" 577 | ] 578 | }, 579 | { 580 | "cell_type": "markdown", 581 | "metadata": {}, 582 | "source": [ 583 | "![](https://upload.wikimedia.org/wikipedia/commons/7/71/ChessPawnSpecialMoves.gif)" 584 | ] 585 | }, 586 | { 587 | "cell_type": "markdown", 588 | "metadata": {}, 589 | "source": [ 590 | "### Captions\n", 591 | "\n", 592 | "You can include captions with markdown images like this:\n", 593 | "\n", 594 | "```\n", 595 | "![](https://www.fast.ai/images/fastai_paper/show_batch.png \"Credit: https://www.fast.ai/2020/02/13/fastai-A-Layered-API-for-Deep-Learning/\")\n", 596 | "```\n", 597 | "\n", 598 | "\n", 599 | "![](https://www.fast.ai/images/fastai_paper/show_batch.png \"Credit: https://www.fast.ai/2020/02/13/fastai-A-Layered-API-for-Deep-Learning/\")\n", 600 | "\n", 601 | "\n", 602 | "\n" 603 | ] 604 | }, 605 | { 606 | "cell_type": "markdown", 607 | "metadata": {}, 608 | "source": [ 609 | "# Other Elements" 610 | ] 611 | }, 612 | { 613 | "cell_type": "markdown", 614 | "metadata": {}, 615 | "source": [ 616 | "## Tweetcards\n", 617 | "\n", 618 | "Typing `> twitter: https://twitter.com/jakevdp/status/1204765621767901185?s=20` will render this:\n", 619 | "\n", 620 | "> twitter: https://twitter.com/jakevdp/status/1204765621767901185?s=20" 621 | ] 622 | }, 623 | { 624 | "cell_type": "markdown", 625 | "metadata": {}, 626 | "source": [ 627 | "## Youtube Videos\n", 628 | "\n", 629 | "Typing `> youtube: https://youtu.be/XfoYk_Z5AkI` will render this:\n", 630 | "\n", 631 | "\n", 632 | "> youtube: https://youtu.be/XfoYk_Z5AkI" 633 | ] 634 | }, 635 | { 636 | "cell_type": "markdown", 637 | "metadata": {}, 638 | "source": [ 639 | "## Boxes / Callouts \n", 640 | "\n", 641 | "Typing `> Warning: There will be no second warning!` will render this:\n", 642 | "\n", 643 | "\n", 644 | "> Warning: There will be no second warning!\n", 645 | "\n", 646 | "\n", 647 | "\n", 648 | "Typing `> Important: Pay attention! It's important.` will render this:\n", 649 | "\n", 650 | "> Important: Pay attention! It's important.\n", 651 | "\n", 652 | "\n", 653 | "\n", 654 | "Typing `> Tip: This is my tip.` will render this:\n", 655 | "\n", 656 | "> Tip: This is my tip.\n", 657 | "\n", 658 | "\n", 659 | "\n", 660 | "Typing `> Note: Take note of this.` will render this:\n", 661 | "\n", 662 | "> Note: Take note of this.\n", 663 | "\n", 664 | "\n", 665 | "\n", 666 | "Typing `> Note: A doc link to [an example website: fast.ai](https://www.fast.ai/) should also work fine.` will render in the docs:\n", 667 | "\n", 668 | "> Note: A doc link to [an example website: fast.ai](https://www.fast.ai/) should also work fine." 669 | ] 670 | } 671 | ], 672 | "metadata": { 673 | "kernelspec": { 674 | "display_name": "visualization-curriculum-gF8wUgMm", 675 | "language": "python", 676 | "name": "visualization-curriculum-gf8wugmm" 677 | }, 678 | "language_info": { 679 | "codemirror_mode": { 680 | "name": "ipython", 681 | "version": 3 682 | }, 683 | "file_extension": ".py", 684 | "mimetype": "text/x-python", 685 | "name": "python", 686 | "nbconvert_exporter": "python", 687 | "pygments_lexer": "ipython3", 688 | "version": "3.6.7" 689 | } 690 | }, 691 | "nbformat": 4, 692 | "nbformat_minor": 4 693 | } 694 | --------------------------------------------------------------------------------

Warning

2 | 3 | {{ post.title | escape }} 4 | 5 |

404

9 | 10 | {{ post.title | escape }} 11 | 12 |

Contents

{{ category_name }}

{{ page.title }}

{{ page.list_title }}

{{ page.title | escape }}