Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcuskober/hexasite
HexaSite is a PHP and Symfony-based static site generator that transforms Markdown files into HTML using Twig templates.
https://github.com/marcuskober/hexasite
markdown php static-site-generator symfony-application
Last synced: 2 days ago
JSON representation
HexaSite is a PHP and Symfony-based static site generator that transforms Markdown files into HTML using Twig templates.
- Host: GitHub
- URL: https://github.com/marcuskober/hexasite
- Owner: marcuskober
- License: mit
- Created: 2024-09-18T06:07:11.000Z (10 days ago)
- Default Branch: main
- Last Pushed: 2024-09-25T12:22:23.000Z (3 days ago)
- Last Synced: 2024-09-26T03:06:03.193Z (2 days ago)
- Topics: markdown, php, static-site-generator, symfony-application
- Language: PHP
- Homepage:
- Size: 14.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HexaSite
An efficient static site generator built with PHP and Symfony, transforming Markdown files into static HTML using Twig templates.
**Note:** HexaSite is currently under heavy development. Features and functionalities may change, and usage is at your own risk.
## Overview
HexaSite provides a straightforward way to build static websites by converting Markdown files into HTML pages. Leveraging the power of PHP and the Symfony framework, it utilizes Twig for templating, allowing for flexible and customizable site designs.
## Features
- **Markdown to HTML Conversion**: Easily convert your Markdown files into static HTML pages.
- **Twig Templating**: Customize your site's appearance with powerful Twig templates.
- **Symfony Integration**: Built on Symfony for robust performance and scalability.
- **Lightweight and Easy to Use**: Minimal setup with a focus on simplicity.
## Installation
### Prerequisites
- PHP 8.3 or higher
- Composer
### Steps
1. **Clone the Repository**
```bash
git clone https://github.com/marcuskober/HexaSite.git
cd hexasite
```
2. **Install Dependencies**
```bash
composer install
```
3. **Prepare Your Content**
Place your Markdown files in the `content` directory.
## Usage
Generate your static site by running:
```bash
symfony console static:build
```
The generated HTML files will be placed in the `build` directory.
## Customization
- **Templates**: Modify the Twig templates in the `templates` directory to change the site's layout and design.
## Roadmap
- [x] First prototype for generating html files from markdown files
- [x] Internal linking
- [ ] Asset management
- [ ] Navigation
- [x] Top level
- [ ] Sub menus
- [ ] Article list (for blog pages)
- [x] Render article list
- [ ] List parameters like sorting
- [ ] Pagination
- [ ] Multi language support
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.
## License
This project is licensed under the [MIT License](LICENSE).
## Contact
For questions or support, please contact [[email protected]](mailto:[email protected]).