diff --git a/README.md b/README.md index 7a7355e..1bc2c78 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,10 @@ # Blogo [![Go Report Card](https://goreportcard.com/badge/github.com/arnaucode/blogo)](https://goreportcard.com/report/github.com/arnaucode/blogo) Static blog generator, templating engine from markdown and html templates +![blogo](https://raw.githubusercontent.com/arnaucube/blogo/master/blogo.png "blogo") ## Use -Directory structure: - -``` -/ -----blogo -----/blogo-input ---------all the html, js, css files and folders -``` - -To execute: -``` -./blogo -``` - -Example of blogo.json: - -```json -{ - "title": "my blog", - "indexTemplate": "index.html", - "postThumbTemplate": "postThumbTemplate.html", - "posts": [ - { - "thumb": "post01_thumb.md", - "md": "post01.md" - }, - { - "thumb": "post02_thumb.md", - "md": "post02.md" - } - ], - "copyRaw": [ - "css", - "js" - ] -} -``` - - -Example of input files: -- index.html - -```html - - - - [blogo-title] - - - -[blogo-content] - - - -``` - -- postThumbTemplate.html - -```html -
- [blogo-index-post-template] -
- -``` - -- post01_thumb.md - -``` -# Post 01 thumb -This is the description of the Post 01. This will appear on the main page, as the post description. -``` - -- post01.md - -``` -# Post 01 -This is the content of the Post 01. This content will appear when the Post 01 from the main page is clicked. -``` - - -Types of blogo tags: - -``` -[blogo-title] -[blogo-content] -[blogo-index-post-template] -``` +A complete usage example can be found in this repo: https://github.com/arnaucube/blogoExample --- diff --git a/blogo-large.png b/blogo-large.png new file mode 100644 index 0000000..21ba6f5 Binary files /dev/null and b/blogo-large.png differ diff --git a/blogo.png b/blogo.png new file mode 100644 index 0000000..03ce820 Binary files /dev/null and b/blogo.png differ