arnaucube
arnaucube/blogoExamplePublic Self-hosted repository
blogoExample/README.md
README.mdRaw
 1# blogoExample
 2This is an example of the use of blogo static blog engine (https://github.com/arnaucube/blogo).
 3
 4![blogo](https://raw.githubusercontent.com/arnaucube/blogoExample/master/blogo.png "blogo")
 5
 6- The input files are inside the folder `blogo-input`.
 7- The configuration file is the `blogo-input/blogo.json`
 8- The output files are generated and stored on the project directory
 9
10The directory structure is:
11```
12/
13----blogo --> the blogo binary file
14----/blogo-input
15--------all the html, js, css files and folders
16----output generated files
17```
18
19
20To generate the output, just need to execute `blogo`:
21```
22./blogo
23```
24
25
26## Configuration
27The config file `blogo.json` contains:
28```js
29{
30  "title": "Blogo example", // title showed in the html page
31  "relativePath": "", // by default empty, used when the blog is inside a
32                      // subdirectory of the web, for example www.website.com/blog,
33                      // in this case the 'relativePath' will be '/blog'
34  "indexTemplate": "index.html", // html template for all the blog pages (main and post pages)
35  "postThumbTemplate": "postThumbTemplate.html", // html template that will be used
36                                                 // in the main html page to show the
37                                                 // thumbs of the posts
38  "posts": [   // Array containing the different blog posts.
39               // The 'thumb' is the overview that
40               // will be shown in the main html page.
41               // The 'md' is the markdown file containing
42               // the complete post text
43    {
44      "thumb": "postaboutcats_thumb.md",
45      "md": "postaboutcats.md"
46    },
47    {
48      "thumb": "the-empty-cube_thumb.md",
49      "md": "the-empty-cube.md"
50    },
51    {
52      "thumb": "firstpost_thumb.md",
53      "md": "firstpost.md"
54    }
55  ],
56  "copyRaw": [ // array with the folders and files that will be copied raw to the output
57    "css",
58    "img",
59    "js"
60  ]
61}
62```