PHPackages arthurh/web-md-generator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Parsing & Serialization](/categories/parsing) 4. / 5. arthurh/web-md-generator ActiveLibrary[Parsing & Serialization](/categories/parsing) arthurh/web-md-generator ======================== Create a static website from markdown files easily 1.2(11y ago)126MITJavaScript Since Jul 1Pushed 9y ago1 watchersCompare [ Source](https://github.com/ArthurHlt/web-md-generator)[ Packagist](https://packagist.org/packages/arthurh/web-md-generator)[ RSS](/packages/arthurh-web-md-generator/feed)WikiDiscussions master Synced 2d ago READMEChangelog (3)Dependencies (2)Versions (4)Used By (0) web-md-generator ================ [](#web-md-generator) Create a static website from markdown files easily. What is it? ----------- [](#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](https://github.com/Xeoncross/jr)). It will also make a simple menu directly with your markdown files Usage ----- [](#usage) The best way is to get the phar archive from here [web-md-generator.phar](http://cloud.arthurh.fr/public.php?service=files&t=aaf3cdad4a9147fee9ffd4fe96605843&download). Put this archive inside your future website with all your markdown files inside (Markdown files should have .md extension). Finally run: ``` php web-md-generator.phar ``` 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 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [](#after-you-can-simply-add-other-markdown-files-and-regenerate-to-add-in-your-menu-and-you-can-also-simply-modified-html-generated-its-still-markdown-inside-so-it-will-be-easy-to-modifychange-your-optionyml) When you will generate your website you will have a new `options.yml` created. By default you will have that: ``` styles: - "default" - "//fonts.googleapis.com/css?family=Average" - "//fonts.googleapis.com/css?family=Roboto:400,700" charset: "UTF-8" title: "My Website" menuPosition: "top" index: index scripts: - "js/showdown.js" ``` `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 ---------------------- [](#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 ---------------- [](#custom-your-menu) When you generate you will have a `menu.yml`, you can modify it to set link and/or menu name. ``` menu: - { index: 'read me' } #on the left file without .html extension and on the right your menu name - { 'who am i': 'who am i' } ``` Example and demos ----------------- [](#example-and-demos) For the example go to: Demo with `default` style with menu on top: Demo with `default` style with menu on side: Demo with `bootstrap` style: ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity65 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 3 Last Release 4333d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b9ba88d407b0fba1107b4644f27fbabe80a816da59208e2907f7d3902c8f862d?d=identicon)[ArthurHlt](/maintainers/ArthurHlt) --- Top Contributors [![ArthurHlt](https://avatars.githubusercontent.com/u/5410858?v=4)](https://github.com/ArthurHlt "ArthurHlt (19 commits)") --- Tags generatormarkdownstaticwebsitemarkdown generator ### Embed Badge ![Health badge](/badges/arthurh-web-md-generator/health.svg) ``` [![Health](https://phpackages.com/badges/arthurh-web-md-generator/health.svg)](https://phpackages.com/packages/arthurh-web-md-generator) ``` ### Alternatives [erusev/parsedown Parser for Markdown. 15.0k151.8M732](/packages/erusev-parsedown)[league/commonmark Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and GitHub-Flavored Markdown (GFM) 2.9k404.0M702](/packages/league-commonmark)[michelf/php-markdown PHP Markdown 3.5k52.4M345](/packages/michelf-php-markdown)[league/html-to-markdown An HTML-to-markdown conversion helper for PHP 1.9k28.6M199](/packages/league-html-to-markdown)[davidbadura/faker-markdown-generator Faker Markdown Generator 18833.6k10](/packages/davidbadura-faker-markdown-generator)[phpowermove/docblock PHP Docblock parser and generator. An API to read and write Docblocks. 2524.0M4](/packages/phpowermove-docblock) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)