sake92/hepek

Typesafe HTML templates and static site generator in pure Scala

hepek's Issues

Generator for resources/public static files

A very cool feature would be to have a macro that reads from src/main/public path and builds a tree of Resources.
E.g. if you have this tree:

site
    ├───images
    │       favicon.ico
    ├───scripts
    │       main.js
    └───styles
            main.css

it would generate this:

object resources {
  object site {
    object images {
      val favicon_ico = resource("favicon.ico")
    }
// ... etc
  }
}

---

Then you could say just resources.site.image.favicon_ico.ref to get the path to favicon.ico. 😃
Since .ref returns a relative path, this would be very helpful.

Explore "server-side" rendering options

We could get a performance benefit from not-loading all those prismjs mini scripts.

Prismjs supports server-side rendering, see "Usage with Node" section: https://prismjs.com/
We could feed the code through Nashorn or something: https://winterbe.com/posts/2014/04/05/java8-nashorn-tutorial/

Katex also supports it: https://katex.org/docs/api.html#server-side-rendering-or-rendering-to-a-string

Support for ZStream (or any other stream library)

I created an abstraction on top of scala.xml to serve content using ZIO.ZStream, so I can stream results from server instead of loading all content in memory and then flush to the client.

It would be really good to have a feature like that on your library.

Separate themes package

For now, there is only one theme for blogs, one used for sake.ba, bootstrap3 theme.
We should probably separate this to a theme package so users can find them more easily.

Reveal JS helpers

Would be cool to have helpers for Reveal JS presentation tool.
It should be rather easy since it is a closed world. 😄

Its markdown support isn't needed, since Hepek has it already.
Configuration should have corresponding case class and have sensible defaults.

Improve markdown support

There is basic support for markdown, with md method here.

I wouldn't include these:

• headers, since that already exists with blogging support and templates
• tables, ugly as hell
• links, already exists hyperlink method
• code, already exists with PrismJS, more powerful, typesafe -> extendable...
• blockquotes, unnecessary?

Maybe:

• lists, nesting looks nice, more readable than ul-li etc
• line breaks (hr tag)

Support for HTMX attributes

HTMX is a library to give the best UX using plain HTML following principles of hyper media
https://htmx.org/

I plan to use Hepek in combination with HTMX and Alpine, having direct DSL support will save lot of time, have better code and avoid errors at compilation

Re-add Play support

Play now supports scala 3 so I should revert removing it..

Add file snippet utils

E.g.

https://www.lihaoyi.com/Scalatex/#Highlighter

Write tests

Some unit tests wouldn't hurt, especially for components.
We should also consider Selenium or whatever HTML inspection tool is useful and simple.
For now we can try with String.contains or something like that. 😄

Remove implicits package object

The implicits package object originally had some implicits in it.
Now it only has aliases for commonly used classes and objects.

Its content could/should be moved to StaticBundle.
Also, then we could move HepekAliases also to Bundle definition... 🙂

That would leave user with just importing the Imports._ object, implicits not needed at all!

zio-http support

Integrate with Playframework

Hepek components shouldn't be limited to static pages only.
We should introduce an equivalent to StaticPage, DynamicPage.
With same abstractions, it should be possible to use all the goodies from hepek in a Play project.

add offline search

https://wiki.gpii.net/w/Technology_Evaluation_-_Static_Site_Search

https://github.com/krisk/fuse
https://github.com/nextapps-de/flexsearch
https://github.com/olivernn/lunr.js/

Consider other layout frameworks and CSS layout/grid techniques

There is an implementation for Bootstrap 3 grid layout.
It is nice and typesafe enough for this:
https://github.com/sake92/sake-ba-source/blob/c960161f7d377433b3ad9ea3dda2390b825b5479/sake-ba/src/main/scala/site/Index.scala#L90-L97

This approach is ratio-based i.e. ~percentage like behavior.
W3-CSS also looks nice.

There are other approaches also, for example fixed-pixels : stretch...
If someone is willing to implement CSS grid layout that would be a-awesome!!! 😄

Links checker

E.g.

https://github.com/untitaker/hyperlink

Maybe use JSoup and report issues

any chance of a 2.13 build?

PDF generator

Flyingsaucer looks promising.
Haven't tried it yet.

Urlify helper method doesnt handle all-caps string

• Input: "Dodavanje PATH varijabli"
• Result: "dodavanje-pat-h-varijabli"
• Expected: "dodavanje-path-varijabli"

This should be an easy bug to fix, here is the code.

Improve Bulma components

As suggested on Gitter channel Bulma components should:

• introduce h1.title, subtitle p.subtitle, quarter column;
• add a List component;
• spaces at the end of the existing CSS class names because of Scalatags behavior.

Support ScalaJS

While playing with https://github.com/sake92/ReScala-todomvc I realized it would indeed be useful to compile "hepek-components" to ScalaJS also... :)

PureCSS can't have arbitrary content in a row

As opposed to Bootstrap, in PureCSS, children of pure-g (Bootstrap's row) must be columns pure-u-*, see https://purecss.io/grids/

We should remove the row method that accepts arbitrary HTML.
I guess it can be added per-framework as desired...

Support for AlpineJS

AlpineJS is a super lightweight JS framework tied to the DOM
https://alpinejs.dev/

I plan to use Hepek in combination with HTMX and Alpine, having direct DSL support will save lot of time, have better code and avoid errors at compilation

Unify dependency declaration

Different CDNs provide different package names, folder layout, i.e. format:

unpkg

Uses unpkg.com/:package@:version/:file
Works for all npm packages.

cdnjs

Uses cdnjs.cloudflare.com/ajax/libs/:package/:version/:file

That's all nice and dandy, but the packages and file paths aren't same, let's see bootstrap 4 for example:
https://unpkg.com/[email protected]/dist/js/bootstrap.js
https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.0.0/js/bootstrap.js

Wow, just... WOW! 😢
"bootstrap" vs "twitter-bootstrap"
"/dist/js/bootstrap.js" vs "js/bootstrap.js"

Also, some npm packages aren't contained in "/dist" folder, so it's not a rule...
Anyone has an idea how to generalize this stuff? I guess it's not possible at all for now... 😄

Regarding Webjars it should be fairly easy. If they are consistent.

Here is my first attempt to generalize this.

Move releasing to GH Actions

It's faster and more reliable, AFAIK.

https://github.com/olafurpg/sbt-ci-release

PlantUML integration

Should be trivial to integrate:
http://plantuml.com/api

Seems like it can generate SVG and PNG. 😃 NEAT!
Soooo, we could use it to inline an SVG, or render it and call it by path, WOW! 😲

Http4s support

Multi-page StaticPage

An advanced feature that would be useful is to generate multiple files from one object.
A use-case is when you have multiple languages, multiple versions of "same" page.

IDK how that would look like, but I think we could pull it out with macros.
We need a class on which we should ~multiplex these pages/files.

Suppose we have a case class MyData(lang: String, version: String, content: Frag).
Then we could make an annotation macro @multipage and use it on an object that extends Renderable:

@multipage(MyMultipageParams)
object MyPage extends MyTemplate {

  // data would be defined by @multipage macro

  override def relPath = s"site/${data .lang}/bla/${data .version}/my-page.html"

  override def pageContent = data .content
}

object MyMultipageParams extends MultipageParams[MyData] {
  override def datas = List(
    MyData("en", "1", "sup?"),
    MyData("bs", "1", "ša mai?")
  )
}

This would render 2 pages:

• site/en/bla/1/my-page.html
• site/bs/bla/1/my-page.html

with corresponding contents.

Write documentation

In hepek, of course. 😛

Make indexPage in SiteSettings optional

This one is easy. Default to None, of course. https://github.com/sake92/hepek/blob/master/src/main/scala/ba/sake/hepek/html/structure/StaticPage.scala#L64