Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/i10416/petit
simple Laika theme for website
https://github.com/i10416/petit
laika scala ssg web
Last synced: 16 days ago
JSON representation
simple Laika theme for website
- Host: GitHub
- URL: https://github.com/i10416/petit
- Owner: i10416
- Created: 2022-01-20T12:35:56.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-06T12:21:35.000Z (almost 2 years ago)
- Last Synced: 2024-11-13T13:51:08.349Z (3 months ago)
- Topics: laika, scala, ssg, web
- Language: Scala
- Homepage:
- Size: 244 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/i10416/petit/actions/workflows/release.yaml)
## Laika Theme: Petit
Simple blog theme for Scala 2.12,2.13 and 3.
| scala 2.12 | scala 2.13 | scala 3 |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [](https://s01.oss.sonatype.org/content/repositories/snapshots/dev/i10416/petit_2.12/) | [](https://s01.oss.sonatype.org/content/repositories/snapshots/dev/i10416/petit_2.13/) | [](https://s01.oss.sonatype.org/content/repositories/snapshots/dev/i10416/petit_3/) |
### How to Use
build.sbt
```scala
libraryDependencies ++= Seq(
"org.planet42" %% "laika-core" % "0.18.2",
"org.planet42" %% "laika-io" % "0.18.2",
"dev.i10416" %% "petit" % "",
"org.typelevel" %% "cats-effect" % "3.3.11",
)
```
or ammonite scala script
or
```scala
import $ivy.`dev.i10416::petit:`
import $ivy.`org.planet42::laika-core:0.18.2`
import $ivy.`org.planet42::laika-io:0.18.2`
import $ivy.`org.typelevel::cats-effect:3.3.11`
```
Directory Structure
- ``
- article0
- README.md
- article1
- README.md
- ...
Script
```scala
import dev.i10416.petit.Petit
import cats.effect.{IO, Async, Sync, Resource}
import laika.format
import laika.io.api.TreeTransformer
import laika.directive.std.StandardDirectives
import laika.markdown.github.GitHubFlavor
import laika.parse.code.SyntaxHighlighting
import laika.api._
import cats.effect.unsafe.implicits.global
import laika.io.implicits._
def createTransformer[F[_]: Async]: Resource[F, TreeTransformer[F]] =
Transformer
.from(format.Markdown)
.to(format.HTML)
.parallel[F]
.withTheme(Petit)
.build
createTransformer[IO].use {
_.fromDirectory("").toDirectory("").transform
}.unsafeRunSync()
```
## How to contribute?
- Give it a star⭐
- Drop the feedback to the author @i10416
- Send a PR with fixes of typos/bugs/etc🐛
## License
Licensed under the Apache License, Version 2.0.
## todo
- publish
- [x] release snapshot
- [ ] release 0.0.1
- [x] sitemap generator
- [x] rss generator
- [ ] minify css
- see https://github.com/i10416/cssminifier
- [ ] automatically generate last modified date time
- [ ] link with ogp info directive
- [ ] add search
- [ ] add line numbers, line highlight,emphasize options for code blocks
- [ ] format scala code before transform
- [ ] enable `foo.ext:title` syntax for code blocks