Skip to content

Commit c38b17a

Browse files
committed
Added documentation
1 parent 32bd190 commit c38b17a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
## Documentation for Venus (fj-doc) Project
22

3-
Documentation is under construction
3+
**Intro**
4+
Venus defines a [xml meta model document](fj-doc-base/src/main/resources/config/doc-1-10.xsd), providing some simple formatting structures (paragraphs, tables, list).
5+
Those meta model can be rendered in different output formats using modules called type handlers. (PDF, HTML, XLSX, Markdown ecc).
6+
Here is the github project [README](README.md).
47

5-
Currently it's possible to refer to quickstart project for info and examples :
8+
A quickstart project is also available for info and examples :
69
**fj-doc-quickstart** - [github project](https://github.com/fugerit-org/fj-doc-quickstart) - [documentation](https://venusqs.fugerit.org/)
710

811
**You can also check :**

0 commit comments

Comments
 (0)