chipsenkbeil / grus

Static site generator written in Scala using Scalatags for templates and Flexmark for markdown.

grus

(G)enerate (R)esources (U)sing (S)cala

Static site generator written in Scala using Scalatags for templates and Flexmark for markdown.

Running

Via homebrew

Install via the following:

brew install chipsenkbeil/personal/grus

Then run on the command line via:

grus ...

Via binary

Grab one of the fat jars listed below and run via java -jar DOWNLOADED_JAR.jar.

• Built with Scala 2.10: Download latest
• Built with Scala 2.11: Download latest
• Built with Scala 2.12: Download latest

You can view help information by adding --help to the base jar or any of its commands. E.g. java -jar DOWNLOADED_JAR.jar --help or java -jar DOWNLOADED_JAR.jar generate --help.

Via sbt

To use in sbt (0.13.x) to generate your own content, add the following plugin:

addSbtPlugin("org.senkbeil" %% "sbt-grus" % "0.1.1")

• sbt grusSkeleton will create a new theme or website outline in the specified output directory
• sbt grusGenerate will generate the website and put the contents in an output directory
• sbt grusServe will generate the website and start a server to display it locally
• sbt grusPublish will publish the contents output from grusGenerate

You can add --help to any of the above commands to display help information for the specific command. E.g. sbt "grusGenerate --help".

Building a Theme

To use the API to create a custom theme, add the following dependency:

libraryDependencies += "org.senkbeil" %% "grus-layouts" % "0.1.1"

Examples

See the Scala Debugger docs module for an example of how to write a custom theme.

See the Scala Debugger grus.toml for an example of how to write a config file to fill in values.

grus's Issues

Help on publishSite does not stop from running

Doing something like sbt publishSite --help displays the help but continues parsing after.

Separate layout code from main code to reduce dependencies on creating themes

Add ability to compile local theme

In the case of an sbt target directory not existing, grus could try to compile the code via sbt and then check again. Not sure if this is overkill.

Add skeleton generation support

Something along the lines of grus init or grus create to be able to create a new repository with a grus.toml file and basic files to act as a skeleton hello world. Maybe provide a default theme as well.

Support Scala Native Build

Needs investigation, but I'm assuming all dependencies need to be supported by Scala Native.

• Work needed on project

  • Add Scala Native build support
    • Add sbt plugin for cross-build support (https://github.com/portable-scala/sbt-crossproject)
    • Update build setup to cross-build layout and core to native and JVM
  • Update code where necessary to exclude or use alternatives where blocked for native
  • Wait for Scala Native to support dynamic libraries so themes can be loaded on the fly

• Core Dependencies

  • Scalatags (demonstrated https://github.com/lihaoyi/scala-native-example-app)
    • Needed for
  • Scallop (indicated in README experimental support available)
    • Needed for CLI option support
  • Flexmark (Java dependency -- not possible?)
    • Needed to parse Markdown, metadata, etc.
  • Apache Commons IO (Java dependency -- not possible?)
    • Used for nicer file copying via org.apache.commons.io.FileUtils
    • Used for file filtering via org.apache.commons.io.filefilter.*

• Optional Dependencies

  • Toml4J (Java dependency -- not possible?)
    • This is used for config parsing and isn't a requirement to be supported
  • JGit (Java dependency -- not possible?)
    • This is used for publish support, which isn't a hard requirement, but is a nice to have
  • Coursier (in the works? coursier/coursier#458)
    • This is used to download theme jars from Maven, which isn't a hard requirement, but is a nice to have
  • Unfiltered (Scala dependency -- no support?)
    • This is used to serve content for local testing, which isn't a hard requirement, but is a nice to have
  • Slf4J-log4J (Java dependency -- no support?)
    • This is used purely for Unfiltered
  • Apache Commons Codec (Java dependency -- no support?)
    • This is used for the image resource loader, which is currently unused (dead code!)

Decide on a unique name

Just having site-generator as the name is a bit weak both for searching and when installing a binary. Should figure out a unique name to give the project and refactor accordingly.

Serving site does not allow exit via "pressing enter"

Previously, this was built into the jetty implementation. Not sure what changed, but it doesn't mention pressing enter, at least when in the sbt plugin. Have to Ctrl-c.

Default in help menu for maven repository is a Scala object

Looks like

--maven-theme-repository  <url>...   
The repositories to use when looking for Maven themes
(default = List(MavenRepository(https://repo1.maven.org/maven2,None,true,None)))

Should be human readable.

Running `publishSite` prints out a warning

When running publishSite on the Scala Debugger project docs, I'm seeing the following warning pop up at the beginning:

17/08/04 21:43:00 [WARN] o.e.j.u.FS - Exception caught during execution of command '[git, config, --system, --edit]' in '/usr/bin', return code '128', error message 'fatal: Could not switch to '/Library/Developer/CommandLineTools/usr/etc/': No such file or directory

This does not appear to be fatal and publishes anyway. This is being run on Mac OS X 10.9.5.

Support themes

Thought is a theme is merely an organization, artifact, and version that would be loaded via the Coursier API. Once the classes for a theme are in the tool, it's just a matter of loading them with the proper class loader like usual.

Scala Debugger project would publish its site theme? Or do we need a way to point to a target directory (after compiling to class files) as well?

Support implicit Scala version from theme

If given something like "org.senkbeil,my-theme,0.1.0", should convert to my-theme_2.10 or whatever version is associated with the tool itself via the BuildInfo data.

Add assembled jars to build

Assembly plugin was already added and worked earlier, but I forgot to include standalone jars, which would be good for binary packages like ArchLinux's pacman and Mac's homebrew.

Support optional arguments fed to layouts

Enable passing a map of key/value pairs that come from grus via --extra key=value or something that can be used in layouts. Example use case is to provide a pixel id as an extra argument. Can be included repeatedly via config file.