[Feature] Staticman v3 Support (#440)
* Added Staicman support * Corrected template for staticman.yml * Edit for coherence with _includes/disqus.html * Updated documentation for Staticman * Updated License to give credits to Michale Rose * Update LICENSE * add more staticman details to readme * Clearer instructions about reCAPTCHA in YML * Nest reCAPTCHA param inside Staticman * Prepend all css selectors with .staticman-comments Edit suggested by theme owner to avoid CSS rules overriding. * Add myself to the change log * Update _config.yml
This commit is contained in:
parent
018bac4894
commit
d1c8b2fee1
14 changed files with 976 additions and 4 deletions
108
staticman.yml
Normal file
108
staticman.yml
Normal file
|
@ -0,0 +1,108 @@
|
|||
# Name of the property. You can have multiple properties with completely
|
||||
# different config blocks for different sections of your site.
|
||||
# For example, you can have one property to handle comment submission and
|
||||
# another one to handle posts.
|
||||
# To encrypt strings use the following endpoint:
|
||||
# https://{STATICMAN API INSTANCE}/v3/encrypt/{TEXT TO BE ENCRYPTED}
|
||||
# {STATICMAN API INSTANCE} defaults to staticman3.herokuapp.com
|
||||
|
||||
comments:
|
||||
# (*) REQUIRED
|
||||
#
|
||||
# Names of the fields the form is allowed to submit. If a field that is
|
||||
# not here is part of the request, an error will be thrown.
|
||||
allowedFields: ["name", "email", "url", "message"]
|
||||
|
||||
# (*) REQUIRED WHEN USING NOTIFICATIONS
|
||||
#
|
||||
# When allowedOrigins is defined, only requests sent from one of the domains
|
||||
# listed will be accepted. The origin is sent as part as the `options` object
|
||||
# (e.g. <input name="options[origin]" value="http://yourdomain.com/post1")
|
||||
# allowedOrigins: ["https://example.com"]
|
||||
|
||||
# (*) REQUIRED
|
||||
#
|
||||
# Name of the branch being used. Must match the one sent in the URL of the
|
||||
# request.
|
||||
branch: "master" # use "master" for user page
|
||||
#branch: "gh-pages" # use "gh-pages" for project page
|
||||
|
||||
commitMessage: "New comment by {fields.name}"
|
||||
|
||||
# (*) REQUIRED
|
||||
#
|
||||
# Destination path (filename) for the data files. Accepts placeholders.
|
||||
filename: "comment-{@timestamp}"
|
||||
|
||||
# The format of the generated data files. Accepted values are "json", "yaml"
|
||||
# or "frontmatter"
|
||||
format: "yaml"
|
||||
|
||||
# List of fields to be populated automatically by Staticman and included in
|
||||
# the data file. Keys are the name of the field. The value can be an object
|
||||
# with a `type` property, which configures the generated field, or any value
|
||||
# to be used directly (e.g. a string, number or array)
|
||||
generatedFields:
|
||||
date:
|
||||
type: "date"
|
||||
options:
|
||||
format: "iso8601" # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds"
|
||||
|
||||
# Whether entries need to be approved before they are published to the main
|
||||
# branch. If set to `true`, a pull request will be created for your approval.
|
||||
# Otherwise, entries will be published to the main branch automatically.
|
||||
moderation: true
|
||||
|
||||
# Akismet spam detection.
|
||||
# akismet:
|
||||
# enabled: true
|
||||
# author: "name"
|
||||
# authorEmail: "email"
|
||||
# authorUrl: "url"
|
||||
# content: "message"
|
||||
# type: "comment"
|
||||
|
||||
# Name of the site. Used in notification emails.
|
||||
# name: "Your Site"
|
||||
|
||||
# Notification settings. When enabled, users can choose to receive notifications
|
||||
# via email when someone adds a reply or a new comment. This requires an account
|
||||
# with Mailgun, which you can get for free at http://mailgun.com.
|
||||
# notifications:
|
||||
# Enable notifications
|
||||
# enabled: true
|
||||
|
||||
# (!) ENCRYPTED
|
||||
#
|
||||
# Mailgun API key
|
||||
# apiKey: ""
|
||||
|
||||
# (!) ENCRYPTED
|
||||
#
|
||||
# Mailgun domain (encrypted)
|
||||
# domain: ""
|
||||
|
||||
# (*) REQUIRED
|
||||
#
|
||||
# Destination path (directory) for the data files. Accepts placeholders.
|
||||
path: "_data/comments/{options.slug}" # (default)
|
||||
|
||||
# Names of required files. If any of these isn't in the request or is empty,
|
||||
# an error will be thrown.
|
||||
requiredFields: ["name", "email", "message"]
|
||||
|
||||
# List of transformations to apply to any of the fields supplied. Keys are
|
||||
# the name of the field and values are possible transformation types.
|
||||
transforms:
|
||||
email: md5
|
||||
|
||||
# reCAPTCHA (OPTIONAL)
|
||||
# Register your domain at https://www.google.com/recaptcha/ and choose reCAPTCHA V2
|
||||
# Use your OWN siteKey and secret.
|
||||
reCaptcha:
|
||||
enabled: false
|
||||
siteKey: "6Lcv8G8UAAAAAEqV1Y-XEPum00C_DxhD6O--qkFo"
|
||||
# (!) ENCRYPT reCaptcha secret key using Staticman /encrypt endpoint
|
||||
# i.e. https://staticman3.herokuapp.com/v3/encrypt/{your-site-secret}
|
||||
# For more information, https://staticman.net/docs/encryption
|
||||
secret: "p5uHlH9hCqpMJaGKXdt5MEWFo7K6fX8hoYUwR3aIafOI6rtItLauaDCkGOucysJtrVZy+sHffioGzMsOU64JFDSyPQgrXujegcOHFRXHhD4fOUuBXSvV+OZ8JhSPTGWaRcQcoiGX4pT5hlebLddOl59b6sn6kU1ODQcEbhP83xVLZlaTWOrNrF5Wvy3TMXpH5gyl1tZEORxADAShMYyUbNR7XZYLEg1DfgIBHfIg3cKwdFt7KVLejFGKIiBYRAZDE2JuHItNmzJ2x9JgSK3E+XnShV5tuWpncnyFonJVHGEky/zRfUVLHobDMcJ/u9nlZqE8u47W+833F1WaIYuwNw=="
|
Loading…
Add table
Add a link
Reference in a new issue