simon/smeagol
1
0
Fork 0
mirror of https://github.com/journeyman-cc/smeagol.git synced 2026-04-12 18:05:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

spelling & format fixes for README

Browse source
This commit is contained in:
jem 2018-05-25 17:19:33 +02:00
parent 7b284eb13f
commit 7e5b3d74da
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -99,14 +99,15 @@ You can (if you're logged in) upload files, including images, using the **Upload
![Smeagol](http://vignette3.wikia.nocookie.net/lotr/images/e/e1/Gollum_Render.png/revision/latest?cb=20141218075509)
## Includes
You can include pages into the current page youre working on. To do so, you can add a include link:
You can include pages into the current page you're working on. To do so, you can add a include link:
`&[:indent-heading s/Num :indent-list s/Num](relative or absolute uri s/Str)`
Parameters semantics:
* uri: The page to include. At the moment only pages of the current wiki are allowed. A page called "PageToBeIncluded" will result in a uri "PageToBeIncluded.md".
* uri: The page to include. At the moment only pages from the current wiki are allowed. A page called "PageToBeIncluded" will result in a uri "PageToBeIncluded.md".
* indent-heading: You can indent headings of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported.
* indent-list: In Same manner you can indent lists of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported.
Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki.
## Advertisement