Browse Source

Update doc

Brendan Abolivier 7 years ago
parent
commit
a9a8d81a3d
Signed by: Brendan Abolivier <contact@brendanabolivier.com> GPG key ID: 8EF1500759F70623
1 changed files with 3 additions and 1 deletions
  1. 3
    1
      README.md

+ 3
- 1
README.md View File

@@ -145,7 +145,7 @@ A custom field is defined in the `customFields` section of your settings file, a
145 145
 
146 146
 ## Templating
147 147
 
148
-Each e-mail sent by the form follows a template described in `template.pug` (it's [Pug](pugjs.org/)). If you want to change the way the e-mails you receive are displayed in your mailbox, just edit it! You don't even need to restart the server aftewards :smile:
148
+Each e-mail sent by the form follows a template described in `template.example.pug` (it's [Pug](pugjs.org/)). If you want to change the way the e-mails you receive are displayed in your mailbox, just edit it! You don't even need to restart the server aftewards :smile:
149 149
 
150 150
 The template also features custom fields, iterating over the `custom` object, containing the field's label and user-input value:
151 151
 
@@ -156,6 +156,8 @@ The template also features custom fields, iterating over the `custom` object, co
156 156
 }
157 157
 ```
158 158
 
159
+The template needs to be named `template.pug`. If no template could be found under this name, SMAM will use a default one, which features both default and custom fields, and should be sufficient for non-advanced usage.
160
+
159 161
 ## Personnalising
160 162
 
161 163
 As you might have already seen, the contact form is generated without any form of style except your browser's default one. But that doesn't meen that you have to add an ugly form to your site to receive contact e-mails, as every element has a specific id (beginning with the `form_` prefix), allowing you to use your own style on your contact form.