Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chipsenkbeil/grus
Static site generator written in Scala using Scalatags for templates and Flexmark for markdown.
https://github.com/chipsenkbeil/grus
cms flexmark scala scalatags static-site-generator
Last synced: 22 days ago
JSON representation
Static site generator written in Scala using Scalatags for templates and Flexmark for markdown.
- Host: GitHub
- URL: https://github.com/chipsenkbeil/grus
- Owner: chipsenkbeil
- License: apache-2.0
- Created: 2017-07-04T22:03:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-28T13:05:34.000Z (over 6 years ago)
- Last Synced: 2023-12-09T01:23:43.636Z (11 months ago)
- Topics: cms, flexmark, scala, scalatags, static-site-generator
- Language: Scala
- Homepage: http://get-grus.io
- Size: 85 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/chipsenkbeil/grus/releases/download/v0.1.1/grus-0.1.1-2.10.6.jar)
- Built with Scala 2.11: [Download latest](https://github.com/chipsenkbeil/grus/releases/download/v0.1.1/grus-0.1.1-2.11.8.jar)
- Built with Scala 2.12: [Download latest](https://github.com/chipsenkbeil/grus/releases/download/v0.1.1/grus-0.1.1-2.12.1.jar)
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:
```scala
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:
```scala
libraryDependencies += "org.senkbeil" %% "grus-layouts" % "0.1.1"
```
## Examples
See the
[Scala Debugger docs module](https://github.com/ensime/scala-debugger/tree/master/scala-debugger-docs)
for an example of how to write a custom theme.
See the
[Scala Debugger grus.toml](https://github.com/ensime/scala-debugger/tree/master/grus.toml)
for an example of how to write a config file to fill in values.