staticman.yml

# 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.
comments:
  # List of allowed origins
  allowedOrigins: ["localhost", "plutus-community.readthedocs.io"]

  # (*) 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", "message", "subscribe", "replying_to_uid"]

  # (*) REQUIRED
  #
  # Name of the branch being used. Must match the one sent in the URL of the
  # request.
  branch: main

  # Text to use as the commit message or pull request title. Accepts placeholders.
  commitMessage: "Comment from {fields.name} on {options.key}"

  # (*) REQUIRED
  #
  # Destination path (filename) for the data files. Accepts placeholders.
  filename: "{@date:YYYY-MM-DD_HH-mm-ss}"

  # 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"

  # 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: false
    author: "name"
    authorEmail: "email"
    content: "message"
    type: "comment"

  # Name of the site. Used in notification emails.
  name: "Plutus Community Docs"

  # 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:
    # Disable notifications
    enabled: false

  # (*) REQUIRED
  #
  # Destination path (directory) for the data files. Accepts placeholders.
  path: "docs/_comments/{options.key}"

  # Names of required fields. If any of these isn't in the request or is empty,
  # an error will be thrown.
  requiredFields: ["name", "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:
    enabled: true
    siteKey: "6LflJp4fAAAAALfOUV-Uvv3dKr2vF3bxokaMepwx"
    secret: "adjYxki/QvUIxJxgnUcIEdFiwBuf08i4peRF8z4rGDx3PqXfjo0Oun7XB4eg5qMkfDxziCG2uUGIGY1LXOEFR2C1uf+Rq8TTqwiAxx9jTv0CyCYk2UAO9UL+CuKzisxSc/xNpxJtaNcYUZ8A6BFAFphwiME4Cvfy7JkHQVaKOdxGz7cC6G/0pHWRlfnO04bLuXAMb0gpmnVbJzJ2YJIg68L/Vf1gWtJ3UhbIifGSd9hcW0iiPv8ZaBokvZmjufb77kmV0b3wbDFGIGY0P58NfrB+gUdzpQ2+TwJVINRW14gVRjFZgoBZPhfZfetLeKBMFB/UV9A/wRYVHdKqcH5g3APtOe6BaXI4NjSo4LmRgLqtfAH5pTEiqYJMjYrNTN29F8v/5AJ5SCTKo2MMC8qhc3ajrkfGBoAYN9LvbFv/c8btHKl3wLs11Oui/DuCHaFqd6GE2t4hvRUJ24+68pE97KkbgpJh15xqFLcnwgiN+7ftFlcSDcuta6twaFtg4HWSpYZingkniXLUVInpKOuaQK+hGnrA6Bm7ACwNUTzj4D8j1eIohj8ok3r6dPS0OE6xI58CoUpZXTW3jOgkQXW17oNr6Ab/pZ6kR9cepESgpI5/4XT1JGWnPTp7WnEsB0S4FJSmigldVF8SN1qyoC1AqnKmRUzKrnw5giIblv69lb8="