https://github.com/speedie1337/swiki

Simple and suckless inspired wiki. Mirror of https://git.speedie.site/speedie/swiki
https://github.com/speedie1337/swiki

documentation lightweight markdown minimal php php8 project suckless wiki

Last synced: about 5 hours ago
JSON representation

Simple and suckless inspired wiki. Mirror of https://git.speedie.site/speedie/swiki

• Host: GitHub
• URL: https://github.com/speedie1337/swiki
• Owner: speedie1337
• License: mit
• Created: 2023-10-09T00:18:05.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-09T00:18:31.000Z (about 1 year ago)
• Last Synced: 2024-05-12T19:23:37.513Z (6 months ago)
• Topics: documentation, lightweight, markdown, minimal, php, php8, project, suckless, wiki
• Language: PHP
• Homepage: https://git.speedie.site/speedie/swiki
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# swiki

Simple, suckless read-only wiki

## Features

- Simple

  - swiki only requires PHP. It has no JavaScript, no SQL and doesn't

  **require** a web server or any other dependencies.

- Minimal

  - swiki doesn't have a thousand different features. It simply displays

  text and images to the user. Nothing else.

- Markdown articles

  - Markdown is a simple format that people can understand even with no

  HTML/CSS or PHP knowledge.

- Read-only

  - swiki is read only, meaning the user cannot make any changes using

  a web interface. This is better, why implement a new editor when the

  user can just clone a repository in their existing editor and push.

  Contributions should be made using a separate tool, such as Git.

## Setup

Install PHP and clone the repository and point your web server to `index.php`.

To test locally, you can run `php` with the `-S` argument.

## Preview

See the wiki in action [here](https://spmenu.speedie.site).

## License

MIT License

Copyright (c) 2013 Steven Frank

Copyright (c) 2023 speedie 

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.