Download the PHP package arthurh/web-md-generator without Composer
On this page you can find all versions of the php package arthurh/web-md-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package web-md-generator
web-md-generator
Create a static website from markdown files easily.
What is it?
It is a static website generator. It will takes all your markdown files from a folder and make a real website (Thanks to jr). It will also make a simple menu directly with your markdown files
Usage
The best way is to get the phar archive from here web-md-generator.phar.
Put this archive inside your future website with all your markdown files inside (Markdown files should have .md extension). Finally run:
After you can simply add other markdown files and regenerate to add in your menu. And you can also simply modified .html
generated, it's still markdown inside so it will be easy to modify.
Change your option.yml
When you will generate your website you will have a new options.yml
created.
By default you will have that:
styles
: you can change default
by bootstrap
to get the bootstrap by twitter style. and add all css you want.
title
: Change title by your website name.
menuPosition
: change by top
or side
to have your menu on the side or on the top (only work for default
style).
index
: set your markdown file which will use as your index.html (don't put md extension).
scripts
: add all javascript files you want (jquery is load by default).
And finally regenerate your website by running again php web-md-generator.phar
.
Get a logo and favicon
For favicon: Simply add a favicon.(png|ico|jpg|gif) at your root website folder and regenerate your website.
For logo: Simply add a logo.(png|ico|jpg|gif) at your root website folder and regenerate your website.
Custom your menu
When you generate you will have a menu.yml
, you can modify it to set link and/or menu name.
Example and demos
For the example go to: https://github.com/ArthurHlt/web-md-generator-example
Demo with default
style with menu on top: http://web-md-generator.arthurh.fr/default-top/
Demo with default
style with menu on side: http://web-md-generator.arthurh.fr/default-side/
Demo with bootstrap
style: http://web-md-generator.arthurh.fr/bootstrap/