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.

92 lines
1.4 KiB

6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
  1. # Blogo [![Go Report Card](https://goreportcard.com/badge/github.com/arnaucode/blogo)](https://goreportcard.com/report/github.com/arnaucode/blogo)
  2. Static blog generator, templating engine from markdown and html templates
  3. ## Use
  4. Directory structure:
  5. ```
  6. /
  7. ----blogo
  8. ----/blogo-input
  9. --------all the html, js, css files and folders
  10. ```
  11. To execute:
  12. ```
  13. ./blogo
  14. ```
  15. Example of blogo.json:
  16. ```json
  17. {
  18. "title": "my blog",
  19. "indexTemplate": "index.html",
  20. "postThumbTemplate": "postThumbTemplate.html",
  21. "posts": [
  22. {
  23. "thumb": "post01_thumb.md",
  24. "md": "post01.md"
  25. },
  26. {
  27. "thumb": "post02_thumb.md",
  28. "md": "post02.md"
  29. }
  30. ],
  31. "copyRaw": [
  32. "css",
  33. "js"
  34. ]
  35. }
  36. ```
  37. Example of input files:
  38. - index.html
  39. ```html
  40. <!DOCTYPE html>
  41. <html>
  42. <head>
  43. <title>[blogo-title]</title>
  44. </head>
  45. <body>
  46. [blogo-content]
  47. </body>
  48. </html>
  49. ```
  50. - postThumbTemplate.html
  51. ```html
  52. <div class="col-md-3">
  53. [blogo-index-post-template]
  54. </div>
  55. ```
  56. - post01_thumb.md
  57. ```
  58. # Post 01 thumb
  59. This is the description of the Post 01. This will appear on the main page, as the post description.
  60. ```
  61. - post01.md
  62. ```
  63. # Post 01
  64. This is the content of the Post 01. This content will appear when the Post 01 from the main page is clicked.
  65. ```
  66. Types of blogo tags:
  67. ```
  68. [blogo-title]
  69. [blogo-content]
  70. [blogo-index-post-template]
  71. ```