pirilampo

KO | EN

gitlite — search

#python #react #llm #go #golang #rust #deep-learning #docker #macos #windows #vue #pytorch #mcp #open-source

(★ 11)

The open source living documentation generator of features files writen in Gherkin and Markdown support.

pirilampo Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Pirilampo

The open source living documentation generator of features files writen in 
[Gherkin](https://cucumber.io/docs/gherkin/reference/) and Markdown support.

## Installation
- Java JRE >= 8
- Check: [All releases](https://github.com/clagomess/pirilampo/releases/latest)

| Platform             | Download                                                                                                           |
|----------------------|--------------------------------------------------------------------------------------------------------------------|
| Windows x64          | [pirilampo-gui-2.0.0.exe](https://github.com/clagomess/pirilampo/releases/download/v2.0.0/pirilampo-gui-2.0.0.exe) |
| Any (Executable JAR) | [pirilampo-gui-2.0.0.jar](https://github.com/clagomess/pirilampo/releases/download/v2.0.0/pirilampo-gui-2.0.0.jar) |
| CLI                  | [pirilampo-cli-2.0.0.jar](https://github.com/clagomess/pirilampo/releases/download/v2.0.0/pirilampo-cli-2.0.0.jar) |

## GUI running

## CLI

```
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               |

## Sample
### Folder structure
See at [doc_exemplo](https://github.com/clagomess/pirilampo/tree/new-pirilampo/readme_assets/doc_exemplo) 
```
doc_exemplo/
├── feature/
│   └── Independência do Brasil/
│       └── 001 - Introdução.feature
│       └── 320px-Independence_of_Brazil_1888.jpg
└── html/
```

### Feature: 001 - Introdução.feature
```feature
# 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](https://raw.githubusercontent.com/clagomess/pirilampo/master/320px-Independence_of_Brazil_1888.jpg) |
```

### Compilation type/artifact

| Feature/HTML                                                                                | Folder/HTML                                                                                 | Feature/PDF                                                                                 |
|---------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
| ![a](https://raw.githubusercontent.com/clagomess/pirilampo/master/readme_assets/img_02.png) | ![b](https://raw.githubusercontent.com/clagomess/pirilampo/master/readme_assets/img_03.png) | ![c](https://raw.githubusercontent.com/clagomess/pirilampo/master/readme_assets/img_04.png) |

pirilampo

pirilampo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pirilampo

pirilampo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README