wiki/README.md
2023-04-24 19:35:52 +02:00

2.3 KiB
Executable file

W2 wiki

W2 wiki is a web-based, wiki-like notepad that you can host yourself.

Notable features:

  • Elegant text markup:
    • Uses Markdown Syntax.
    • 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)

Installation & Configuration

See Installation instructions.

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.

Acknowledgements

Originally written by Steven Frank and others, with modifications by

W2 wiki uses PHP Markdown by Michel Fortin for rendering Markdown to HTML.

The Markdown syntax description is taken from daringfireball.net.

Maintainer of this fork is codeling.

Reporting Bugs

Please report bugs in the github issue tracker of this fork.