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
Copy file name to clipboardExpand all lines: README.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,9 @@ The wiki has the following file structure:
20
20
21
21
Every page has its own folder, and folders can be arbitrarily nested. The page's contents are stored in a Markdown file named `index.md`. There is also an associated `index.html` file, which uses a bit of JavaScript to dynamically render the Markdown as HTML when viewed in a browser.
22
22
23
+
Web server
24
+
----------
25
+
23
26
One of several benefits of the above file structure is that the whole wiki can be served by a web server, and every wiki page gets its own URL. If the wiki is uploaded to the server's root directory (any directory will do), the addresses become:
24
27
25
28
| URL | Page |
@@ -46,6 +49,10 @@ Since Markdown files are plain text, the wiki is easily searchable. A `grep` com
A shorthand for the above is `npm run grep`. Thus, to search for `markdown`:
53
+
54
+
npm run grep markdown
55
+
49
56
Editing
50
57
-------
51
58
@@ -69,7 +76,7 @@ author: Page author
69
76
This is a page written in **Markdown**.
70
77
```
71
78
72
-
The wiki uses [markdown-it](https://www.npmjs.com/package/markdown-it) for its Markdown parser, which is customizable with extensions.
79
+
The wiki uses [markdown-it](https://www.npmjs.com/package/markdown-it) for its Markdown parser, which is customizable with extensions. Thus, the wiki can accommodate a number of extensions to plain Markdown syntax, such as [MathJax](https://www.npmjs.com/package/markdown-it-mathjax) markup.
73
80
74
81
Styling
75
82
-------
@@ -130,7 +137,7 @@ Then one can reference them with a Markdown link:
130
137
[PDF document](document.pdf)
131
138
```
132
139
133
-
Thus, the wiki can serve as a repository not only for Markdown documents, but for any kind of file that is related to the page's subject.
140
+
Thus, the wiki can serve as a repository not only for Markdown documents, but for any kind of file that is related to the subject.
0 commit comments