You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Wrap inline math text with code blocks](#wrap-inline-math-text-with-code-blocks)
28
+
-[Wrap math blocks with code fences](#wrap-math-blocks-with-code-fences)
29
+
-[Front-matter](#front-matter)
30
+
-[External modules](#external-modules)
31
+
-[Solving Common problems](#solving-common-problems)
32
+
-[References](#references)
31
33
32
34
## Install
33
35
@@ -68,6 +70,8 @@ You can split out sub-sections by adding additional pages to a section directory
68
70
69
71
The markdown documents should all be well formed, with a single h1, and headings should increment by a single level.
70
72
73
+
> Note: Regular markdown files like `content/intro/concepts.md` can't reference resources such as images, or other files. Such resources can be referenced only from `_index.md` files. Given that a folder will have an `_index.md` file already, there is the following work around to reference resources from any file: create a new sub-folder in the same folder where the initial .md file was, e.g., `content/intro/concepts/_index.md`, include the content from `concepts.md` in the `_index.md` file, add the resource files (for example, images) in the new folder and reference the resource file from the new `_index.md` file inside the `concepts` folder. The referencing syntax and everything else works the same way.
74
+
71
75
## Check your markdown
72
76
73
77
Use `npm test` to run a markdown linter set up to check for common errors. It runs in CI and you can run it locally with:
0 commit comments