Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luckyshot/miki
Wiki system in PHP+NoDB in just one file. 10s setup + auto-installed. Full Markdown support. Super fast and lightweight (-0.01MB gzip). Multi-User support. Minimal and beautiful.
https://github.com/luckyshot/miki
file-based hacktoberfest micro miki mini-wiki nodb nosql php productivity tool
Last synced: about 2 months ago
JSON representation
Wiki system in PHP+NoDB in just one file. 10s setup + auto-installed. Full Markdown support. Super fast and lightweight (-0.01MB gzip). Multi-User support. Minimal and beautiful.
- Host: GitHub
- URL: https://github.com/luckyshot/miki
- Owner: luckyshot
- Created: 2012-04-18T22:05:41.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-10-23T17:01:34.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T00:32:42.608Z (5 months ago)
- Topics: file-based, hacktoberfest, micro, miki, mini-wiki, nodb, nosql, php, productivity, tool
- Language: PHP
- Homepage: https://xaviesteve.com
- Size: 114 KB
- Stars: 28
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
miki
================
Miki is a mini-wiki system in just one file.
- One single PHP file
- No database needed (files are stored as .txt files in the server)
- Auto-installed automatically
- Full Markdown language support
- Super fast and lightweight (0.01MB including PHP code, Database, Responsive Stylesheet and Scripts)
How to use it
----------------------
At the right side every page you will find an _Edit_ button, click on it and modify the text, then click _Save_ (or press `Control+S`).
Use [Markdown](http://daringfireball.net/projects/markdown/syntax) to format your text and put words inside `[ ]` to create internal links, then click on them and a new page will be created.
Installation
----------------------
1. Copy `index.php` to your web server
2. Open `index.php` and customize details in `$config` variable
3. Create a folder next to `index.php` with a **very very long name** (at least 32 characters, 64+ recommended, [grab one from the password generator here](https://xaviesteve.com/pro/tools.php))
4. Make sure that you have writing permissions in the Miki folder, every new Miki page is stored as a `.txt` file
5. Create a link in your browser to point to _ServerUrl + FolderName_. Example: `https://example.com/miki/MyVeryLongFolderName` and use that link to **Log in**
Custom CSS styling
----------------------
Create a link `[customcss]` so you get a page like https://example.com/miki/customcss/ and write the CSS code in it.
Changelog
---------------------
### 3.1.24 (10 April 2017)
- Auto-save drafts
- Dark mode at night
### 3.1.20 (13 February 2017)
- Simplified setup + auto-installation of `.htaccess`
- Multi-user support (one per folder)
- User Interface improvements and code optimizations
- Cookie based login allows for long session durations
- Keyboard shortcut to _Edit_ and _Save_
- Dark theme between 9pm and 7am
- Custom starting page name (`welcome` by default)
- Custom per-folder CSS file
- New logo and favicon
- Tons of bug fixes and performance improvements
### 2.0.2 (2 February 2013)
- Ported all formatting to official Markdown
- New design (better readability, responsive, mobile optimized)
- Huge bandwidth savings: Formatted text is now generated on the fly (instead of downloading formatted+unformatted)
- Lots of bug fixes and performance improvements
License
---------------------
Miki is authored by [Xavier Esteve](https://xaviesteve.com/) and licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike license](https://creativecommons.org/licenses/by-nc-sa/3.0/).
Disclaimer
---------------------
Anyone that knows or discovers the folder names will have read+write access to all files in it, so remember to use long names for the folders and only share them with those you want to have access. You can rename a folder to change the access link.
Please check the code by yourself before using it in a production environment, while I consider it myself secure, I may be unaware of a vulnerability.