markPush

Turn your markdown files into a website ✨

Demo

Usage

1. Create or edit several markdown files.
2. Drop markPush.php on the main folder. Then open a shell and type php markPush.php.
3. Done. All your markdown files are now converted to HTML.

Adage

• Les meilleures choses sont les plus simples. 🇫🇷
• Best things are the simplest. 🇬🇧

Concept

With markPush, you just need PHP to convert your markdown files into a website. Think about GitHub pages, but without GitHub lol. Yup, fully decentralized.

Explications 🇫🇷

markPush.php permet de convertir des tas de fichiers Markdown en fichiers HTML. Sa force réside dans le fait qu'il est capable de s'adapter à n'importe quelle structure de dossiers, fichiers et sous-dossiers. Un peu comme GitHub pages, mais sans GitHub. Tout ce dont vous avez besoin c'est de PHP pour exécuter le script markPush.php.

Prenons un exemple

Avant markPush :

site/
├── cuisine/
│   ├── README.md
│   ├── soupes/
│   │   ├── README.md
│   │   ├── soupe-lentilles-indiennes.md
│   │   └── soupe-potimarron.md
│   └── tartiflette.md
└── README.md

J'ajoute markPush.php à la racine du site, j'y ouvre un shell et je tape : php markPush.php.

Voilà ce que j'obtiens :

site/
├── cuisine/
│   ├── index.html
│   ├── README.md
│   ├── soupes/
│   │   ├── index.html
│   │   ├── README.md
│   │   ├── soupe-lentilles-indiennes.html
│   │   ├── soupe-lentilles-indiennes.md
│   │   ├── soupe-potimarron.html
│   │   └── soupe-potimarron.md
│   ├── tartiflette.html
│   └── tartiflette.md
├── index.html
└── README.md

Chaque fichier .md a été converti en .html !

Et si le fichier Markdown s'appelle README.md, il sera simplement converti en index.html.

Explanations 🇬🇧

markPush.php allows to convert hips of Markdown files in HTML files. With an interesting benefit : "markPush" adapts almost any files, folders and sub folders structure. Think about GitHub pages, but without GitHub. All you need is just PHP to launch the script decentralized, as you just need PHP to run the markPush.php script.

Let's take an example

Before markPush :

site/
├── README.md
└── recipes/
    ├── gratin.md
    ├── README.md
    └── soups/
        ├── README.md
        ├── soup-lentils-india.md
        └── soup-red-kuri-squash.md

Adding markPush.php to the site's root folder, opening a shell then typing : php markPush.php.

Here is what I get :

site/
├── index.html
├── README.md
└── recipes/
    ├── gratin.html
    ├── gratin.md
    ├── index.html
    ├── README.md
    └── soups/
        ├── index.html
        ├── README.md
        ├── soup-lentils-india.html
        ├── soup-lentils-india.md
        ├── soup-red-kuri-squash.html
        └── soup-red-kuri-squash.md

Each .md file has been converted to .html !

And if the Markdown file is called README.md it will be simply converted as index.html.

Some readings

Read those articles written by Tim Berners-Lee, you know, the inventor of the web. He gave lately some interesting points about how the web has become, and what can we do, to save the World Wide Web.

• Tim Berners-Lee: I invented the web. Here are three things we need to change to save it (The Guardian)
• “I Was Devastated”: Tim Berners-Lee, the Man Who Created the World Wide Web, Has Some Regrets (Vanity Fair)

License

"markPush" is released under the GNU Affero General Public License v3.0 or later, see here for a description of this license, or see the LICENSE file for the full text. Also using great tools like Pico.css, licensed under the MIT License, and Parsedown, licensed under the MIT License too.