sake92 / hepek-examples

Self-contained examples of using hepek
https://sake92.github.io/hepek-examples/
6 stars 4 forks source link

Add Markdown example #4

Closed sake92 closed 6 years ago

sake92 commented 6 years ago

This one is piece of cake. There is support for Commonmark flavored markdown in Hepek.
Examples should be clear and simple. E.g. showing how to bold text, italic, code snippet, bullets, numberings, newline etc.

Feel free to ask questions if something isn't clear. 🙂

jerdog commented 6 years ago

I'll take this one - where do you anticipate having this? As its own thing or in a specific README file?

sake92 commented 6 years ago

@jerdog It needs to be an example like these here.
Make a folder markdown and in it a file MarkdownExample.scala.
It should extend StaticPage and BasicComponents.

Just override pageContent and you're ready to go! 🙂
See this example for help: https://github.com/sake92/hepek-starter/blob/master/src/main/scala/site/About.scala

jerdog commented 6 years ago

Got it - ok. I will let someone else take, but it's good to understand what it is you're wanting help with.

Mera-Gangapersaud commented 6 years ago

I would like to work on this.

sake92 commented 6 years ago

@Mera-Gangapersaud let me know if you need any help! 😉