mirror/php-slim-wiki
1
0
Fork 0
mirror of https://github.com/til-schneider/slim-wiki.git synced 2025-01-29 09:57:48 +01:00
Code Issues Releases Wiki Activity

Improved sample pages

Browse Source
This commit is contained in:
til-schneider 2016-02-02 16:13:12 +01:00
parent 2ca0179692
commit 324dec1bf9
2 changed files with 180 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

162
src/articles/cheat_sheets/Markdown_cheat_sheet.md
View File

@ -1,33 +1,96 @@
Markdown cheat sheet
====================
Headlines
---------
Create headlines using hashes. Hashes on right are optional.
~~~ markdown
# Header 1 #
## Header 2 ##
### Header 3 (Hashes on right are optional)
### Header 3
#### Header 4
##### Header 5
###### Header 6
~~~
You can also underline your headline with equals (`===`) for level 1 or minus (`---`) for level 2.
~~~ markdown
Header 1
========
Header 2
--------
~~~
Alternative Header 1
====================
Paragraphs
----------
A paragraph is simply one or more lines of text,
separated by blank lines.
Text with
two trailing spaces
(on the right)
can be used
for things like poems.
Inline markup like _italics_, **bold**, ~~strike through~~ and `code()`:
~~~ markdown
_italics_, **bold**, ~~strike through~~ and `code()`
~~~
Want to mark something in your article to fix later? Add a yellow TODO or FIXME marker:
~~~markdown
Simply write TODO or FIXME.
~~~
Alternative Header 2
--------------------
Links
-----
A simple Link: http://google.de
This is a paragraph, which is text surrounded by whitespace. Paragraphs can be on one
line (or many), and can drone on for hours.
This is [a named link](http://google.de).
Use [a relative link](cheat_sheets) for pointing to another wiki page.
Here is a Markdown link to [a named link](http://google.de).
Now some inline markup like _italics_, **bold**, ~~strike through~~ and `code()`. Note that underscores_in_words are ignored in [GitHub flavored](https://help.github.com/articles/github-flavored-markdown) Markdown.
~~~ markdown
A simple Link: http://google.de
![picture alt](http://nuclearpixel.com/content/icons/2010-02-09_stellar_icons_from_space_from_2005/earth_128.png "Title is optional")
This is [a named link](http://google.de).
Use [a relative link](cheat_sheets) for pointing to another wiki page.
~~~
Want to mark something in your article to fix later? Write FIXME. This will create a yellow fixme marker.
Images
------
Embed an image:
![Alt text](http://nuclearpixel.com/content/icons/2010-02-09_stellar_icons_from_space_from_2005/earth_128.png "Title is optional")
~~~ markdown
![Alt text](http://example.com/myimage.jpg "Title is optional")
~~~
Blockquotes and lists
---------------------
> Blockquotes are like quoted text in email replies
>> And, they can be nested
>> And they can be nested
~~~ markdown
> Blockquotes are like quoted text in email replies
>> And they can be nested
~~~
Bullet lists:
@ -35,58 +98,93 @@ Bullet lists:
- Another one
+ Another one
~~~ markdown
* Bullet lists are easy too
- Another one
+ Another one
~~~
Numbered lists:
1. A numbered list
2. Which is numbered
3. With periods and a space
And now some code:
~~~ markdown
1. A numbered list
2. Which is numbered
3. With periods and a space
~~~
Code snippets
-------------
Create a simple code block by intending the text using 4 or more spaces:
~~~
// Code is just text indented a bit
which(isEasy) toRemember();
~~~
// Un-indented code blocks work too
if (thisIsMoreCode == true && !indented) {
// tild wrapped code blocks, also not indented
}
~~~
Backticks and language selection for syntax highlighting work too:
You can also create a code block using `~~~` or <code>```</code>. If you set a language (e.g. `~~~ xml`), your code will be shown using syntax highlighting:
```xml
~~~ xml
<?xml version="1.0" encoding="UTF-8"?>
<root>
<some-tag with="argument">And text</some-tag>
</root>
```
~~~
Text with
two trailing spaces
(on the right)
can be used
for things like poems
~~~ xml
<?xml version="1.0" encoding="UTF-8"?>
<root>
<some-tag with="argument">And text</some-tag>
</root>
~~~
### Horizontal rules
Here is a [list of supported languages](http://prismjs.com/#languages-list).
Horizontal rules
----------------
~~~ markdown
* * * *
****
--------------------------
~~~
### Embedded HTML
Embedded HTML
-------------
<div style="font-size: 20px; color:green; text-shadow: 4px 4px 2px rgba(0, 0, 0, 0.3);">
This is <b>embedded HTML</b>
You can also <b>embed HTML</b>.
</div>
### Tables
~~~ markdown
Just write it:
<div style="color: green">This is embedded HTML</div>
~~~
Tables
------
| Header | Center | Right |
| ------ | :----: | -----: |
| Cell | Cell | $10 |
| Cell | Cell | $20 |
~~~ markdown
| Header | Header | Right |
| ------ | ------ | -----: |
| Cell | Cell | $10 |
| Cell | Cell | $20 |
~~~
* Outer pipes on tables are optional
* Colon used for alignment (right versus left)

58
src/articles/index.md
View File

@ -1,15 +1,57 @@
Example Wiki
============
Welcome to your wiki!
=====================
Place the content of your *slim wiki* into this directory. Write it using
[GitHub flavored](https://help.github.com/articles/github-flavored-markdown) [Markdown](https://daringfireball.net/projects/markdown/).
Slim wiki is a fast and slim wiki based on PHP and Markdown.
Use the main page as overview and add links to subpages:
- Write your pages in [GitHub-flavored Markdown](cheat_sheets/Markdown_cheat_sheet) - no fancy wiki syntax no one can remember, instead pretty text written in a widely used standard.
- Syntax highlighting support for [a ton of languages](http://prismjs.com/#languages-list).
- No database required - everything is file-based.
- Beautiful styling.
- Edit your pages with a single click in a great editor - no tiny little text area.
- Instant preview of your changes.
- [Cheat Sheets](cheat_sheets) - You can add links to directories having a `index.md`.
- [Markdown cheat sheet](cheat_sheets/Markdown_cheat_sheet) - Or add direct a link to a markdown file.
Installation
------------
**Requirements:**
- PHP 5.3+
- Apache Webserver with `mod_rewrite` enabled.
**Installation:**
1. [Download](http://slim-wiki.murfman.de/slim-wiki.zip) the latest version.
2. Extract the archive and put the contents on your webspace.
3. Create a `config.xml` (copy and adjust the example).
4. Give write permissions to the server for directories `articles` and `data`.
How to use the wiki
-------------------
- Just click on the `Edit` button at the top right corner and start writing.
- If you are not familiar with Markdown, check out the [Markdown cheat sheet](cheat_sheets/Markdown_cheat_sheet).
- Your changes are automatically saved as soon as you stop writing for a second. If you see your changes on the right side of the edit view, they will be already saved (with a daily backup) and public. There is no save button you have to press.
- You can add new pages by adding a link to [a non-existing page](this_is_a_new_page). Then click the link and slim wiki will allow you to add the new page.
**Tipps:**
- Use the main page as overview and add links to subpages.
- You can add a [link to a directory](cheat_sheets) having a `index.md`.
**Notes:**
- The extension `.md` is optional when linking to markdown files.
- The extension `.md` is optional.
- Underscores in directory or file names are shown as spaces in the breadcrumbs. So if you name your file `My_new_page.md`, it will be shown as `My new page`.
Special thanks
--------------
- Slim wiki is inspired by [Wikitten](https://github.com/victorstanciu/Wikitten). I have used some of their ideas, but technically slim wiki is a complete rewrite.
- Thanks to Daring Fireball for inventing [Markdown](https://daringfireball.net/projects/markdown/syntax).
- Thanks to GitHub for hosting this project and for some great [enhancements to Markdown](https://help.github.com/articles/github-flavored-markdown).