The open source living documentation generator of features files writen in Gherkin and Markdown support.
- Java JRE >= 8
- Check: All releases
Platform | Download |
---|---|
Windows x64 | pirilampo-gui-2.0.0.exe |
Any (Executable JAR) | pirilampo-gui-2.0.0.jar |
CLI | pirilampo-cli-2.0.0.jar |
java -jar pirilampo-cli-*.jar -projectSource /foo/bar/features
Available options:
Option | Description |
---|---|
compilationType | Compilation Type. Expected values: [FOLDER, FOLDER_DIFF, FEATURE]. Default: FOLDER |
compilationArtifact | Compilation Artifact. Expected values: [HTML, PDF]. Default: HTML |
projectSource | Folder or *.feature |
projectMasterSource | Folder to compare |
projectTarget | Target Folder |
projectName | Project Name. Default: Pirilampo |
projectVersion | Project Version. Default: 1.0 |
projectLogo | Image file for logo |
menuColor | Menu Color. Default: #14171A |
menuTextColor | Menu Text Color. Default: #DDDDDD |
htmlPanelToggle | Panel Toggle. Expected values: [CLOSED, OPENED]. Default: OPENED |
disableEmbedImages | Disable Emded Images? |
layoutPdf | Layout PDF. Expected values: [PORTRAIT,LANDSCAPE]. Default: PORTRAIT |
See at doc_exemplo
doc_exemplo/
├── feature/
│ └── Independência do Brasil/
│ └── 001 - Introdução.feature
│ └── 320px-Independence_of_Brazil_1888.jpg
└── html/
# language: pt
# encoding: utf-8
Funcionalidade: Introdução
**Independência do Brasil** é um processo que se estende de 1821 a 1825 e coloca em violenta oposição
o [Reino do Brasil](https://pt.wikipedia.org/wiki/Reino_do_Brasil) e o Reino de Portugal, dentro do Reino Unido de
Portugal, Brasil e Algarves. As Cortes Gerais e Extraordinárias da Nação Portuguesa, instaladas em 1820,
como uma consequência da Revolução Liberal do Porto, tomam decisões, a partir de 1821, que tinham como objetivo
reduzir novamente o Brasil ao seu antigo estatuto colonial.
Contexto:
Dado Antecedendo o processo de independência do Brasil, mas com fortes influências sobre o mesmo, ocorre a transferência da corte portuguesa para o Brasil.
| Proclamação da Independência |
| ![Image](320px-Independence_of_Brazil_1888.jpg) |
Feature/HTML | Folder/HTML | Feature/PDF |
---|---|---|
![]() |
![]() |
![]() |