DocGen¶
We can generate nice Markdown documentation for our example Library model, including a Graph in either Mermaid.JS or Graphwiz format.
$ ./enola docgen --model file:docs/use/library/model.yaml --diagram=mermaid >docs/use/docgen/docgen.md
docgen.md¶
Models¶
classDiagram
direction RL
class Book{
🆔 library
🆔 isbn
🆔 copy
}
link Book "#demo.book"
Book -- Library : library
Book -- Book_kind : kind
class Book_kind{
🆔 isbn
🔗 google
}
link Book_kind "#demo.book_kind"
class Library{
🆔 id
}
link Library "#demo.library"
class Entity_kind{
🆔 name
}
link Entity_kind "#enola.entity_kind"
class Schema{
🆔 fqn
}
link Schema "#enola.schema"
📖 demo.book
(Book (Copy)) ¶
- library
- isbn
- copy
Related Entities¶
📗 demo.book_kind
(Book (Kind)) ¶
- isbn
Links¶
google
Google Book Search ⇝ https://www.google.com/search?tbm=bks&q=isbn:{path.isbn}
📚 demo.library
(Library) ¶
- id
🕵🏾♀️ enola.entity_kind
(Enola.dev Entity Kind) ¶
- name
💠 enola.schema
(Schema (Proto) used in Enola Entity Data) ¶
- fqn
This model documentation was generated with ❤️ by Enola.dev @ 886a2c5