You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

62 lines
1.9 KiB

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