aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/pages/templates
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/pages/templates')
-rw-r--r--docs/dev/pages/templates/.name1
-rw-r--r--docs/dev/pages/templates/doc.md28
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/dev/pages/templates/.name b/docs/dev/pages/templates/.name
new file mode 100644
index 0000000..1e1408c
--- /dev/null
+++ b/docs/dev/pages/templates/.name
@@ -0,0 +1 @@
+Templates
diff --git a/docs/dev/pages/templates/doc.md b/docs/dev/pages/templates/doc.md
new file mode 100644
index 0000000..e8a9308
--- /dev/null
+++ b/docs/dev/pages/templates/doc.md
@@ -0,0 +1,28 @@
+<h1 align="center">Helpdoc Template</h1>
+<p align="center">
+ A template for writing documentation
+</p>
+
+When writing a Helpdoc, you can use the following template to draft
+
+```markdown
+<h1 align="center">Title</h1>
+<p align="center">
+ Description
+</p>
+
+Content here
+
+<!-- To display playable code if needed -->
+<!--<iframe
+ src="../play/play.html?tur=default.md&amp;title=Title"
+ height="600px"/>-->
+
+<p align="center" style="font-size: 0.85em; color: gray;">
+ Written by @Your-Name
+</p>
+```
+
+<p align="center" style="font-size: 0.85em; color: gray;">
+ Written by @Weicao-CatilGrass
+</p>