Skip to content

jakubthedeveloper/MarkdownBlogExample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Example markdown blog

This repository contains an example implementation of the markdown blog created using library https://github.com/jakubthedeveloper/SimpleMarkdownBlog

Requirements

  • PHP >= 8.1
  • Composer

Demo

You can see the demo of this project on the website http://markdown-blog-preview.irok84.kei.pl/

Install

composer install

Usage

Templates

Save your templates in the template/ directory.

Tags you can use in templates:

  • __BLOG_TITLE__
  • __PAGES_LIST__
  • __PAGE_CONTENT__
  • __TITLE__
  • __DESCRIPTION__
  • __IMAGE__
  • __PAGE_TYPE__ # see http://ogp.me/#types
  • __PAGE_URL__

Pages

Save your pages contents in the markdown format in the markdown/ directory.

Configuration

Edit config/pages.yaml to set your pages configuration.

Edit config/blog.yaml to set your blog configuration.

Generate HTML

Use the following command to generate pages:

./bin/console generate:pages

Output

Generated HTML files will be saved in public/ directory, vhost on your server should point to this directory for the public files.