Skip to content

Commit 6e2ad92

Browse files
Updated readme with formatting notes
1 parent 524bc56 commit 6e2ad92

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,36 @@ To use the code splitter:
7272

7373
> 💡 ***Note*** the extra space after the opening `<template>` and before the closing `</template>`. This is necessary for the VitePress pre-processor.
7474
75+
In some cases, you may only need to write code for either JS/TS or C#. In these cases, just use normal markdown code fences.
76+
77+
For callouts:
78+
79+
```
80+
::: info
81+
This is an info box.
82+
:::
83+
84+
::: tip
85+
This is a tip.
86+
:::
87+
88+
::: warning
89+
This is a warning.
90+
:::
91+
92+
::: danger
93+
This is a dangerous warning.
94+
:::
95+
96+
::: details
97+
This is a details block.
98+
:::
99+
```
100+
75101
## Guidelines
76102

77-
- Focus on educating; you don't have to be able to fill in both sides (C# and JS); you can fill in one side and leave the other "WIP"
103+
- Focus on educating; you don't have to be able to fill in both sides (C# and JS); you can fill in one side and leave the other "WIP".
78104
- Write clear, concise, and easy to follow examples
79-
- Try to distill the examples down to the simplest use case that demonstrates the idea
80-
- Use [VitePress markdown extensions](https://vitepress.dev/guide/markdown) where appropriate including code line highlighting
105+
- Try to distill the examples down to the simplest use case that demonstrates the core of the idea; complex examples can be hard to grasp (but are sometimes unavoidable).
106+
- Use [VitePress markdown extensions](https://vitepress.dev/guide/markdown) where appropriate including code line highlighting.
107+
- When relevant, add links to documentation to interested readers can follow up and learn more!

0 commit comments

Comments
 (0)