<commit_before># Livedoc

[![Bintray Download](https://img.shields.io/bintray/v/joffrey-bion/maven/livedoc-core.svg)](https://bintray.com/joffrey-bion/maven/livedoc-core/_latestVersion)
[![Maven central version](https://img.shields.io/maven-central/v/org.hildan.livedoc/livedoc-core.svg)](http://mvnrepository.com/artifact/org.hildan.livedoc/livedoc-core)
[![Build Status](https://travis-ci.org/joffrey-bion/livedoc.svg?branch=master)](https://travis-ci.org/joffrey-bion/livedoc)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/joffrey-bion/fx-gson/blob/master/LICENSE)

Livedoc is an annotation-based documentation generator for REST and websocket services.

It is based on the [JSONDoc](http://jsondoc.org) project, which seems abandoned by its author.<commit_msg>Improve README and add link to github pages<commit_after># Livedoc

[![Bintray Download](https://img.shields.io/bintray/v/joffrey-bion/maven/livedoc-core.svg)](https://bintray.com/joffrey-bion/maven/livedoc-core/_latestVersion)
[![Maven central version](https://img.shields.io/maven-central/v/org.hildan.livedoc/livedoc-core.svg)](http://mvnrepository.com/artifact/org.hildan.livedoc/livedoc-core)
[![Build Status](https://travis-ci.org/joffrey-bion/livedoc.svg?branch=master)](https://travis-ci.org/joffrey-bion/livedoc)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/joffrey-bion/fx-gson/blob/master/LICENSE)

[Livedoc](https://joffrey-bion.github.io/livedoc) is an annotation-based documentation generator for REST and websocket 
services, inspired by the [JSONDoc](http://jsondoc.org) project.

## How does it work?

Livedoc's goal is to generate a documentation of your API from your code. It comes in multiple flavours, depending 
on whether you are developing a standard Spring MVC app, a Spring Boot app, or using another framework.

Livedoc uses reflection to read your annotated classes and output a Java model representing the documentation. In 
most cases, this documentation is serialized to JSON, and may then be used by Livedoc's UI that you can host on your 
server to display a good-looking documentation to your users.

## Get started

Check out the [official documentation](https://joffrey-bion.github.io/livedoc) to get started with Livedoc.

## Credits

Credits to <NAME> for his great work on the original JSONDoc project, and to all contributors that helped 
him build JSONDoc up to version 1.2.17, which I started from.

Special thanks to @ST-DDT for his very constructive feedback, both on the original project and on Livedoc.

## License

This library is released under [the MIT license](https://github.com/joffrey-bion/fx-gson/blob/master/LICENSE).
{'fraction_non_alphanumeric': 0.1276595744680851, 'fraction_numerical': 0.001467351430667645, 'mean_word_length': 5.087053571428571, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 17, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1578585', 'n_tokens_mistral': 932, 'n_tokens_neox': 875, 'n_words': 225}