voorhoede/riotjs-style-guide

Improve readability of folder structure

phortuin opened this issue · 1 comments

When describing folder structure, please use some typographic characters to show the folder tree. Also use three back ticks without a syntax name, instead of tabs. Example below:

+-- modules
|   |-- dashboard
|   |   |-- dashboard.tag.html
|   |   |-- dashboard.less
|   |   `-- README.md
|   `-- <module_name>
|       |-- <module_name>.tag.html
|       |-- <module_name>.less
|       `-- README.md 
+-- pages
|   `-- <static_page>.html
+-- templates
|   |-- partials
|   |   |-- foot.mustache
|   |   |-- head.mustache
|   |   `-- <partial>.mustache
|   |-- bigscreen.html
|   |-- desktop.html
|   `-- <template>.html
`-- index.html

Yes. Looks better! Make the change after PR #18 ("Document your tag API" rule)? That's the last PR with a directory structure in it.