PHP based Markdown documentation viewer

Last update: Dec 9, 2022

Related tags

Markdown markdown-viewer

Overview

Markdown documentation viewer

PHP based viewer for Markdown files, to view them with fenced code highlighting and navigation.

It is designed to be used for viewing markdown-based documentation files, in a fire and forget way. The layout is based on Bootstrap 4, and does not need any additional configuration.

Requirements

PHP7.3+

Features

Automatic jump navigation built using the document's headers.
Easily switch between the available documents.
Syntax highlighted fenced code blocks.
Light and dark modes.
Additional support for "1)" style ordered lists.

Installing

The package is made to be used as a dependency in a documentation project: Put it in a folder in a webserver, point it to some markdown files, and it will display them.

Create a folder in your webroot from which to serve the documentation.
Create a composer project there.
Require the package: composer require mistralys/markdown-viewer.
Create a PHP file (index.php) as endpoint for the documentation.
Paste the following code into the file
Edit the list of files you wish to view.
Point your browser to the file.



declare(strict_types=1);

use Mistralys\MarkdownViewer\DocsManager;
use Mistralys\MarkdownViewer\DocsViewer;

if(!file_exists('vendor/autoload.php')) {
    die('Please run composer install first.');
}

require_once 'vendor/autoload.php';

$manager = new DocsManager();

// Add all the files you wish to view here, along with
// a title that will be shown in the UI. 
$manager->addFile('Title of the file', '/path/to/documentation.md');

// The viewer needs to know the URL to the vendor/ folder, relative
// to the script. This is needed to load the clientside dependencies,
// like jQuery and Bootstrap.
(new DocsViewer($manager, '/url/to/vendor'))
    ->setTitle('Documentation')
    ->display();

Adding single files

Single files can be added using addFile(). This allows specifying the name that the file will be listed under in the UI.

use Mistralys\MarkdownViewer\DocsManager;

$manager = new DocsManager();

// Add a single folder, non recursive.
$manager->addFile('Name of the file', '/path/to/file.md');

Adding folders

To add multiple files, use the addFolder() method:

use Mistralys\MarkdownViewer\DocsManager;

$manager = new DocsManager();

// Add a single folder, non recursive.
$manager->addFolder('/path/to/files');

// Add a folder and all its subfolders
$manager->addFolder('/path/to/files', true);

By default, all files with the md extension will be added. A different extension can be specified using the third parameter:

use Mistralys\MarkdownViewer\DocsManager;

$manager = new DocsManager();

// Add all TXT files from a single folder, non recursive.
$manager->addFolder('/path/to/files', false, 'txt');

NOTE: Adding files this way means you cannot specify file IDs (see "Consistent file permalinks"). Please double-check that this is okay in your use case.

Consistent file permalinks

By default, the viewer will create an ID for each file based on its absolute path on disk. This means that the ID will change if the file is moved at some point, or if the viewer is used on different systems. Sharing permalinks risks the links being broken at some point.

To avoid this issue, specify a unique file ID manually when adding single files:

use Mistralys\MarkdownViewer\DocsManager;

$manager = new DocsManager();

$manager->addFile(
    'Name of the file', 
    '/path/to/file.md',
    '(Unique file ID)'
);

The ID can be any string; the viewer uses it to create the hash that is used in the UI to identify the files. This way, permalinks will always stay consistent.

Dark mode

To turn on dark mode, simply use makeDarkMode():

use Mistralys\MarkdownViewer\DocsViewer;
use Mistralys\MarkdownViewer\DocsManager;

$manager = new DocsManager();

// Configure the files

(new DocsViewer($manager, '/url/to/vendor'))
    ->setTitle('Documentation')
    ->makeDarkMode()
    ->display();

Viewing the example

The bundled example is built exactly like the example above, and will display this README.md file. To get it running, follow these steps:

Clone the repository into a webserver's document root
Run composer install in the package folder to install the dependencies
Point your browser to the package folder's example.php file

PHP Documentation system.

PHP Documentation system Simple but powerful Markdown docs. Features Search within Markdown files Customizable Twig templates (Note: default design is

1 Oct 4, 2022

A highly configurable markdown renderer and Blade component for Laravel

A highly configurable markdown renderer and Blade component for Laravel This package contains: a Blade component that can render markdown a highly con

230 Jan 7, 2023

Easily add routes to your Laravel app by creating Markdown or Blade files

Laravel Pages This package lets you create pages using Markdown or Blade without having to worry about creating routes or controllers yourself. Essent

104 Nov 12, 2022

Render colored Markdown contents on console terminal

cli-markdown Render colored markdown contents on console terminal Preview run demo by php example/demo.php Features support auto render color on termi

6 Sep 29, 2022

Generate pseudo-static pages from markdown and HTML files for Flarum

Flarum Pages Generator This is not a Flarum extension. This package provides a Flarum extender that you can use in the local extend.php to define cust

7 Feb 21, 2022

markdown wiki/blog

Kwiki markdown wiki/blog Usage Place your markdown files in the /wiki directory. Categories are directories and subcategories are subdirectories. If y

76 Dec 30, 2022

Symfony 5 bundle to easily create dynamic subpages with Markdown. Useful for help sections and wikis.

MarkdownWikiBundle This bundle allows you to create rich subpages in a Symfony project using Markdown. Pages are stored in a file cache and sourced fr

3 Apr 26, 2022

Gruik ! An open-source markdown note-taking web app. [ABANDONED PROJECT]

What is Gruik ? It's a free & open-source note-taking service. A space where you can store notes, tutorials, code snippets... by writing them in markd

329 Dec 14, 2022

Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

Daux.io - Deprecation Notice This repository is deprecated! Daux.io has been moved to an organization, to guarantee future development and support. So

4.6k Dec 16, 2022

Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

Daux.io Daux.io is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It help

719 Jan 1, 2023

Parser for Markdown and Markdown Extra derived from the original Markdown.pl by John Gruber.

PHP Markdown PHP Markdown Lib 1.9.0 - 1 Dec 2019 by Michel Fortin https://michelf.ca/ based on Markdown by John Gruber https://daringfireball.net/ Int

3.3k Jan 1, 2023

Parser for Markdown and Markdown Extra derived from the original Markdown.pl by John Gruber.

PHP Markdown PHP Markdown Lib 1.9.0 - 1 Dec 2019 by Michel Fortin https://michelf.ca/ based on Markdown by John Gruber https://daringfireball.net/ Int

3.3k Jan 1, 2023

A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.

Roster Installation To install, simply require the package using composer: composer require

14 Sep 25, 2022

A package that uses blade templates to control how markdown is converted to HTML inside Laravel, as well as providing support for markdown files to Laravel views.

Install Install via composer. $ composer require olliecodes/laravel-etched-blade Once installed you'll want to publish the config. $ php artisan vendo

19 Jul 5, 2021

🍪 Write gorgeous documentation for your products using Markdown inside your Laravel app.

Releases(1.1.0)

1.1.0(Mar 30, 2022)
Included in this release:

Now requiring PHP >= 7.4.

Fixed a PHP error when a document contains no headers.

Added the changelog.md file.

Source code(tar.gz)
Source code(zip)
1.0.6(Mar 24, 2021)

Fixed PHP7.3 compatibility by removing PHP7.4 specific typed properties.
Source code(tar.gz)
Source code(zip)
1.0.5(Mar 18, 2021)
Included in this release:

Fixed duplicate anchor names.

Added fenced code name aliases to support js, json or html.

Reduced PHP requirement to 7.3 to support some older projects.

Source code(tar.gz)
Source code(zip)
1.0.4(Mar 18, 2021)

Fixed code fences other than PHP not being recognized correctly, causing overlapping code blocks.
Source code(tar.gz)
Source code(zip)
1.0.3(Mar 16, 2021)
Included in this release:

Added the dark mode layout.

Added the optional file IDs for consistent permalinks.

Added permalink icons to all headers.

Source code(tar.gz)
Source code(zip)
1.0.2(Mar 16, 2021)
Included in this release:

Added the viewer's addFolder() method.

Added dark mode support.

Fixed indented "1)" style bullets not being detected properly.

Source code(tar.gz)
Source code(zip)
1.0.1(Mar 15, 2021)
Included in this release:

Tweaked the sidebar padding slightly.

Added setMenuLabel() to the viewer.

Changed the documents menu label to "Available documents".

Source code(tar.gz)
Source code(zip)
1.0.0(Mar 15, 2021)

Release with all basic functionality as initially planned.
Source code(tar.gz)
Source code(zip)

PHP based Markdown documentation viewer

Related tags

Overview

Markdown documentation viewer

Requirements

Features

Installing

Adding single files

Adding folders

Consistent file permalinks

Dark mode

Viewing the example

You might also like...

PHP Documentation system.

A highly configurable markdown renderer and Blade component for Laravel

Easily add routes to your Laravel app by creating Markdown or Blade files

Render colored Markdown contents on console terminal

Generate pseudo-static pages from markdown and HTML files for Flarum

markdown wiki/blog

Symfony 5 bundle to easily create dynamic subpages with Markdown. Useful for help sections and wikis.

Gruik ! An open-source markdown note-taking web app. [ABANDONED PROJECT]

Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

Parser for Markdown and Markdown Extra derived from the original Markdown.pl by John Gruber.

Parser for Markdown and Markdown Extra derived from the original Markdown.pl by John Gruber.

A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.

A package that uses blade templates to control how markdown is converted to HTML inside Laravel, as well as providing support for markdown files to Laravel views.

🍪 Write gorgeous documentation for your products using Markdown inside your Laravel app.

Docbook Tool for static documentation generation from Markdown files

:dromedary_camel: Laravel log viewer

:page_with_curl: Provides a log viewer for Laravel

Robot increase telegram post 👁‍🗨Telegram Fake Posts Viewer👁‍🗨

Releases(1.1.0)

1.1.0(Mar 30, 2022)

1.0.6(Mar 24, 2021)

1.0.5(Mar 18, 2021)

1.0.4(Mar 18, 2021)

1.0.3(Mar 16, 2021)

1.0.2(Mar 16, 2021)

1.0.1(Mar 15, 2021)

1.0.0(Mar 15, 2021)

Owner

A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.

Docbook Tool for static documentation generation from Markdown files

A simple regex-based Markdown parser in PHP

Better Markdown Parser in PHP

Highly-extensible PHP Markdown parser which fully supports the CommonMark and GFM specs.

Convert HTML to Markdown with PHP

PHP Markdown Engine Support

Rendering markdown from PHP code

PHP Markdown & Extra

A super lightweight Markdown parser for PHP projects and applications.