perso
/
MarkDoc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
PHP MarkDown document manager, Free & OpenSource for easily create your documentation
2 Commits 2 Branches 0 Tags 503 KiB
PHP 65.1%
CSS 20.3%
JavaScript 14.6%
Go to file
Nicolas Hordé d3af975d76 First version 2021-01-01 12:08:59 +01:00
css First version 2021-01-01 12:08:59 +01:00
hosts/localhost First version 2021-01-01 12:08:59 +01:00
js First version 2021-01-01 12:08:59 +01:00
lib First version 2021-01-01 12:08:59 +01:00
.gitignore First version 2021-01-01 12:08:59 +01:00
.htaccess First version 2021-01-01 12:08:59 +01:00
favicon.ico First version 2021-01-01 12:08:59 +01:00
gpl-3.0.md First version 2021-01-01 12:08:59 +01:00
index.php First version 2021-01-01 12:08:59 +01:00
markdow.code-workspace First version 2021-01-01 12:08:59 +01:00
readme.md First version 2021-01-01 12:08:59 +01:00

readme.md

MarkDoc

PHP MarkDown document manager, Free & OpenSource 😍 for easily create your documentation website**

  __  __            _    _____             
 |  \/  |          | |  |  __ \            
 | \  / | __ _ _ __| | _| |  | | ___   ___ 
 | |\/| |/ _` | \'__| |/ / |  | |/ _ \ / __|
 | |  | | (_| | |  |   <| |__| | (_) | (__ 
 |_|  |_|\__,_|_|  |_|\_\_____/ \___/ \___|

gplV3 Sous licence GPLv3 Licence - Sources téléchargéables sur GitHub

Based on Pheditor "PHP file editor" By Hamid Samak Release under MIT license

Specials thanks to Hamid Samak

2020 par Nicolas H.

Features

Actual

  1. Simple Website with customizables menus
  2. Markdown Editor with syntax highlighting and Emoji support
  3. Very fast loading with ajax support
  4. Multiple websites hosting with single MarkDoc installation
  5. Integrated Image viewer
  6. Restricted access by ip address
  7. Admin access logging

Planned

  1. Complete File Manager
  2. Password protected area
  3. Keeping the history of edited files and changes
  4. Configuration viewer
  5. Emoji menu in Markdown editor
  6. Uploading multiple files by drag and drop

Installation

Installation using git

git clone https://github.com/dahut87/MarkDoc.git [website_root]

Install Emoji data and copy Emoji data to the "emoji-data"

wget https://github.com/iamcal/emoji-data/archive/v6.0.0.zip
unzip v6.0.0.zip
mv emoji-data-v6.0.0 emoji-data

Usage

There is a sample website in the "[website_root]/hosts/locahost" directory. It's easy to add a new one, you create one subfolder by name served by your webserver.

[website_root]/hosts/example.com
[website_root]/hosts/test.sample.fr

Configuration

The configuration file is named 'config.php', is located in the [website_root]/hosts/[host]/config.php.

List of the parameters you can modify

define('SUBCONTENT_DIR', 'content');
define('SHOW_HIDDEN_FILES', false);
define('VIEWABLE_FORMAT', 'md');
define('TITLE', 'Documentation');
define('ICON', 'fa-book-open');
define('ALLOWED_EXT','jpg,svg,gif,png,c,tgz,tar.gz,gz,tar,sql,ico');
define('PASSWORD', '[sha512 encoded password]');
define('LOG_FILE', 'log.txt');
define('ACCESS_IP', '');
define('HISTORY_FILE', 'history.txt');
define('MAX_HISTORY_FILES', 5);

NOTE: The default password is admin. Please change the password after install or first login.

Dependences

Emoji Support

Thanks to Cal Henderson

Converting Markdown

Thanks to Emanuil Rusev

Editing markdown

Thanks to Wes Cossick

Syntax highlighting

Icons

Essential