This repository has been archived by the owner. It is now read-only.
Dynamic documentation library for PHP which uses Markdown files
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Document section parsing and minor bugfixes May 13, 2018
.gitignore
LICENSE Initial commit Apr 27, 2018
README.md Updated readme.md Jul 5, 2018
composer.json

README.md

WARNING: Under development!

SimpleDocs is a documentation library for PHP which uses Markdown files.

Features

  • Dynamic routing: all docs are parsed on-the-fly and served as HTML
  • Markdown file attributes: special attributes that can be parsed from documents

Requirements

  • PHP >= 7.0.0

Installation

SimpleDocs is available with Composer:

composer require simpledocs/simpledocs

Usage

You must provide a directory path for search and retrieve documents during the library initialization:

<?php

// If you aren't using any framework, make sure that the Composer autoload
// file is included in the script:
// require __DIR__ . '/vendor/autoload.php';

use SimpleDocs\SimpledDocs;
use SimpleDocs\Exception\FileNotFound;

$docs = new SimpleDocs('path/to/your/docs');

// The query string can be any string. For example purposes we use a GET
// variable:
$path = $_GET['path'] ?? '/';

try
{
    $page = $docs->find($path);
}
catch(FileNotFound $e)
{
    // Here we handle the Not Found exception. Again, for example purposes
    // a die() function is used, but a better approach is to show a 404 page or
    // or something more informative to the user
    die('Document not found!');
}

// And finally, render the result:
$page->render();

Documentation

Coming soon!

Related projects

  • Luthier CI: Improved routing, middleware support, authentication tools and more for CodeIgniter 3 framework
  • Luthier Framework: Versatile PHP micro-framework for build APIs and websites quickly

Donate

If you love our work, consider support us on Patreon