2017 © Pedro Peláez
 

project blog

The "Symfony Standard Edition" distribution

image

harentius/blog

The "Symfony Standard Edition" distribution

  • Thursday, February 1, 2018
  • by harentius
  • Repository
  • 1 Watchers
  • 0 Stars
  • 44 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 5 Versions
  • 33 % Grown

The README.md

Blog

Overview

harentius/blog is a minimalistic blogging engine.
It is designed to use Markdown files for content and transform them into blog posts.
The directory structure represents a categories tree., (*1)

It consists of the following parts:, (*2)

Symfony application (src/BlogBundle)

It is used to store and display blog posts. Provides an API to manage blog and a UI to display it. It is also available as a standalone Symfony bundle harentius/blog-bundle, which is a subsplit of this engine., (*3)

Markdown renderer and publisher (src/publisher)

Renders markdown and publish it in a blogging application., (*4)

Installation

Requirements: docker, make, nodejs (for publisher), (*5)

  1. Clone the repository
git clone git@github.com:harentius/blog.git
  1. Start containers and do initial setup
make up
  1. Build a DB schema
make build-db
  1. Install npm modules for publisher
cd src/publisher && npm install
  1. The blog application should be available on the address http://localhost:8080

Mentioned steps run required containers and mounts source folder and can be used for development and experimenting. For more check support/examples configs for more production-ready setup., (*6)

Usage

  1. Generate API token
make api-key
  1. Create a blog post It is an markdown file with the following structure:
# Title (is required)

###### Meta Description: Blog Post Meta Description (Optional)
###### Meta Keywords: Blog Post Meta Keywords (Optional)
###### Published at: Publication date (Default is "now")

Here starts the content.
It also can contain an image
![](blog-post-url/some-image.png)

And a youtube video
[Video](https://www.youtube.com/embed/video_id?wmode=transparent)

The publisher also supports images and other files, including the cover file. They should be stored in the directory with the same name as the blog, but without ".md". For example:, (*7)

/path/to/dir/with-blog-files/ Category/Subcategory/blog-post-url/
  1. Publish the blog post
HOST=https://blog.url API_TOKEN=your_api_token src/publisher/src/main.mjs add /path/to/dir/with-blog-files/ Category/Subcategory/blog-post-url.md

Development

Build docker images

make build

Publish to dockerhub

make publish

Publish to BlogBundle to blog-bundle repository

make publish-blog-bundle

The Versions

01/02 2018

dev-master

9999999-dev

The "Symfony Standard Edition" distribution

  Sources   Download

MIT

The Requires

 

The Development Requires

symfony cms blog

01/02 2018

v3.0.4

3.0.4.0

The "Symfony Standard Edition" distribution

  Sources   Download

MIT

The Requires

 

The Development Requires

14/01 2018

v3.0.0

3.0.0.0

The "Symfony Standard Edition" distribution

  Sources   Download

MIT

The Requires

 

The Development Requires

13/06 2017

v1.0.0

1.0.0.0

The "Symfony Standard Edition" distribution

  Sources   Download

MIT

The Requires

 

The Development Requires

27/06 2016

v0.1.1

0.1.1.0

Simple Symfony blog/cms

  Sources   Download

MIT

The Requires

 

The Development Requires

harentius blog symfony cms