Skip to content

Commit

Permalink
Merge pull request #425 from dakk/main
Browse files Browse the repository at this point in the history
Update README.md with tags and code-blocks
  • Loading branch information
nathanshammah authored Jan 3, 2024
2 parents d74658b + 81fa67f commit 206f4d3
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ This will be rendered as:
To add a blog post, create a new markdown file (`YYYY_your_title.md`) in the `src/content/blog/` directory.
The following template post can be used to start from scratch, or check out one of the existing blog posts ([markdown example](src/content/blog/2023_members.md), [live render](https://unitary.fund/posts/2023_members/)).

```
````
---
title: post title
author: author one and author two
day: 7
month: 2
year: 2023
tags:
- python
- simulator
- qiskit
---
# This is a heading style one
Expand All @@ -54,16 +58,26 @@ https://www.youtube.com/watch?v=dB_3R84ewig
#### This is a heading in heading style four
## Including code snippets with gists
## Including code snippets
### With gists
A supported way to include code snippets is by embedding gists.
Gists are code snippets that you can create on Github.
Learn how to create one [here](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists), and don't forget to ensure it is public!
Once created, use the hash from the gist URL with the syntax below.
::gist[matt-lourens/6cc14d37209de07abd707804f1b0219e/]
### With code blocks
Another way is to use markdown code-blocks' like the following example:
```python
def hello():
print('hello world!')
```
````

Once your post is ready, open a pull request (PR)!

The Vercel automation will create a preview you can access by clicking the "Visit preview" link that shows up in the bot comment.
Expand Down

0 comments on commit 206f4d3

Please sign in to comment.