Some documentation
All checks were successful
the build was successful

This commit is contained in:
Antoine Bartuccio 2018-07-14 13:19:06 +02:00
parent 0823d4a2b8
commit f24b1d2ed5
Signed by: klmp200
GPG Key ID: E7245548C53F904B
2 changed files with 7 additions and 3 deletions

View File

@ -4,7 +4,7 @@ Petit framework web en go pour des petites applications avec chargement des temp
Le framework se charche de servir les fichiers statiques (url: /static/) et, en mode debug, recharge automatiquement les templates. Le framework se charche de servir les fichiers statiques (url: /static/) et, en mode debug, recharge automatiquement les templates.
Le fichier de configuration est passé dans Configure et doit être au format json avec les paramètres suivants : Le fichier de configuration est passé dans `Configure()` et doit être au format json avec les paramètres suivants :
```json ```json
{ {
@ -21,4 +21,6 @@ Le fichier de configuration est passé dans Configure et doit être au format js
Le MainTemplate est utilisé pour charger tous les templates, il peut être utilisé tel quel ou modifié si vous savez ce que fous faites. Dans le doute, laissez celui par défaut. Le MainTemplate est utilisé pour charger tous les templates, il peut être utilisé tel quel ou modifié si vous savez ce que fous faites. Dans le doute, laissez celui par défaut.
On lance enfin le serveur en utilisant Start() On lance enfin le serveur en utilisant `Start()`
Pour charger un template, il faut utiliser `RenderTemplate()`

View File

@ -2,7 +2,7 @@
* @Author: Bartuccio Antoine * @Author: Bartuccio Antoine
* @Date: 2018-07-14 11:32:11 * @Date: 2018-07-14 11:32:11
* @Last Modified by: klmp200 * @Last Modified by: klmp200
* @Last Modified time: 2018-07-14 13:01:20 * @Last Modified time: 2018-07-14 13:18:53
*/ */
package gowebframework package gowebframework
@ -103,6 +103,8 @@ func loadTemplates() {
log.Println("Buffer allocation sucessful") log.Println("Buffer allocation sucessful")
} }
// Renders a template loaded. It allows templat "inheritance" and pass data into it
// Automatic reload if debug mode is enabled
func RenderTemplate(w http.ResponseWriter, name string, data interface{}) { func RenderTemplate(w http.ResponseWriter, name string, data interface{}) {
if ServerConfig.Debug { if ServerConfig.Debug {
loadTemplates() loadTemplates()