Skip to content

Commit bf3fa3b

Browse files
committed
Updated README
1 parent 1579935 commit bf3fa3b

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ The wiki has the following file structure:
2020

2121
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.
2222

23+
Web server
24+
----------
25+
2326
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:
2427

2528
| URL | Page |
@@ -46,6 +49,10 @@ Since Markdown files are plain text, the wiki is easily searchable. A `grep` com
4649

4750
grep -Ri --exclude-dir="node_modules" --exclude-dir="resources" --include="*.md" "markdown" .
4851

52+
A shorthand for the above is `npm run grep`. Thus, to search for `markdown`:
53+
54+
npm run grep markdown
55+
4956
Editing
5057
-------
5158

@@ -69,7 +76,7 @@ author: Page author
6976
This is a page written in **Markdown**.
7077
```
7178

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.
7380

7481
Styling
7582
-------
@@ -130,7 +137,7 @@ Then one can reference them with a Markdown link:
130137
[PDF document](document.pdf)
131138
```
132139

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.
134141

135142
Future compatibility
136143
--------------------

package.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,7 @@
4141
"pull": "git --no-pager status && git pull --rebase",
4242
"compress": "git gc",
4343
"compress!": "git gc --prune=now",
44-
"sync": "npm run push && npm run rsync",
45-
"sync!": "npm run push! && npm run rsync!",
46-
"rsync": "rsync -av --delete --progress --modify-window=2 --exclude '.git' --exclude 'node_modules' . vegardye@ananke.feralhosting.com:www/vegardye.ananke.feralhosting.com/public_html/wiki",
47-
"rsync!": "rsync -av --delete --progress . vegardye@ananke.feralhosting.com:www/vegardye.ananke.feralhosting.com/public_html/wiki",
44+
"grep": "grep -Ri --exclude-dir=\"node_modules\" --exclude-dir=\"resources\" --include=\"*.md\"",
4845
"docx": "for f in **/index.txt; do (cd \"${f%index.txt}\" && pwd && pandoc -S -f markdown -t docx -o \"index.docx\" \"index.txt\"); done",
4946
"log": "git log -p",
5047
"gitk": "gitk &",

0 commit comments

Comments
 (0)