Download the PHP package christianblos/markdown2html without Composer
On this page you can find all versions of the php package christianblos/markdown2html. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download christianblos/markdown2html
More information about christianblos/markdown2html
Files in christianblos/markdown2html
Package markdown2html
Short Description Converts markdown files to static html pages
License MIT
Informations about the package markdown2html
markdown2html
Converts markdown files to static html pages. See demo (I used it to document another project of mine).
Installation
Use composer to install the latest version: composer require --dev christianblos/markdown2html
Create html via command line
First, you must configure markdown2html by adding a markdown2html.config.php file to the root folder of your repository:
Now you can execute vendor/bin/markdown2html
to create the html files in your destination folder
Note: If your config file is not in the root folder of your project, you can pass it as first argument:
vendor/bin/markdown2html /path/to/config.php
Create html via code
Maybe you have your own command line tool and you want to use PHP code directly to generate the html files. This is no problem:
Structure of Markdown files
The navigation in the generated html is based on your folder structure. Let's assume you have the following file structure:
The number prefix (like "01.") indicates the order of navigation items. You can omit it if the order doesn't matter.
All dashes are replaced with spaces ("Via-PHP" → "Via PHP"). If you want to have dashes in the navigation, use 2 or 3 dashes:
- "00.Via-command--line.md" → "Via command-line"
- "00.Via-command---line.md" → "Via command - line"
If there is a file having the same name as a folder (like 02.Usage and 02.Usage.md), it will be the index page of this folder. If you don't have the file, the index will be created automatically and contain a sub navigation.
The content of index.md contains the text of the html index page.
In the example above the generated navigation will look like this:
Default Theme
The DefaultTheme has some additional configurations you can use: