nbdev icon indicating copy to clipboard operation
nbdev copied to clipboard

Fastpages style blog page

Open Isaac-Flath opened this issue 2 years ago • 3 comments

My understanding is that nbprocess is going to be nbdev2, but that it will also replace fastpages. This issue is relating to the fastpages/blogging style projects.

Is there a built in way to create the main page of the blog that lists blog posts?

For example:

  • Fastpages creates this page automatically from the notebooks front matter: https://isaac-flath.github.io/fastblog/
  • Quarto default blog creates this page automatically from notebooks front matter: https://isaac-flath.github.io/APL-Exploration/

I think something like this is important for a blog so that people can see an order list of posts, with dates and description of post content.

Isaac-Flath avatar Jul 19 '22 15:07 Isaac-Flath

Yeah we will have to write documentation on how to do this. Its pretty straightforward but you have to change several settings, and maybe change something in nbprocess if nbprocess is making too many assumptions (but need to test this)

https://quarto.org/docs/websites/website-blog.html

hamelsmu avatar Jul 20 '22 04:07 hamelsmu

Notes On Converting Fastpages To Quarto

General

Fixing URLs : https://quarto.org/docs/websites/website-navigation.html#redirects These tables are from this spreadsheet

Listing Level Front Matter

Jekyll Front Matter Quarto Notes
toc: false Same There are more options in Quartohttps://quarto.org/docs/reference/formats/pdf.html#table-of-contents
branch: master n/a Will not support this initially
badges: true n/a Will not support this initially
comments: true comments: hypothesis: theme: clean https://quarto.org/docs/output-formats/html-basics.html#commenting
categories: [fastpages, jupyter] Same You need to turn categories on at the listing level---title: "myblog"listing: # (additional metadata excluded for brevity) categories: true---
image: images/some_folder/your_image.png Same https://quarto.org/docs/websites/website-listings.html#listing-fields
hide: false draft: true https://quarto.org/docs/websites/website-blog.html#drafts
search_exclude: true ---title: "My Document"search: false--- https://quarto.org/docs/websites/website-search.html#disabling-search
title Same  
description Same  
sticky_rank n/a Not supportedhttps://quarto.org/docs/websites/website-listings.html#sorting-items

Site Level Options

Jekyll site config Quarto Notes
title website: title:  
description website: description:  
github_username  n/a Don't need this  
github_repo website: repo-url: https://github.com/fastai/nbdev  
url n/a Don't need this
baseurl n/a Don't need this
email n/a Don't need this
twitter_username website: navbar: right: - icon: twitter href: https://twitter.com/fastdotai aria-label: Fast.ai Twitter https://quarto.org/docs/websites/website-navigation.html#top-navigation
use_math   https://quarto.org/docs/output-formats/html-basics.html#latex-equations
google_analytics website: google-analytics: "UA-XXXXXXXX" https://quarto.org/docs/websites/website-tools.html#google-analytics
show_image n/a https://quarto.org/docs/reference/formats/html.html#layout
show_tags title-block-categories https://quarto.org/docs/reference/formats/html.html#layout
pagination website: page-navigation: true https://quarto.org/docs/websites/website-navigation.html#page-navigation
annotations comments: hypothesis: theme: clean https://quarto.org/docs/output-formats/html-basics.html#commenting

hamelsmu avatar Aug 03 '22 07:08 hamelsmu

Note I should turn on utterances for people by default

----
comments:
  utterances:
    repo: quarto-dev/quarto-docs
---

https://quarto.org/docs/output-formats/html-basics.html#commenting

hamelsmu avatar Aug 03 '22 07:08 hamelsmu