Document Markdown Preamble

[strau0106]

I'd appreciate the documentation of the preamble / front matter for advanced usages :)

[marcojakob]

What do you mean by "advanced usages"? Can you be more specific about what you would like to achieve?

[strau0106]

Direct use with hugo without netlify cms. I already host sepcific applications on my own service and I'd rather have all my sites together in one place, than one here and one there.

[marcojakob]

Ok. Then you should find everything in the Hugo Docs about Markdown Front Matter.

[strau0106]

No, your front matter variables aren't documented. You used custom front matter variables, which aren't documented apart from the netlify cms config

[marcojakob]

Ok, yes. But there are not that many that are not standard, I think it's only those two:

• pinned (boolean)
• footnotes (markdown field)

You'll find some more info in the CMS field definition:

fields:
      - {
          name: "title",
          label: "Titel",
          widget: "string",
          hint: "Beim ersten Speichern wird der Titel zur URL des Blogartikels.",
        }
      - {
          name: "date",
          label: "Datum",
          widget: "datetime",
          format: "YYYY-MM-DD",
          date_format: "DD.MM.YYYY",
          time_format: false,
        }
      - {
          name: "draft",
          label: "Entwurfsmodus",
          widget: "boolean",
          hint: "Einträge im Entwurfsmodus werden nicht angezeigt.",
          default: false,
        }
      - {
          name: "pinned",
          label: "Anheften",
          widget: "boolean",
          hint: "Angeheftete Einträge werden zuoberst vor den neusten Einträgen angezeigt.",
          default: false,
        }
      - {
          name: "tags",
          label: "Tags",
          widget: "list",
          required: false,
          pattern:
            [
              "^[^\\s#]+$",
              "Darf keine Leerschläge oder # enthalten. Mehrere Tags durch Komma trennen",
            ],
          hint: "Tags sind hilfreich, damit Besucher nach diesen filtern können. Mehrere Tags durch Komma trennen. Achtung: Darf keine Leerschläge oder # enthalten!",
        }
      - {
          name: "image",
          label: "Bild",
          widget: "image",
          required: false,
          hint: "Bild für Blogübersicht, Suchmaschinen und Social Media.",
          media_library: { config: { max_file_size: 256000 } },
        }
      - {
          name: "description",
          label: "Zusammenfassung",
          widget: "text",
          required: false,
          hint: "Kurze Beschreibung für Blogübersicht, Suchmaschinen und Social Media (ca. 2 Sätze).",
        }
      - {
          name: "body",
          label: "Inhalt",
          widget: "markdown",
          media_library: { config: { max_file_size: 512000 } },
        }
      - {
          name: "footnotes",
          label: "Fussnoten",
          widget: "markdown",
          minimal: true,
          buttons: ["bold", "italic", "link", "bulleted-list", "numbered-list"],
          editor_components: [],
          required: false,
          hint: "Kann für Quellenangaben oder andere Hinweise verwendet werden.",
        }

[strau0106]

Thanks!! Perfect

Am 26.05.2023 um 14:07 schrieb Marco Jakob @.***>:

 Ok, yes. But there are not that many that are not standard:

draft (boolean) pinned (boolean) tags (array) footnotes (markdown field) You'll find some more info in the CMS field definition:

fields:

• { name: "title", label: "Titel", widget: "string", hint: "Beim ersten Speichern wird der Titel zur URL des Blogartikels.", }
• { name: "date", label: "Datum", widget: "datetime", format: "YYYY-MM-DD", date_format: "DD.MM.YYYY", time_format: false, }
• { name: "draft", label: "Entwurfsmodus", widget: "boolean", hint: "Einträge im Entwurfsmodus werden nicht angezeigt.", default: false, }
• { name: "pinned", label: "Anheften", widget: "boolean", hint: "Angeheftete Einträge werden zuoberst vor den neusten Einträgen angezeigt.", default: false, }
• { name: "tags", label: "Tags", widget: "list", required: false, pattern: [ "^[^\s#]+$", "Darf keine Leerschläge oder # enthalten. Mehrere Tags durch Komma trennen", ], hint: "Tags sind hilfreich, damit Besucher nach diesen filtern können. Mehrere Tags durch Komma trennen. Achtung: Darf keine Leerschläge oder # enthalten!", }
• { name: "image", label: "Bild", widget: "image", required: false, hint: "Bild für Blogübersicht, Suchmaschinen und Social Media.", media_library: { config: { max_file_size: 256000 } }, }
• { name: "description", label: "Zusammenfassung", widget: "text", required: false, hint: "Kurze Beschreibung für Blogübersicht, Suchmaschinen und Social Media (ca. 2 Sätze).", }
• { name: "body", label: "Inhalt", widget: "markdown", media_library: { config: { max_file_size: 512000 } }, }
• { name: "footnotes", label: "Fussnoten", widget: "markdown", minimal: true, buttons: ["bold", "italic", "link", "bulleted-list", "numbered-list"], editor_components: [], required: false, hint: "Kann für Quellenangaben oder andere Hinweise verwendet werden.", } — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.