Skip to content

Commit

Permalink
include intro of blog
Browse files Browse the repository at this point in the history
  • Loading branch information
SaranjeetKaur committed Aug 12, 2024
1 parent 819b36a commit def6fd3
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This repository contains blogs by the [central RSE team](https://www.imperial.ac

- Create a `.md` file for your blog in the `docs/posts` folder and add the blog content to it.
- Any images should be added to `docs/posts/images/<blog-name>`.
- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`):
- Add all the relevant metadata (for example, `date`, `authors`, `categories`, `tags`) at the start of the blog:

```zsh
---
Expand All @@ -32,11 +32,15 @@ tags:
- tag_b
- tag_c
---

# Blog title

Introduction paragraph for the blog.

```

Note: If authors are not already listed in `docs/.authors.yml`, please add them. Similarly, any mew `categories` should be listed under `categories_allowed` in `mkdocs.yml`.

- Add any new authors to `docs/.authors.yml`.
- After the introduction paragraph of the blog, include `<!-- more -->`. This will render a shorter version of the blog on the landing page with a `Continue reading...` link.
- After the introduction paragraph of the blog, include `<!-- more -->`. This will render a shorter version of the blog on the landing page with a `Continue reading` link.
- Preview the blog locally using `mkdocs serve`.
- Open a `Pull Request` and request for a review.

0 comments on commit def6fd3

Please sign in to comment.