Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
io7m committed May 5, 2024
1 parent 1f48477 commit 625953f
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ XSLT implementation of the structural documentation format.

## Features

* Extremely simple core language with roughly ~20 elements. Easy to learn!
* DocBook-like semantic tagging of terms without the need to memorize hundreds
of XML elements.
* Automatic tables of content, section and paragraph numbering.
* Full, strict XSD schema with mandatory validation of documents.
* XHTML Strict 1.0 output, in single or multi-page forms.
* Produces valid and strongly accessible XHTML, with captions and metadata for
screen readers. Tools automatically validate their own output and refuse to
produce invalid output.
* Written in Java 17 for platform independence.
* Fully documented command line tools for document processing.
* Maven plugin for processing documentation as part of a project build.
* Large, high-coverage test suite.
* [OSGi-ready](https://www.osgi.org/)
* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
* ISC license.
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ XSLT implementation of the structural documentation format.

## Features

* Extremely simple core language with roughly ~20 elements. Easy to learn!
* DocBook-like semantic tagging of terms without the need to memorize hundreds
of XML elements.
* Automatic tables of content, section and paragraph numbering.
* Full, strict XSD schema with mandatory validation of documents.
* XHTML Strict 1.0 output, in single or multi-page forms.
* Produces valid and strongly accessible XHTML, with captions and metadata for
screen readers. Tools automatically validate their own output and refuse to
produce invalid output.
* Written in Java 17 for platform independence.
* Fully documented command line tools for document processing.
* Maven plugin for processing documentation as part of a project build.
* Large, high-coverage test suite.
* [OSGi-ready](https://www.osgi.org/)
* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
* ISC license.
Expand Down
10 changes: 10 additions & 0 deletions src/site/resources/features.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

<div xmlns="http://www.w3.org/1999/xhtml">
<ul>
<li>Extremely simple core language with roughly ~20 elements. Easy to learn!</li>
<li>DocBook-like semantic tagging of terms without the need to memorize hundreds of XML elements.</li>
<li>Automatic tables of content, section and paragraph numbering.</li>
<li>Full, strict XSD schema with mandatory validation of documents.</li>
<li>XHTML Strict 1.0 output, in single or multi-page forms.</li>
<li>Produces valid and strongly accessible XHTML, with captions and metadata for screen readers. Tools automatically validate their own output and refuse to produce invalid output.</li>
<li>Written in Java 17 for platform independence.</li>
<li>Fully documented command line tools for document processing.</li>
<li>Maven plugin for processing documentation as part of a project build.</li>
<li>Large, high-coverage test suite.</li>
<li><a href="https://www.osgi.org/">OSGi</a>-ready</li>
<li><a href="https://en.wikipedia.org/wiki/Java_Platform_Module_System">JPMS</a>-ready</li>
<li>High-coverage automated test suite.</li>
Expand Down

0 comments on commit 625953f

Please sign in to comment.