Download the PHP package new-humans/markdown-article-library without Composer
On this page you can find all versions of the php package new-humans/markdown-article-library. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download new-humans/markdown-article-library
More information about new-humans/markdown-article-library
Files in new-humans/markdown-article-library
Package markdown-article-library
Short Description Markdown file organizer for PHP7
License COMMY
Homepage https://github.com/New-Humans/MarkdownArticleLibrary
Informations about the package markdown-article-library
new-humans/markdown-article-library
new-humans/markdown-article-library is a PHP-based file system wrapper for league/commonmark's Markdown parser. File system navigation emotionally inspired by new-humans/ubfs.
Goals
- Let a writer interact with a relatively organize-able file system of Markdown files, in PHP.
- Let the writer offer these files as an HTML render for web browsers.
- Let the writer offer these files as downloads.
Installation
This project can be installed via Composer:
Basic Usage
The ArticleLibrary
class provides a simple wrapper for loading a 1-level deep Markdown file system. A library directory is expected to exist in your project in the following format:
Each subdirectory of /library
represents a writing subject. Each file in the subdirectory represents a piece of writing within that subject, formatted in Markdown.
Note: Any of these names can be replaced - they're all supplied to the object by the developer, based on the actual files in the solution. The example in this repository includes subjects /notes
and /whimsy
.
Documentation
Best place to look is inside! Just two classes in /src
.