livedoc-ui-webjar

The Livedoc UI packaged in a webjar

Лицензия	Лицензия The MIT License
Группа	Группа org.hildan.livedoc
Идентификатор	Идентификатор livedoc-ui-webjar
Последняя версия	Последняя версия 5.3.0
Дата	Дата 22 мар. 2021 г.
Тип	Тип jar
Описание	Описание livedoc-ui-webjar The Livedoc UI packaged in a webjar
Ссылка на сайт	Ссылка на сайт https://github.com/joffrey-bion/livedoc
Система контроля версий	Система контроля версий https://github.com/joffrey-bion/livedoc

Скачать livedoc-ui-webjar

Имя Файла	Размер
livedoc-ui-webjar-5.3.0.pom
livedoc-ui-webjar-5.3.0.jar	10 KB
livedoc-ui-webjar-5.3.0-sources.jar	261 bytes
livedoc-ui-webjar-5.3.0-javadoc.jar	261 bytes
Обзор

Как подключить последнюю версию

Apache Maven

<!-- https://jarcasting.com/artifacts/org.hildan.livedoc/livedoc-ui-webjar/ -->
<dependency>
    <groupId>org.hildan.livedoc</groupId>
    <artifactId>livedoc-ui-webjar</artifactId>
    <version>5.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.hildan.livedoc/livedoc-ui-webjar/
implementation 'org.hildan.livedoc:livedoc-ui-webjar:5.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.hildan.livedoc/livedoc-ui-webjar/
implementation ("org.hildan.livedoc:livedoc-ui-webjar:5.3.0")

Apache Buildr

'org.hildan.livedoc:livedoc-ui-webjar:jar:5.3.0'

Apache Ivy

<dependency org="org.hildan.livedoc" name="livedoc-ui-webjar" rev="5.3.0">
  <artifact name="livedoc-ui-webjar" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.hildan.livedoc', module='livedoc-ui-webjar', version='5.3.0')
)

Scala SBT

libraryDependencies += "org.hildan.livedoc" % "livedoc-ui-webjar" % "5.3.0"

Leiningen

[org.hildan.livedoc/livedoc-ui-webjar "5.3.0"]

Зависимости

Библиотека не имеет зависимостей. Это самодостаточное приложение, которое не зависит ни от каких других библиотек.

Модули Проекта

Данный проект не имеет модулей.

Livedoc

Livedoc is a documentation generator for REST and websocket services, inspired by the JSONDoc project.

Livedoc tries to read all the doc from the code and the Javadoc. Annotations are considered a failure of Livedoc to grasp an aspect of the code. They should mostly be used to add what Livedoc couldn't read from the code, or override a piece of documentation that does not match the user's needs.

This is one of the reasons why it should be quick to add Livedoc to your project.

Get started

Check out the official documentation to get started with Livedoc.

Livedoc UI Demo

Try it yourself! Run the demo:

docker run -p 8080:8080 docker.io/hildan/livedoc-demo:latest

Then navigate to http://localhost:8080/livedoc/index.html to see what it looks like. You can see the code directly in this Github repository as the sample-app subproject.

Credits

Credits to @fabiomaffioletti 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.

Livedoc uses the therapi-runtime-javadoc library by @dnault for its Javadoc-related processing.

License

This library is released under the MIT license.

Версии библиотеки

Версия
5.3.0 22 мар. 2021 г.
5.2.0 14 авг. 2018 г.
5.1.1 10 авг. 2018 г.
5.1.0 9 авг. 2018 г.
5.0.1 8 авг. 2018 г.
5.0.0 25 мая 2018 г.
4.5.2 7 мая 2018 г.
4.5.1 7 мая 2018 г.
4.5.0 5 мая 2018 г.
4.4.2 5 мая 2018 г.
4.4.1 29 апр. 2018 г.
4.4.0 19 апр. 2018 г.
4.3.2 11 апр. 2018 г.
4.3.1 9 апр. 2018 г.
4.3.0 7 апр. 2018 г.
4.2.0 30 мар. 2018 г.
4.1.0 3 мар. 2018 г.
3.0.0 4 окт. 2017 г.
2.1.1 28 сент. 2017 г.
2.1.0 26 сент. 2017 г.
2.0.0 25 сент. 2017 г.
1.2.0 14 сент. 2017 г.
1.1.0 11 сент. 2017 г.
1.0.2 4 сент. 2017 г.
0.4.5 27 авг. 2017 г.
0.4.4 26 авг. 2017 г.
0.4.3 26 авг. 2017 г.
0.4.2 26 авг. 2017 г.
0.4.1 25 авг. 2017 г.
0.4.0 24 авг. 2017 г.
0.3.0 15 авг. 2017 г.
0.2.0 15 авг. 2017 г.

livedoc-ui-webjar

Лицензия

Группа

Идентификатор

Последняя версия

Дата

Тип

Описание

Ссылка на сайт

Система контроля версий