https://github.com/harentius/blog
Simple blog, on the top of https://github.com/harentius/blog-bundle
https://github.com/harentius/blog
Last synced: about 1 year ago
JSON representation
Simple blog, on the top of https://github.com/harentius/blog-bundle
- Host: GitHub
- URL: https://github.com/harentius/blog
- Owner: harentius
- License: mit
- Created: 2015-06-05T21:07:01.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-11-20T22:02:48.000Z (over 1 year ago)
- Last Synced: 2024-11-20T23:18:26.784Z (over 1 year ago)
- Language: PHP
- Homepage: https://folkprog.net/
- Size: 4.67 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support/dev/vhost.conf
Awesome Lists containing this project
README
# 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.
It consists of the following parts:
### 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](https://github.com/harentius/blog-bundle),
which is a subsplit of this engine.
### Markdown renderer and publisher (`src/publisher`)
Renders markdown and publish it in a blogging application.
## Installation
*Requirements: docker, make, nodejs (for publisher)*
1. Clone the repository
```
git clone git@github.com:harentius/blog.git
```
2. Start containers and do initial setup
```
make up
```
3. Build a DB schema
```
make build-db
```
4. Install npm modules for publisher
```
cd src/publisher && npm install
```
3. The blog application should be available on the address
[http://localhost:8080](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.
## Usage
1. Generate API token
```
make api-key
```
2. 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
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:
```
/path/to/dir/with-blog-files/ Category/Subcategory/blog-post-url/
```
3. 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
```