2017 © Pedro Peláez
 

library treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

image

hollodotme/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  • Wednesday, March 21, 2018
  • by hollodotme
  • Repository
  • 3 Watchers
  • 12 Stars
  • 3,950 Installations
  • PHP
  • 4 Dependents
  • 0 Suggesters
  • 2 Forks
  • 2 Open issues
  • 19 Versions
  • 36 % Grown

The README.md

Build Status Coverage Status Latest Stable Version Total Downloads License, (*1)

TreeMDown [triː <'em> daʊn]

... is a single page PHP application for browsing markdown documents in a file structure and translating them to HTML., (*2)

A full featured demo can be found here!, (*3)

treemdown, (*4)

News

You like TreeMDown and you are interested in browsing multiple trees of markdown files?, (*5)

Check out TreeMDown-Multi! Live demo is available here., (*6)

Latest updates

  • Updated highlightjs to version 8.3
  • Fixed syntax highlighting of markdown code
  • Handling internal links between markdown files in the same tree (see the documentation)

Requirements / Dependencies

Note: This application is currently tested on linux systems only., (*7)

Installation

Via composer

To get the latest stable release, check the versions at Packagist and add to your composer.json:, (*8)

{
    "require": {
        "hollodotme/treemdown": "~1.0"
    }
}

To get the bleeding edge version add this to your composer.json:, (*9)

{
    "repositories": [
        {
            "type": "vcs",
            "url": "git@github.com:hollodotme/TreeMDown.git"
        }
    ],

    "require": {
        "hollodotme/treemdown": "dev-master"
    }
}

Now include the vendor/autoload.php and get started., (*10)

Usage

Basic

<?php

use hollodotme\TreeMDown\TreeMDown;

$treemdown = new TreeMDown('/path/to/your/markdown/files');

$treemdown->display();

With personalization and options

<?php

use hollodotme\TreeMDown\TreeMDown;

// Create instance
$treemdown = new TreeMDown( '/path/to/your/markdown/files' );

# [Page meta data]
#
# Set a projectname
$treemdown->setProjectName('Your project name');

# Set a short description
$treemdown->setShortDescription('Your short description');

# Set a company name
$treemdown->setCompanyName('Your company name');

# [Output options]
#
# Show or hide empty folders in tree
#
# Default: Empty folders will be displayed
#
#$treemdown->showEmptyFolders();
$treemdown->hideEmptyFolders();

# Set the default file that is shown if no file or path is selected (initial state)
# The file path must be __relative__ to the root directory above: '/path/to/your/markdown/files'
#
# Default: index.md
#
$treemdown->setDefaultFile('README.md');

# Show/Hide filename suffix
#
# Default: Suffix is shown
#
#$tmd->showFilenameSuffix();
$tmd->hideFilenameSuffix();

# Prettify directory and file names
# This removes all "-" and "_" from the names displayed in the tree
#
# Default: Pretty names are disabled
#
#$tmd->disablePrettyNames();
$tmd->enablePrettyNames();

# [File system options]
#
# Set the patterns for files you want to include
#
# Default: array( '*.md', '*.markdown')
#
$treemdown->setIncludePatterns( array( '*.md', '*.markdown') );

# Set the patterns for files/path you want to exclude
#
# Default: array( '.*' )
#
$treemdown->setExcludePatterns( array( '.*' ) );

$treemdown->display();

Contributions

This application uses the following libraries:, (*11)

The Versions

21/03 2018

dev-dependabot/composer/tm/tooly-composer-script-1.2.6

dev-dependabot/composer/tm/tooly-composer-script-1.2.6 http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

The Development Requires

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

15/12 2017

dev-master

9999999-dev http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

The Development Requires

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

15/12 2017

v2.0.0-beta

2.0.0.0-beta http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

The Development Requires

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

14/12 2017

dev-development

dev-development http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

The Development Requires

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

14/12 2017

v2.0.0-alpha

2.0.0.0-alpha http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

The Development Requires

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

12/01 2015

v1.1.3

1.1.3.0 http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

01/11 2014

v1.1.2

1.1.2.0 http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

01/11 2014

v1.1.1

1.1.1.0 http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

01/11 2014

v1.1.0

1.1.0.0 http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

16/09 2014

1.0.9

1.0.9.0 http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

30/08 2014

v1.0.8

1.0.8.0 http://hollo.me/treemdown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

24/08 2014

v1.0.7

1.0.7.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

21/08 2014

v1.0.6

1.0.6.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

21/08 2014

v1.0.5

1.0.5.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

20/08 2014

v1.0.4

1.0.4.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

16/08 2014

v1.0.3

1.0.3.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

15/08 2014

v1.0.2

1.0.2.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

15/08 2014

v1.0.1

1.0.1.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep

15/08 2014

v1.0.0

1.0.0.0 https://github.com/hollodotme/TreeMDown

A PHP class for browsing markdown files with HTML rendering, syntax highlighting and search

  Sources   Download

MIT

The Requires

 

by Holger Woltersdorf

parser search html markdown tree markdown extra grep