simple

KO | EN

gitlite — search

#python #react #golang #rust #linux #docker #nodejs #macos #windows #awesome #vue #ios #openai #open-source

(★ 11)

The documentation verification tool to make sure that nothing is considered easy or simple.

simple 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# (Not so) ~~Simple~~
![psalm type coverage](https://shepherd.dev/github/m50/simple/coverage.svg)
![Code Validation](https://github.com/m50/simple/workflows/Code%20Validation/badge.svg)
[![styleci status](https://github.styleci.io/repos/238022831/shield)](https://github.styleci.io/repos/238022831)
[![Coverage Status](https://coveralls.io/repos/github/m50/simple/badge.svg?branch=trunk)](https://coveralls.io/github/m50/simple?branch=trunk)

[![Latest Stable Version](https://poser.pugx.org/m50/simple/v/stable)](https://packagist.org/packages/m50/simple)
[![Total Downloads](https://poser.pugx.org/m50/simple/downloads)](https://packagist.org/packages/m50/simple)
[![License](https://poser.pugx.org/m50/simple/license)](https://packagist.org/packages/m50/simple)

The documentation verification tool to make sure that nothing is considered easy or simple.

Run *Simple* in your CI process on your documentation to make sure you don't put
out any documentation that is condescending or unhelpful to learners. Everywhere
that *Simple* finds any of the problematic words, it may be a perfect case to
provide more detailed documentation.

It's like a unit test for your documentation.

## Usage

To use simple, run it from the command line providing the directory the documentation files reside in. Example:

To generate the default configuration file, run init:

```sh
simple init
```

Then you can just run it:

```sh
simple
```

![example image](https://raw.githubusercontent.com/m50/simple/trunk/imgs/example.png)

or specify a specific directory:

```sh
simple -f./docs/
```

To get a full list of options and flags, run the help command:

```sh
simple help
```

### In CI

In CI, it is recommended to run it like so:

```sh
simple --no-color --no-progress-bar --report-file=report.junit.xml
```

This will force a junit report to be generated, for use in your CI reporting system.

## Installation

Simple can either be installed as an executable PHAR, or as a composer dependency.

Alternatively, it can be used with docker for CI builds or locally.

### Docker:

The [docker image](https://hub.docker.com/r/marisa50/simple) is: `marisa50/simple`.

To run simple on your docs:

```sh
docker run --rm --interactive --tty -v "$(pwd):/app" -w="/app" ghcr.io/m50/simple:latest
```

### Phar:

```sh
wget -O simple.phar $(curl -s https://api.github.com/repos/m50/simple/releases/latest | jq -aM .assets[0].browser_download_url | tr -d '"')
chmod 755 simple.phar
mv simple.phar /usr/local/bin/simple
```

### Composer

```sh
composer global require m50/simple
```

simple

simple 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

simple

simple 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README