Skip to content

Commit 6e8a273

Browse files
Updated README.md
1 parent d4362bd commit 6e8a273

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

+26
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,29 @@ To run the website locally, use:
99
```bash
1010
npm run dev
1111
```
12+
13+
## Things To Keep in Mind While Writing the Blog
14+
15+
1. Always use the Obsidian format. If you have installed any plugins that support Obsidian, it may break.
16+
17+
> [!WARNING]
18+
> Do not install any plugins in the Obsidian Vault.
19+
20+
2. When writing a code block, make sure to include the title and language in the following format:
21+
22+
```
23+
csharp title="Welcome.cs"
24+
```
25+
26+
3. Always include the following frontmatter at the top of every blog:
27+
28+
```yaml
29+
---
30+
title: title of the blog
31+
tags:
32+
- tags
33+
created: 2025-02-18 // creating date
34+
---
35+
```
36+
37+
4. If you paste any images into Obsidian, make sure to move the image into the `images` folder located in the `content` folder.

0 commit comments

Comments
 (0)