Skip to content

Commit

Permalink
Added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fugerit79 committed Nov 17, 2022
1 parent 32bd190 commit c38b17a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
## Documentation for Venus (fj-doc) Project

Documentation is under construction
**Intro**
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).
Those meta model can be rendered in different output formats using modules called type handlers. (PDF, HTML, XLSX, Markdown ecc).
Here is the github project [README](README.md).

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

**You can also check :**
Expand Down

0 comments on commit c38b17a

Please sign in to comment.