{"id":21288985,"url":"https://github.com/hollodotme/treemdown","last_synced_at":"2025-07-11T14:31:45.164Z","repository":{"id":19538810,"uuid":"22786780","full_name":"hollodotme/TreeMDown","owner":"hollodotme","description":"[triː \u003c'em\u003e daʊn] PHP single page markdown tree browser","archived":false,"fork":false,"pushed_at":"2021-06-28T07:44:14.000Z","size":817,"stargazers_count":14,"open_issues_count":4,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-07T07:47:32.290Z","etag":null,"topics":["markdown-viewer","php","tree"],"latest_commit_sha":null,"homepage":"https://hollo.me/treemdown/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hollodotme.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-09T13:32:42.000Z","updated_at":"2021-06-28T07:44:17.000Z","dependencies_parsed_at":"2022-08-24T03:31:02.878Z","dependency_job_id":null,"html_url":"https://github.com/hollodotme/TreeMDown","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/hollodotme/TreeMDown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2FTreeMDown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2FTreeMDown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2FTreeMDown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2FTreeMDown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hollodotme","download_url":"https://codeload.github.com/hollodotme/TreeMDown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2FTreeMDown/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264833276,"owners_count":23670617,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown-viewer","php","tree"],"created_at":"2024-11-21T12:32:50.054Z","updated_at":"2025-07-11T14:31:44.722Z","avatar_url":"https://github.com/hollodotme.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/hollodotme/TreeMDown.svg?branch=master)](https://travis-ci.org/hollodotme/TreeMDown)\n[![Coverage Status](https://coveralls.io/repos/github/hollodotme/TreeMDown/badge.svg?branch=master)](https://coveralls.io/github/hollodotme/TreeMDown?branch=master)\n[![Latest Stable Version](https://poser.pugx.org/hollodotme/TreeMDown/v/stable)](https://packagist.org/packages/hollodotme/TreeMDown) \n[![Total Downloads](https://poser.pugx.org/hollodotme/TreeMDown/downloads)](https://packagist.org/packages/hollodotme/TreeMDown) \n[![License](https://poser.pugx.org/hollodotme/TreeMDown/license)](https://packagist.org/packages/hollodotme/TreeMDown)\n\n# TreeMDown `[triː \u003c'em\u003e daʊn]`\n\n... is a single page PHP application for browsing markdown documents in a file structure and translating them to HTML.\n\n\u003e **[A full featured demo can be found here!](http://hollo.me/treemdown)**\n\n![treemdown](https://cloud.githubusercontent.com/assets/1557839/3932639/def59cf8-246d-11e4-906f-b715e61f58b8.png)\n\n## News\n\nYou like TreeMDown and you are interested in browsing multiple trees of markdown files?\n\n\u003e Check out [TreeMDown-Multi](https://github.com/hollodotme/TreeMDown-Multi)!\n\u003e [Live demo is available here.](http://hollo.me/treemdown-multi/)\n\n### Latest updates\n\n * Updated [highlightjs](https://highlightjs.org) to version 8.3\n * Fixed syntax highlighting of markdown code\n * Handling internal links between markdown files in the same tree (see the documentation)\n\n## Requirements / Dependencies\n\n * PHP \u003e= 5.3\n * [Parsedown-Extra](https://github.com/erusev/parsedown-extra) via composer\n * Webserver (Apache, nginx, etc.)\n\n**Note:** This application is currently tested on linux systems only.\n\n## Installation\n\n### Via composer\n\nTo get the latest stable release, check the versions at [Packagist](http://packagist.org) and add to your `composer.json`:\n\n```json\n{\n\t\"require\": {\n\t\t\"hollodotme/treemdown\": \"~1.0\"\n\t}\n}\n```\n\nTo get the bleeding edge version add this to your `composer.json`:\n\n```json\n{\n\t\"repositories\": [\n\t\t{\n\t\t\t\"type\": \"vcs\",\n\t\t\t\"url\": \"git@github.com:hollodotme/TreeMDown.git\"\n\t\t}\n\t],\n\n\t\"require\": {\n\t\t\"hollodotme/treemdown\": \"dev-master\"\n\t}\n}\n```\n\nNow include the `vendor/autoload.php` and get started.\n\n## Usage\n\n### Basic\n\n```php\n\u003c?php\n\nuse hollodotme\\TreeMDown\\TreeMDown;\n\n$treemdown = new TreeMDown('/path/to/your/markdown/files');\n\n$treemdown-\u003edisplay();\n\n```\n\n### With personalization and options\n\n```php\n\u003c?php\n\nuse hollodotme\\TreeMDown\\TreeMDown;\n\n// Create instance\n$treemdown = new TreeMDown( '/path/to/your/markdown/files' );\n\n# [Page meta data]\n#\n# Set a projectname\n$treemdown-\u003esetProjectName('Your project name');\n\n# Set a short description\n$treemdown-\u003esetShortDescription('Your short description');\n\n# Set a company name\n$treemdown-\u003esetCompanyName('Your company name');\n\n# [Output options]\n#\n# Show or hide empty folders in tree\n#\n# Default: Empty folders will be displayed\n#\n#$treemdown-\u003eshowEmptyFolders();\n$treemdown-\u003ehideEmptyFolders();\n\n# Set the default file that is shown if no file or path is selected (initial state)\n# The file path must be __relative__ to the root directory above: '/path/to/your/markdown/files'\n#\n# Default: index.md\n#\n$treemdown-\u003esetDefaultFile('README.md');\n\n# Show/Hide filename suffix\n#\n# Default: Suffix is shown\n#\n#$tmd-\u003eshowFilenameSuffix();\n$tmd-\u003ehideFilenameSuffix();\n\n# Prettify directory and file names\n# This removes all \"-\" and \"_\" from the names displayed in the tree\n#\n# Default: Pretty names are disabled\n#\n#$tmd-\u003edisablePrettyNames();\n$tmd-\u003eenablePrettyNames();\n\n# [File system options]\n#\n# Set the patterns for files you want to include\n#\n# Default: array( '*.md', '*.markdown')\n#\n$treemdown-\u003esetIncludePatterns( array( '*.md', '*.markdown') );\n\n# Set the patterns for files/path you want to exclude\n#\n# Default: array( '.*' )\n#\n$treemdown-\u003esetExcludePatterns( array( '.*' ) );\n\n$treemdown-\u003edisplay();\n\n```\n\n## Contributions\n\n\nThis application uses the following libraries:\n\n * [Parsedown-Extra](https://github.com/erusev/parsedown-extra) / [ParseDown](http://parsedown.org)\n * [highlight.js](https://highlightjs.org)\n * [github markdown stylesheet by Chris Patuzzo](https://gist.github.com/tuzz/3331384)\n * [github ribbon stylesheet by Simon Whitaker](https://github.com/simonwhitaker/github-fork-ribbon-css)\n * [jQuery](http://jquery.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhollodotme%2Ftreemdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhollodotme%2Ftreemdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhollodotme%2Ftreemdown/lists"}