update readme
This commit is contained in:
parent
cfe754014e
commit
a813263fcc
72
README.md
72
README.md
|
@ -1,60 +1,26 @@
|
|||
# W2 wiki
|
||||
# spmenu-wiki
|
||||
|
||||
W2 wiki is a web-based, wiki-like notepad that you can host yourself.
|
||||
The official wiki and documentation for [spmenu](https://git.speedie.site/speedie/spmenu).
|
||||
|
||||
## Contributing
|
||||
|
||||
## Notable features:
|
||||
I accept contributions in the form of both new articles and edits to
|
||||
existing articles. In the past this was a wiki where anyone could edit
|
||||
any page or add new pages, but due to abuse that has since been disabled
|
||||
and removed.
|
||||
|
||||
- Elegant text markup:
|
||||
- Uses [Markdown Syntax](https://github.com/codeling/w2wiki/blob/master/pages/MarkdownSyntax.md).
|
||||
- It supports double-brackets [[like this]] to link to another page in the wiki by title
|
||||
- It supports double-braces {{like this}} to link to an uploaded image
|
||||
- Minimalistic but functional interface:
|
||||
- Fits to screen nicely when viewed on iPhone, with custom icon for adding to home screen
|
||||
- HTML5 compliant output
|
||||
- Title & content search
|
||||
- Filesystem storage (no database required) in plain Markdown text files.
|
||||
- Rudimentary git integration to commit & push each page edit
|
||||
- Localization support (currently en/ja translations available)
|
||||
- Image uploading support
|
||||
- Optionally password-protected
|
||||
- Unlike cloud / hosted solutions, you retain control of your data
|
||||
- Written in PHP for portability and hackability
|
||||
- Extremely compact (only a few .php files and a .css file)
|
||||
Pages/articles should be written in Markdown, and should be located in
|
||||
the `pages/` directory. The sidebar itself can also be found in `pages/`.
|
||||
|
||||
Before submitting your changes, please test locally. If you have `php`
|
||||
installed, you can simply do this by running `test.sh` and navigating
|
||||
to `localhost:1337` in your web browser.
|
||||
|
||||
## Installation & Configuration
|
||||
|
||||
See [Installation instructions](https://github.com/codeling/w2wiki/blob/master/INSTALL.md).
|
||||
|
||||
|
||||
## Security Notice
|
||||
|
||||
In its current form, W2 wiki is not security-hardened; it's recommended to only run on an additionally secured server (e.g. in a small, private network for one user only; and secured behind a VPN and/or HTTPS with basic authentication).
|
||||
|
||||
|
||||
## License
|
||||
|
||||
W2 is licensed under the [MIT license](https://github.com/codeling/w2wiki/blob/master/LICENSE).
|
||||
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
Originally written by [Steven Frank](https://github.com/panicsteve/w2wiki) and others, with modifications by
|
||||
- [44uk](https://github.com/44uk/w2wiki)
|
||||
- [knee-cola](https://github.com/knee-cola/w2wiki)
|
||||
- [namvan](https://github.com/namvan/w2wiki)
|
||||
- [nickodell](https://github.com/nickodell/w2wiki)
|
||||
- [pilem](https://github.com/pilem/w2)
|
||||
|
||||
W2 wiki uses [PHP Markdown](https://github.com/michelf/php-markdown) by Michel Fortin for rendering Markdown to HTML.
|
||||
|
||||
The [Markdown syntax](https://github.com/codeling/w2wiki/blob/master/pages/MarkdownSyntax.md) description is taken from [daringfireball.net](https://daringfireball.net/projects/markdown/syntax).
|
||||
|
||||
Maintainer of this fork is [codeling](https://github.com/codeling/w2wiki).
|
||||
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
Please report bugs in [the github issue tracker](https://github.com/codeling/w2wiki/issues) of this fork.
|
||||
When you're done with your changes, fork the project, make any changes
|
||||
you wish to make, and submit a pull request using Gitea. I will then
|
||||
approve the changes, or request changes to be made to it before it
|
||||
can be merged. Please allow some time after the pull request has been
|
||||
merged for the changes to be displayed.
|
||||
|
||||
Please note that any documentation is licensed under the
|
||||
CC-BY-SA 4.0 license.
|
||||
|
|
Loading…
Reference in a new issue