stampo

A static site/documentation generator.

License

License

GroupId

GroupId

ch.digitalfondue.stampo
ArtifactId

ArtifactId

stampo
Last Version

Last Version

1.2.2
Release Date

Release Date

Type

Type

jar
Description

Description

stampo
A static site/documentation generator.
Project URL

Project URL

https://github.com/digitalfondue/stampo
Source Code Management

Source Code Management

https://github.com/digitalfondue/stampo.git

Download stampo

How to add to project

<!-- https://jarcasting.com/artifacts/ch.digitalfondue.stampo/stampo/ -->
<dependency>
    <groupId>ch.digitalfondue.stampo</groupId>
    <artifactId>stampo</artifactId>
    <version>1.2.2</version>
</dependency>
// https://jarcasting.com/artifacts/ch.digitalfondue.stampo/stampo/
implementation 'ch.digitalfondue.stampo:stampo:1.2.2'
// https://jarcasting.com/artifacts/ch.digitalfondue.stampo/stampo/
implementation ("ch.digitalfondue.stampo:stampo:1.2.2")
'ch.digitalfondue.stampo:stampo:jar:1.2.2'
<dependency org="ch.digitalfondue.stampo" name="stampo" rev="1.2.2">
  <artifact name="stampo" type="jar" />
</dependency>
@Grapes(
@Grab(group='ch.digitalfondue.stampo', module='stampo', version='1.2.2')
)
libraryDependencies += "ch.digitalfondue.stampo" % "stampo" % "1.2.2"
[ch.digitalfondue.stampo/stampo "1.2.2"]

Dependencies

compile (9)

Group / Artifact Type Version
org.apache.tika : tika-core jar 1.19.1
com.google.jimfs : jimfs jar 1.1
net.sf.jopt-simple : jopt-simple jar 5.0.4
org.yaml : snakeyaml jar 1.23
com.mitchellbosecke : pebble jar 1.5.0
org.pegdown : pegdown jar 1.5.0
org.freemarker : freemarker jar 2.3.28
io.undertow : undertow-core jar 2.0.13.Final
org.jsoup : jsoup jar 1.11.3

test (3)

Group / Artifact Type Version
junit : junit jar 4.12
org.mockito : mockito-all jar 1.10.18
net.sourceforge.htmlunit : htmlunit jar 2.17

Project Modules

There are no modules declared in this project.

Stampo

A static website/documentation generator with an emphasis on multi language website. Build Status

Require Java8

Download

A full distribution with all the dependencies and shell/bat script is available in maven central.

Current release is stampo 1.2.1 Download zip

Install

Add in your PATH the bin directory. Or, if you move the shell/bat script, adjust the paths to the lib/stampo.jar accordingly.

Use

In your stampo project, for processing the site:

stampo

For running the embedded web server (it will listen to localhost:8080):

stampo serve

For checking the correctness:

stampo check

For visualizing the help:

stampo help

As a maven dependency

If you want to include stampo as a library, it's available from maven central:

<dependency>
	<groupId>ch.digitalfondue.stampo</groupId>
	<artifactId>stampo</artifactId>
	<version>1.2.2</version>
</dependency>

As a maven plugin

Stampo is available as a maven plugin, see https://github.com/digitalfondue/stampo-maven-plugin .

Features

  • easy multi language support
  • support for taxonomies
  • pagination over "pages" (for blog posts), over taxonomy values, over "static content" (for galleries).
  • draft support
  • support multiple template/rendering engine: markdown, pebble template, freemarker
  • support for recursive inclusion and structured pages, with Table of Contents extracted from the html: useful for documentations
  • layout system
  • embedded web server with auto reload on change

TODO

Documentation will come ASAP :).

Tested only on linux.

You can see an example at : https://github.com/nyx-arch/nyx-arch.github.io/tree/stampo-content . The master contain the output.

ch.digitalfondue.stampo

Versions

Version
1.2.2
1.2.1
1.2
1.1
1.0