diff --git a/README.md b/README.md index 269deae..4fac3b0 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,19 @@ This tool was made so I could write my content only in `gmi` and publish both a gemini capsule and a website. -For now, this is very rudimentary and things are bound to change, especially the way -I structure the directory where my content lives. +For now, this is very rudimentary and things are bound to change... and break from +version to version. + +## Features + +- generates HTML from gemtext +- can synchronise your files with your server using rsync + +## Notes on usage + +Good practice for gemini dictates that we don't use multiple `h1` titles in one page +and for that reason, the last (and therefore the first) `h1` title encountered will +be used as the title of the HTML page. ## TODO @@ -23,12 +34,14 @@ I structure the directory where my content lives. - [ ] move config file to `~/.config` with placeholder values - [X] check for a config file in `~/.config` - [ ] maybe save the old Bash script somewhere for posterity ? +- [ ] reorganise the directory where the content is ## My setup + My current folder structure for my capsule+website looks something like this: ``` -my-internet +myinternet ├── assets │ ├── favicon.ico │ └── style.css @@ -37,9 +50,20 @@ my-internet │ │ └── index.gmi │ ├── index.gmi │ └── projects.gmi -├── footer.gmi -├── html-output -└── html-parts - ├── footer-part.html - └── header-part.html +├── gmi-helper +│ └── footer.gmi +├── html-helper +│ ├── footer-part.html +│ └── header-part.html +├── README.md +└── web + ├── favicon.ico + ├── gemlog + │ └── index.html + ├── index.html + ├── projects.html + └── style.css ``` + +This is only meant as a reference if my code isn't clear enough and had too much +implicits