mirror of
https://github.com/journeyman-cc/smeagol.git
synced 2026-04-12 18:05:06 +00:00
Initial commit, not yet complete.
This commit is contained in:
parent
53885f696d
commit
d437f07fc2
33 changed files with 884 additions and 3 deletions
21
resources/public/content/Introduction.md
Normal file
21
resources/public/content/Introduction.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Welcome to Smeagol!
|
||||
|
||||
Smeagol is a simple Wiki engine inspired by [Gollum](https://github.com/gollum/gollum/wiki). Gollum is a Wiki engine written in Ruby, which uses a number of simple text formats including [Markdown](http://daringfireball.net/projects/markdown/), which uses [Git](http://git-scm.com/) to provide versioning and backup. I needed a new Wiki for a project and thought Gollum would be ideal - but unfortunately it doesn't provide user authentication, which I needed, and it was simpler for me to reimplement the bits I did need in Clojure than to modify Gollum.
|
||||
|
||||
So at this stage Smeagol is a Wiki engine written in Clojure which uses Markdown as its text format, which does have user authentication, and which will soon use Git as its versioning and backup system.
|
||||
|
||||
## Markup syntax
|
||||
|
||||
Smeagol uses the Markdown format as provided by [markdown-clj](https://github.com/yogthos/markdown-clj), with the addition that anything enclosed in double square brackets, \[\[like this\]\], will be treated as a link into the wiki.
|
||||
|
||||
## Security and authentication
|
||||
|
||||
Not done yet.
|
||||
|
||||
## Todo
|
||||
|
||||
Git integration!
|
||||
|
||||
## Editing the framing content
|
||||
|
||||
You can edit the [[\_left-bar]], the [[\_edit-left-bar]], and the [[\_header]].
|
||||
13
resources/public/content/_edit-left-bar.md
Normal file
13
resources/public/content/_edit-left-bar.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
####Formatting hints
|
||||
+ \# Main heading
|
||||
+ \#\# Second level heading
|
||||
+ \#\#\# Third level heading
|
||||
+ \[\[Link within this wiki\]\]
|
||||
+ \[Link outside this wiki\] \(http://url.goes.here/\)
|
||||
+ \!\[image alt text\]\(http://url.of.image\)
|
||||
+ \+ (at start of line) ordinary bulleted lists
|
||||
+ \1\. (at start of line) numbered lists
|
||||
+ \**bold*\*
|
||||
+ \__italic_\_
|
||||
|
||||
More documentation [here](http://daringfireball.net/projects/markdown/syntax)
|
||||
1
resources/public/content/_header.md
Normal file
1
resources/public/content/_header.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
This is the header. There isn't yet much in it. You could [edit](edit?content=_header) it to provide internal navigation or branding.
|
||||
1
resources/public/content/_left-bar.md
Normal file
1
resources/public/content/_left-bar.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
This is the left bar. There's nothing in it yet. You could [edit](edit?content=_left-bar) it to provide internal navigation or branding.
|
||||
Loading…
Add table
Add a link
Reference in a new issue