aboutsummaryrefslogtreecommitdiff
path: root/apps/docs/essentials/code.mdx
diff options
context:
space:
mode:
authorDhravya Shah <[email protected]>2025-01-30 18:46:37 -0700
committerDhravya Shah <[email protected]>2025-01-30 18:46:37 -0700
commit81529a9791b2badf539e837cbba6e7e7e9cf64b9 (patch)
tree980a17bf6dfc0689bbe50789f4d69a789be0797a /apps/docs/essentials/code.mdx
parentdocs without submodule (diff)
downloadsupermemory-81529a9791b2badf539e837cbba6e7e7e9cf64b9.tar.xz
supermemory-81529a9791b2badf539e837cbba6e7e7e9cf64b9.zip
docs no submodule
Diffstat (limited to 'apps/docs/essentials/code.mdx')
m---------apps/docs0
-rw-r--r--apps/docs/essentials/code.mdx37
2 files changed, 37 insertions, 0 deletions
diff --git a/apps/docs b/apps/docs
deleted file mode 160000
-Subproject cc9c512a12fe23a349c990076b5a97c46a189e4
diff --git a/apps/docs/essentials/code.mdx b/apps/docs/essentials/code.mdx
new file mode 100644
index 00000000..d2a462a7
--- /dev/null
+++ b/apps/docs/essentials/code.mdx
@@ -0,0 +1,37 @@
+---
+title: 'Code Blocks'
+description: 'Display inline code and code blocks'
+icon: 'code'
+---
+
+## Basic
+
+### Inline Code
+
+To denote a `word` or `phrase` as code, enclose it in backticks (`).
+
+```
+To denote a `word` or `phrase` as code, enclose it in backticks (`).
+```
+
+### Code Block
+
+Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.
+
+```java HelloWorld.java
+class HelloWorld {
+ public static void main(String[] args) {
+ System.out.println("Hello, World!");
+ }
+}
+```
+
+````md
+```java HelloWorld.java
+class HelloWorld {
+ public static void main(String[] args) {
+ System.out.println("Hello, World!");
+ }
+}
+```
+````