Minor aesthetic improvements for use in documentation

achiku / planter

Generate PlantUML ER diagram textual description from PostgreSQL tables

MIT License

546 stars 53 forks source link

Minor aesthetic improvements for use in documentation #22

Closed mmauger closed 3 years ago

mmauger commented 3 years ago

Add --title,-T option to add a diagram title
Use Creole formatting to:
- Make entity names bold
- Make column names monospace
- Make column descriptions italic
Update test.sh to be more portable
- Locate bash with /usr/bin/env
- Specify server location with PGHOST fallback to localhost
- Updated example with new output format

achiku commented 3 years ago

Thanks!

achiku commented 3 years ago

@mmauger By the way, I'm thinking to add user custom template option for planter since that makes this tool more backward compatible (more control for user side) and less possibility to have bikeshed discussion on which is better diagram . What do you think?

mmauger commented 4 weeks ago

@mmauger By the way, I'm thinking to add user custom template option for planter since that makes this tool more backward compatible (more control for user side) and less possibility to have bikeshed discussion on which is better diagram . What do you think?

Sorry for not seeing or responding to this earlier.

I completely agree with the approach. A simple configuration with that allows Creole formatting and conditional inclusion when data is available makes sense. But having gone down that road before, its always got subtle issues that make it more complex and intricate than intended. If there is anything I can do to help, let me know. Good luck