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.

index.md 3.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. +++
  2. title = "Ergo"
  3. description = "A simple blog Theme focused on writing, inspired by svbtle"
  4. template = "theme.html"
  5. date = 2018-09-03T02:13:01-04:00
  6. [extra]
  7. created = 2019-04-06T11:27:43+02:00
  8. updated = 2018-09-03T02:13:01-04:00
  9. repository = "https://github.com/InsidiousMind/Ergo"
  10. homepage = "https://github.com/InsidiousMind/Ergo"
  11. minimum_version = "0.4.1"
  12. license = "MIT"
  13. demo = "https://ergo.liquidthink.net"
  14. [extra.author]
  15. name = "Andrew Plaza"
  16. homepage = "https://code.liquidthink.net"
  17. +++
  18. [ergo](http://ergo.liquidthink.net)
  19. ![Ergo Screenshot](https://i.imgur.com/l182IYg.jpg)
  20. A light, simple & beautiful Gutenberg theme made with a focus on writing. Inspired by sbvtle and Pixyll.
  21. Like both those web designs, Ergo is a theme that emphasizes content, but still tries to be stylish. Frankly, the design is
  22. most like sbvtle (http://sbvtle.com) but without the clever svbtle Engine, Javascript, community or kudos button (kudos is on the list of additions, though! But then i'll have to use JS...)
  23. If you find that you like all those things, please check out [svbtle](http://svbtle.com); this theme is meant as a lighter (free) alternative,
  24. and ergo's design will most likely diverge more in the future as this theme evolves with me and it's users (if there are any).
  25. This is not meant as a svbtle clone.
  26. Here's a timelapse:
  27. [![Ergo Creation Timelapse](https://img.youtube.com/vi/ogEjvM-v_-s/0.jpg)](https://www.youtube.com/watch?v=ogEjvM-v_-s)
  28. ## Installation
  29. Get [Gutenberg](https://www.getgutenberg.io/) and/or follow their guide on [installing a theme](https://www.getgutenberg.io/documentation/themes/installing-and-using-themes/).
  30. Make sure to add `theme = "ergo"` to your `config.toml`
  31. #### Check gutenberg version (only 0.4.1+)
  32. Just to double-check to make sure you have the right version. It is not supported to use this theme with a version under 0.4.1.
  33. ### how to serve
  34. go into your sites directory, and type `gutenberg serve`. You should see your new site at `localhost:1111`.
  35. ### Deployment to Github Pages or Netlify
  36. [Gutenberg](https://www.getgutenberg.io) already has great documentation for deploying to [Netlify](https://www.getgutenberg.io/documentation/deployment/netlify/) or [Github Pages](https://www.getgutenberg.io/documentation/deployment/github-pages/). I won't bore you with a regurgitated explanation.
  37. ### Customizing the Theme
  38. All colors used on the site are from `sass/colors.scss`. There's only about 5-6 colors total.
  39. Change them however you like! Feel free to go into theme and edit the colors. However, editing anything other than `sass/colors.scss` is strongly advised against. Continue at your own peril!
  40. #### Theme Options
  41. ```toml
  42. # Specify a profile picture to use for the logos in the theme. It can be svg, png, jpg, whatever, just make sure to copy the logo you want and put it in img/${YOUR_PROFILE}.*
  43. # and update your config.toml accordingly
  44. profile = 'profile.svg'
  45. # website, should not be preceded with `http://`
  46. website = "code.liquidthink.net"
  47. # github
  48. github = "InsidiousMind" # case does not matter
  49. # twitter
  50. twitter = "liquid_think"
  51. # email
  52. email = "${MY_EMAIL}@cool_domain.com"
  53. # instagram
  54. instagram = "${your_insta}"
  55. # youtube
  56. youtube = "${your_youtube_channel_id}"
  57. # if any social networks are missing from this list that you want added, open an issue. I will add it for you ASAP
  58. ```
  59. ## Features
  60. - [x] Pagination
  61. - [ ] Dynamic Color Schemes
  62. - [ ] Edit Colors in `config.toml`
  63. - [x] NoJS
  64. - [ ] Analytics
  65. - [ ] Comments?
  66. - [ ] Like button http://kudosplease.com/
  67. - [ ] categories?
  68. - [ ] related posts? (would meaningful related posts, or unmeaningful ones, be worth it w/o database?)
  69. - [ ] user-requested: Open a Issue, or, if you're feeling up to it, a Pull Request