https://github.com/rafasf/docs-in-repo

Enabling code and lightweight documentation togethere
https://github.com/rafasf/docs-in-repo

documentation lightweight plantuml

Last synced: 4 months ago
JSON representation

Enabling code and lightweight documentation togethere

• Host: GitHub
• URL: https://github.com/rafasf/docs-in-repo
• Owner: rafasf
• License: mit
• Created: 2019-12-19T23:43:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-14T20:54:29.000Z (about 4 years ago)
• Last Synced: 2025-10-26T01:22:55.712Z (8 months ago)
• Topics: documentation, lightweight, plantuml
• Language: Makefile
• Size: 53.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Documents in (code) repository

Keep your code and a lightweight description of what it does together.

## Example

### Simple diagram

The source is [here](./diagrams/template.pu).

![simple template](./diagrams/template.png)

### C4 template

The source is [here](./diagrams/template-c4.pu).

![simple template](./diagrams/template-c4.png)