From 3588d1a5f83bf83ef4e94114a6540c9223f8607f Mon Sep 17 00:00:00 2001 From: jdebacker Date: Tue, 5 Mar 2024 22:12:38 -0500 Subject: [PATCH] update instructions in readme --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c51bef5..cb3c724 100755 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ [//]: # (This template replaces README.md when someone creates a new repo with the fastpages template.) -![](https://github.com/PSLmodels/blog/workflows/CI/badge.svg) -![](https://github.com/PSLmodels/blog/workflows/GH-Pages%20Status/badge.svg) -[![](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) +![](https://github.com/PSLmodels/blog/workflows/CI/badge.svg) +![](https://github.com/PSLmodels/blog/workflows/GH-Pages%20Status/badge.svg) # [PSL blog](https://blog.pslmodels.org) -_powered by [fastpages](https://github.com/fastai/fastpages)_ +_powered by [Quarto](https://quarto.org)_ ## How to contribute @@ -19,12 +18,12 @@ The `PSL blog` accepts posts as Jupyter notebooks or Markdown documents: * To submit a Markdown post, create a PR with your `YYYY-MM-DD-post-title.md` file in the `_posts` folder. In both cases, please take the following steps: -1. Follow the Fastpages guides on writing blogs with [Jupyter](https://github.com/fastai/fastpages#writing-blog-posts-with-jupyter) and [Markdown](https://github.com/fastai/fastpages#writing-blog-posts-with-markdown), and include the required "front matter" with metadata. -2. [Preview the blog locally](_fastpages_docs/DEVELOPMENT.md) using the `make server` command from the root directory after drafting your post. -You'll need [Docker](https://docs.docker.com/get-docker/) installed on your machine to run the command. -3. Include a screenshot of the blog post in your PR. +1. Follow the nbdev guides on writing blogs with R Mardown (`*.qmd`), Jupyter (`*.ipynb`), and Markdown (`*.md`), and include the required "front matter" with metadata (you can the template from past posts). +2. [Preview the blog locally](_fastpages_docs/DEVELOPMENT.md) using the `quarto preview` command from the root directory after drafting your post. +You'll need [Quarto](https://quarto.org/docs/get-started/) installed on your machine to run the command. +1. Include a screenshot of the blog post in your PR. -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. +Please use the [Quarto discussions](https://github.com/quarto-dev/quarto-cli/discussions) on Github for questions about using Quarto. ## Technical guide