diff --git a/README.md b/README.md index 31f82dc..2d9eb82 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,51 @@ [](https://app.netlify.com/sites/villafleurie-site/deploys) +## Static Site Generator + +The entry point is located in the [main file](./lib/main.py). It should not be modified. + +The templates files must be located in the [templates](./templates) directory. +You can use template inheritance but not yet data injection. +### Configuration + +The configuration file ([config.json](./config.json)) is mandatory and should resemble: + +```json +{ + "name": "VillaFleurie", + "templates": [ + "index.html", + "t2-corail.html", + "t3-azur.html", + "contact.html", + "reservation.html" + ], + "outDir": "dist" +} +``` + +### Site Generation + +You can generate the site by running: + +```shell +python -m lib.main +``` + +### How to run the website + +It will generate the final files in the [dist](./dist) folder. +You can run the output files using a simple python server: + +```shell +cd dist && python -m http.server +``` + +### Deployment + +You can then deploy the site on any platform supporting static sites (Netlify,…) or your own VPS. + ## TODO - [X] Create a base template for the header and footer diff --git a/dist/index.html b/dist/index.html index 3e5b5c0..98ab14c 100644 --- a/dist/index.html +++ b/dist/index.html @@ -476,11 +476,6 @@ - - - - - @@ -704,7 +699,7 @@