Skip to content
README.md 2.44 KiB
Newer Older
# XWiki Rendering

[XWiki Rendering](http://rendering.xwiki.org/xwiki/bin/view/Main/) is a generic Rendering system that converts textual input in a given syntax (wiki syntax, HTML, etc) into another syntax (XHTML, etc).

XWiki Platform, XWiki Commons and XWiki Rendering are part of the [XWiki.org](http://www.xwiki.org/) software forge. They are released together and share the same version.

## Documentation
* [Documentation](http://rendering.xwiki.org/xwiki/bin/view/Main/)
* [API](http://platform.xwiki.org/xwiki/bin/view/DevGuide/API)
* [Development Zone](http://dev.xwiki.org/xwiki/bin/view/Community/)

## Download
The XWiki Rendering JARs are available in the [![Maven Central Repository](https://img.shields.io/maven-central/v/org.xwiki.rendering/xwiki-rendering.svg?maxAge=3600)](http://search.maven.org/#search|ga|1|g%3A%22org.xwiki.rendering%22).

## Release Notes
Read our [Release Notes](http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/).

## Tools
* [Continuous Integration](http://ci.xwiki.org/) setup launches a build for each commit
* [Issue Tracker](http://jira.xwiki.org/browse/XRENDERING) if you want to report an issue
* [Development Flow](http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices#HGeneralDevelopmentFlow) to see the full list of tools we use to build XWiki
* [![Revved up by Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.xwiki.org/scans)
## Project Statistics

![XWiki Rendering Activity](https://repobeats.axiom.co/api/embed/3dc6b0c01ac6d779d45a3c1173a59085153dca5a.svg "XWiki Rendering Activity")

Note that we're [using an issue tracker](http://jira.xwiki.org/browse/XRENDERING) other than GitHub Issues (hence the empty left column in the stats).

See the [Project Health page](https://dev.xwiki.org/xwiki/bin/view/Community/ProjectHealth) for more statistics about the XWiki project.

## Community

We're always looking for contributors!

You should read our [Get Involved Guide](https://dev.xwiki.org/xwiki/bin/view/Community/Contributing) or get in touch:
* [Forum](https://dev.xwiki.org/xwiki/bin/view/Community/Discuss)
* [Chat](https://dev.xwiki.org/xwiki/bin/view/Community/Chat)

You can follow the XWiki news in [our blog](https://www.xwiki.org/xwiki/bin/view/Blog/).

Thank you to all contributors:

<a href="https://github.com/xwiki/xwiki-rendering/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=xwiki/xwiki-rendering&max=5000" />
</a>