atk14/md-book

A set of features that allow to publish Markdown books on web

v0.2.6 2025-03-04 16:25 UTC

Requires

• php: >=5.6.0
• atk14/drink-markdown: ^0.8

Requires (Dev)

• atk14/core: dev-master
• atk14/dictionary: ^1.0
• atk14/forms: ^1.1
• atk14/functions: dev-master
• atk14/http: ^0.8
• atk14/logger: ^0.2
• atk14/mini-yaml: ^1.0
• atk14/session-storer: ^1.0
• atk14/stop-watch: ^0.1
• atk14/string4: ^0.5
• atk14/tester: *
• smarty/smarty: 3.1.48|4.3.5

MIT

• ATK14 Development Team

README

A set of features that allow to publish books written in Markdown on web.

Installation

cd path/to/your/project/
composer require atk14/md-book

ln -s ../../vendor/atk14/md-book/src/app/controllers/md_book_base.php ./app/controllers/
ln -s ../../vendor/atk14/md-book/src/app/views/md_book_base ./app/views/
ln -s ../../../vendor/atk14/md-book/src/app/views/shared/md_book ./app/views/shared

Usage in an Atk14 application

<?php
// file: app/controller/sample_book_controller.php

require_once(__DIR__ . "/md_book_base.php");

class SampleBookController extends MdBookBaseController {

  var $book_dir = __DIR__ . "/../../vendor/atk14/md-book/test/sample_book/";

}