https://github.com/kirilkirkov/markdown-to-static-site

A lightweight and easy-to-use PHP 8 tool for generating static websites from Markdown files. This generator allows you to convert Markdown content into HTML, apply themes, and extend functionality with plugins. Perfect for creating documentation, blogs, and static websites.
https://github.com/kirilkirkov/markdown-to-static-site

markdown-parser markdown-parsing markdown-to-html php-markdown php-markdown-parser php8

Last synced: about 1 month ago
JSON representation

A lightweight and easy-to-use PHP 8 tool for generating static websites from Markdown files. This generator allows you to convert Markdown content into HTML, apply themes, and extend functionality with plugins. Perfect for creating documentation, blogs, and static websites.

• Host: GitHub
• URL: https://github.com/kirilkirkov/markdown-to-static-site
• Owner: kirilkirkov
• Created: 2024-06-02T16:43:43.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-04T18:10:05.000Z (7 months ago)
• Last Synced: 2024-10-12T10:44:46.123Z (2 months ago)
• Topics: markdown-parser, markdown-parsing, markdown-to-html, php-markdown, php-markdown-parser, php8
• Language: PHP
• Homepage:
• Size: 5.86 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Markdown to Static Site Generator

A simple PHP tool to generate static sites from Markdown files.

## Usage

1. Place your Markdown files in the `content` directory.

2. Run the generator:

   ```bash

   php src/main.php

   ```

3. Your static site will be generated in the public directory.

## Custom Themes

You can create custom themes by adding them to the themes directory and updating the path in config.php.


## Plugins

Plugins can be created in the plugins directory and added to config.php.


## How to run the project

1. Clone the repository and install the dependencies

   ```bash

   git clone https://github.com/kirilkirkov/Markdown-To-Static-Site.git

   cd Markdown-To-Static-Site

   composer install

   ```

2. Start the generator

   ```bash

   php src/main.php

   ```

Thats all. Your site will be generated to the public directory