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

Improved sample pages

Browse Source
This commit is contained in:
til-schneider 2016-02-02 20:09:06 +01:00
parent 308a2d25e2
commit 3a4e8be732
2 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -44,7 +44,7 @@ Inline markup like _italics_, **bold**, ~~strike through~~ and `code()`:
_italics_, **bold**, ~~strike through~~ and `code()`
~~~
Want to mark something in your article to fix later? Add a yellow TODO or FIXME marker:
Want to mark something in your page to fix later? Add a yellow TODO or FIXME marker:
~~~markdown
Simply write TODO or FIXME.

20
src/articles/index.md
View File

@ -1,14 +1,15 @@
Welcome to your wiki!
=====================
Slim wiki is a fast and slim wiki based on PHP and Markdown.
**Slim wiki** is a fast and slim wiki based on PHP and Markdown.
- 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).
- 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.
- Add code snippets with syntax highlighting to your pages. Slim wiki has 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.
- Slim wiki is open source (MIT license)
@ -35,7 +36,7 @@ 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.
- 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 create the new page.
Tipps:
@ -44,8 +45,15 @@ Tipps:
Notes:
- 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`.
- The extension `.md` is optional - slim wiki will add it automatically.
- Underscores in directory or file names are shown as spaces in the breadcrumbs. So if you name your page `My_new_page.md`, it will be shown as `My new page`.
How to develop slim wiki
------------------------
Check out the [project page on GitHub](https://github.com/til-schneider/slim-wiki).