![\"Markdown](\"/img/widgets-markdown.png\")
This guide will walk you through how to integrate Netlify CMS with Hugo. This is a good place to start if you want to learn from the ground up how these two tools work together. If you want to get up-and-running quicker, you can use one of the pre-existing and amazing starter templates!
\nTo get started with Hugo, you should first install the command line tool. If you've already got it installed, you can skip this step. On MacOS and Linux you can do this with:
\nbrew install hugoTo test that it's successfully installed, you can try this command, to get a list of Hugo's options:
\nhugo helpCreate a new Hugo project and start it up using the following commands.
\nhugo new site <name-of-your-new-project>\ncd <name-of-your-new-project>\nhugo serverYou won't actually see anything, just yet, and that's because you don't have any template files. That's easily resolved. In the layouts/ directory, create a file index.html and put a basic HTML structure in there:
<!DOCTYPE html>\n<html lang=\"en\">\n <head>\n <meta charset=\"UTF-8\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n <meta http-equiv=\"X-UA-Compatible\" content=\"ie=edge\" />\n <title>Document</title>\n </head>\n <body>\n <h1>Nice. It's looking good already.</h1>\n </body>\n</html>You'll also add some files to the content/ and data/ directories to make sure git tracks them.
touch content/.keep data/.keepThis is as basic as you can get with a Hugo project. There's just enough here now for us to install Netlify CMS.
\nIn Hugo, static files that don't need to be processed by the build commands live in the static/ directory. You'll install the Netlify CMS admin and config files there. Create a directory admin/ and within it, create two files index.html and config.yml. In the index.html, add the following content:
<!DOCTYPE html>\n<html>\n <head>\n <meta charset=\"utf-8\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n <title>Content Manager</title>\n <!-- Include the script that enables Netlify Identity on this page. -->\n <script src=\"https://identity.netlify.com/v1/netlify-identity-widget.js\"></script>\n </head>\n <body>\n <!-- Include the script that builds the page and powers Netlify CMS -->\n <script src=\"https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js\"></script>\n </body>\n</html>In the config.yml file, you can add this basic configuration — you can customize as you see fit, this sample file is just to get you started.
backend:\n name: git-gateway\n branch: master # Branch to update (optional; defaults to master)\nmedia_folder: static/img\npublic_folder: /img\ncollections:\n - name: 'blog'\n label: 'Blog'\n folder: 'content/blog'\n create: true\n slug: '{{year}}-{{month}}-{{day}}-{{slug}}'\n editor:\n preview: false\n fields:\n - { label: 'Title', name: 'title', widget: 'string' }\n - { label: 'Publish Date', name: 'date', widget: 'datetime' }\n - { label: 'Description', name: 'description', widget: 'string' }\n - { label: 'Body', name: 'body', widget: 'markdown' }Note: You won't be able to access the CMS just yet — you still need to deploy the project with Netlify and authenticate with Netlify Identity. You'll handle this in the next few steps of this guide.
\nIt's now time to commit your changes and push to GitHub. You can run the following commands to initialize a git repository and push the changes so far.
\ngit init # Initialize a git repository\ngit add . # Add every file\ngit commit -m \"Initial Commit\" # Commit every file with the message 'Initial Commit'\ngit remote add origin https://github.com/YOUR_USERNAME/NEW_REPO_NAME.git # Create a new repo on GitHub and add it to this project as a remote repository.\ngit push -u origin master # Push your changesNow you can go ahead and deploy to Netlify. Go to your Netlify dashboard and click New site from Git. Select the repo you just created. Under Basic build settings, you can set the build command to hugo and the publish directory to public. Click Deploy site to get the process going.
Add the Netlify Identity Widget
\nYou've already added the Netlify Identity widget to our admin/index.html. The next thing to do is add the Netlify Identity widget to our site's index page. In layouts/index.html, we can add the following to the <head> tag on the page:
<script src=\"https://identity.netlify.com/v1/netlify-identity-widget.js\"></script>Once you've added this, make sure to push your changes to GitHub!
\nBack in your Netlify dashboard:
\nOnce you've reached this point, you should be able to access the CMS in your browser at http://localhost:1313/admin. You'll be prompted to add the URL of your Netlify site. Once you've added that URL, you can log in with an Identity account or with one of the External Providers you enabled in step 3 above. For the sake of this tutorial, you can create a blog post in the CMS, and publish it! Once you git pull in your project, the blog post will show up in the project at content/blog/<slugified-blog-post-title>.md.
And that's it! From this point on, it's just a matter of following the Hugo documentation for outputting the content from your content/ directory into templates! For more information on configuring Netlify CMS, feel free to check out the Netlify CMS configuration options documentation.
In your layouts/index.html file, you'll create an unordered list element and use a Hugo range to output all posts. Inside that range, you can add a list item element with each post title and a link to the post inside it.
Note: To learn more about Hugo's range function, check out the Hugo documentation.
<body>\n <h1>Nice. It's looking good already.</h1>\n <ul>\n {{ range (where .Pages \"Section\" \"blog\") }}\n <li>\n <a href=\"{{ .Permalink }}\">\n {{ .Title }}\n </a>\n </li>\n {{ end }}\n </ul>\n</body>That link won't work just right just yet. You'll need to make a single page layout for blog posts, so Hugo can create a page for the .Permalink to link to.
Create a file layouts/blog/single.html, and put the following content in there:
<!DOCTYPE html>\n<html lang=\"en\">\n <head>\n <meta charset=\"UTF-8\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n <meta http-equiv=\"X-UA-Compatible\" content=\"ie=edge\" />\n <title>{{ .Title }}</title>\n </head>\n <body>\n <h1>{{ .Title }}</h1>\n <p class=\"date\">{{ .Date }}</p>\n <p class=\"description\">{{ .Params.description }}</p>\n <article class=\"content\">\n {{ .Content }}\n </article>\n </body>\n</html>You can see this basic template includes all the fields you've specified in your Netlify CMS config.yml file. You can access any custom front-matter fields with .Params.<field-name>!
Components structure and Workflows
\nEditorial Workflow implementation
\ncreate-nuxt-appregisterPreviewStyleThe boolean widget translates a toggle switch input to a true/false value.
\nbooleanOptions:
\ndefault: accepts true or false; defaults to false when required is set to falseExample:
\n- {label: \"Draft\", name: \"draft\", widget: \"boolean\", default: true}The code widget provides a code editor (powered by Codemirror) with optional syntax awareness. Can output the raw code value or an object with the selected language and the raw code value.
\ncodeOptions:
\ndefault_language: optional; default language to useallow_language_selection: optional; defaults to false: allows syntax to be changedkeys: optional; sets key names for code and lang if outputting an object; defaults to { code: 'code', lang: 'lang' }output_code_only: set to true to output the string value only, defaults to falseExample:
\n- label: 'Code'\nname: 'code'\nwidget: 'code'Deprecation notice: the date widget has been deprecated and will be removed in the next major release. Please use the datetime widget instead.
\nThe date widget translates a date picker input to a date string. For saving date and time together, use the datetime widget.
\ndateOptions:
\ndefault: accepts a date string, or an empty string to accept blank input; otherwise defaults to current dateformat: optional; accepts Moment.js tokens; defaults to raw Date object (if supported by output format)dateFormat: optional; boolean or Moment.js tokens. If true use default locale format.timeFormat: optional; boolean or Moment.js tokens. If true use default locale format, false hides time-picker. Defaults to false.Example:
\n- label: 'Birthdate'\nname: 'birthdate'\nwidget: 'date'\ndefault: ''\nformat: 'MMM Do YY'The datetime widget translates a datetime picker to a datetime string. For saving the date only, use the date widget.
\ndatetimeOptions:
\ndefault: accepts a datetime string, or an empty string to accept blank input; otherwise defaults to current datetimeformat: sets storage format; accepts Moment.js tokens; defaults to raw Date object (if supported by output format)dateFormat: sets date display format in UI; boolean or Moment.js tokens. If true use default locale format.timeFormat: sets time display format in UI; boolean or Moment.js tokens. If true use default locale format, false hides time-picker.Example:
\n- label: \"Start time\"\n name: \"start\"\n widget: \"datetime\"\n default: \"\"\n dateFormat: \"DD.MM.YYYY\" # e.g. 24.12.2021\n timeFormat: \"HH:mm\" # e.g. 21:07\n format: \"LLL\"The file widget allows editors to upload a file or select an existing one from the media library. The path to the file will be saved to the field as a string.
\nfileOptions:
\ndefault: accepts a file path string; defaults to nullmedia_library: media library settings to apply when a media library is opened by the\ncurrent widgetallow_multiple: (default: true) when set to false, prevents multiple selection for any media library extension, but must be supported by the extension in useconfig: a configuration object that will be passed directly to the media library being\nused - available options are determined by the libraryExample:
\n- label: \"Manual PDF\"\n name: \"manual_pdf\"\n widget: \"file\"\n default: \"/uploads/general-manual.pdf\"\n media_library:\n config:\n multiple: trueHidden widgets do not display in the UI. In folder collections that allow users to create new items, you will often want to set a default for hidden fields, so they will be set without requiring an input.
\nhiddenOptions:
\ndefault: accepts any valid data type; recommended for collections that allow adding new itemsExample:
\n- {label: \"Layout\", name: \"layout\", widget: \"hidden\", default: \"blog\"}The image widget allows editors to upload an image or select an existing one from the media library. The path to the image file will be saved to the field as a string.
\nimageOptions:
\ndefault: accepts a file path string; defaults to nullmedia_library: media library settings to apply when a media library is opened by the\ncurrent widgetallow_multiple: (default: true) when set to false, prevents multiple selection for any media library extension, but must be supported by the extension in useconfig: a configuration object that will be passed directly to the media library being\nused - available options are determined by the libraryExample:
\n- label: \"Featured Image\"\n name: \"thumbnail\"\n widget: \"image\"\n default: \"/uploads/chocolate-dogecoin.jpg\"\n media_library:\n config:\n multiple: trueThe list widget allows you to create a repeatable item in the UI which saves as a list of widget values. map a user-provided string with a comma delimiter into a list. You can choose any widget as a child of a list widget—even other lists.
\nlistfields is specified, field containing a repeatable child widget, with controls for adding, deleting, and re-ordering the repeated widgets; if unspecified, a text input for entering comma-separated valuesOptions:
\ndefault: if fields is specified, declare defaults on the child widgets; if not, you may specify a list of strings to populate the text fieldallow_add: if added and labeled false, button to add additional widgets disappearscollapsed: if added and labeled false, the list widget's content does not collapse by defaultfield: a single widget field to be repeatedfields: a nested list of multiple widget fields to be included in each repeatable iterationExample (field/fields not specified):
- label: \"Tags\"\n name: \"tags\"\n widget: \"list\"\n default: [\"news\"]Example (allow_add marked false):
- label: \"Tags\"\n name: \"tags\"\n widget: \"list\"\n allow_add: false\n default: [\"news\"]Example (with field):
- label: \"Gallery\"\n name: \"galleryImages\"\n widget: \"list\"\n field: {label: Image, name: image, widget: image}Example (with fields):
- label: \"Testimonials\"\n name: \"testimonials\"\n widget: \"list\"\n fields:\n - {label: Quote, name: quote, widget: string, default: \"Everything is awesome!\"}\n - label: Author\n name: author\n widget: object\n fields:\n - {label: Name, name: name, widget: string, default: \"Emmet\"}\n - {label: Avatar, name: avatar, widget: image, default: \"/img/emmet.jpg\"}Example (collapsed marked false):
- label: \"Testimonials\"\n name: \"testimonials\"\n collapsed: false\n widget: \"list\"\n fields:\n - {label: Quote, name: quote, widget: string, default: \"Everything is awesome!\"}\n - {label: Author, name: author, widget: string }The map widget allows you to edit spatial data using an interactive map. Spatial data is saved as a GeoJSON string in WGS84 projection and is limited to a single geometry.
\nmapOptions:
\ndecimals: accepts a number to specify precision of saved coordinates; defaults to 7 decimalsdefault: accepts a GeoJSON string containing a single geometry; defaults to an empty stringtype: accepts one string value of Point, LineString or Polygon; defaults to PointExample:
\n- {label: \"Location\", name: \"location\", widget: \"map\" }The markdown widget provides a full fledged text editor - which is based on slate - that allows users to format text with features such as headings and blockquotes. Users are also allowed to write in markdown by simply flipping a switch.
\nPlease note: If you want to use your markdown editor to fill a markdown file contents after its frontmatter, you'll have to name the field body so the CMS recognizes it and saves the file accordingly.
markdownOptions:
\ndefault: accepts markdown contentminimal: accepts a boolean value, false by default. Sets the widget height to minimum possible.buttons: an array of strings representing the formatting buttons to display (all shown by default). Buttons include: bold, italic, code, link, heading-one, heading-two, heading-three, heading-four, heading-five, heading-six, quote, bulleted-list, and numbered-list.editorComponents: an array of strings representing the names of editor components to display (all shown by default). The image and code-block editor components are included with Netlify CMS by default, but others may be created and registered.Example:
\n- { label: 'Blog post content', name: 'body', widget: 'markdown' }This would render as:
\n
Please note: The markdown widget outputs a raw markdown string. Your static site generator may or may not render the markdown to HTML automatically. Consult with your static site generator's documentation for more information about rendering markdown.
"}},{"node":{"frontmatter":{"title":"number","label":"Number"},"html":"The number widget uses an HTML number input, saving the value as a string, integer, or floating point number.
\nnumbervalueType optionOptions:
\ndefault: accepts string or number value; defaults to empty stringvalueType: accepts int or float; any other value results in saving as a stringmin: accepts a number for minimum value accepted; unset by defaultmax: accepts a number for maximum value accepted; unset by defaultstep: accepts a number for stepping up/down values in the input; 1 by defaultExample:
\n- label: \"Puppy Count\"\n name: \"puppies\"\n widget: \"number\"\n default: 2\n valueType: \"int\"\n min: 1\n max: 101\n step: 2The object widget allows you to group multiple widgets together, nested under a single field. You can choose any widget as a child of an object widget—even other objects.
\nobjectOptions:
\ndefault: you can set defaults within each sub-field's configurationfields: (required) a nested list of widget fields to include in your widgetExample:
\n- label: \"Profile\"\n name: \"profile\"\n widget: \"object\"\n fields:\n - {label: \"Public\", name: \"public\", widget: \"boolean\", default: true}\n - {label: \"Name\", name: \"name\", widget: \"string\"}\n - label: \"Birthdate\"\n name: \"birthdate\"\n widget: \"date\"\n default: \"\"\n format: \"MM/DD/YYYY\"\n - label: \"Address\"\n name: \"address\"\n widget: \"object\"\n fields: \n - {label: \"Street Address\", name: \"street\", widget: \"string\"}\n - {label: \"City\", name: \"city\", widget: \"string\"}\n - {label: \"Postal Code\", name: \"post-code\", widget: \"string\"}The relation widget allows you to reference items from another collection. It provides a search input with a list of entries from the collection you're referencing, and the list automatically updates with matched entries based on what you've typed.
\nrelationOptions:
\ndefault: accepts any widget data type; defaults to an empty stringcollection: (required) name of the collection being referenced (string)displayFields: list of one or more names of fields in the referenced collection that will render in the autocomplete menu of the control. Defaults to valueField. For nested fields, separate each subfield with a . (E.g. name.first).searchFields: (required) list of one or more names of fields in the referenced collection to search for the typed value. Syntax to reference nested fields is similar to that of displayFields.valueField: (required) name of the field from the referenced collection whose value will be stored for the relation. Syntax to reference nested fields is similar to that of displayFields and searchFields. As valueField only allows for a single field, this parameter only accepts a string.multiple : accepts a boolean, defaults to falseoptionsLength: accepts integer to override number of options presented to user. Defaults to 20.Example (assuming a separate \"authors\" collection with \"name\" and \"twitterHandle\" fields with subfields \"first\" and \"last\" for the \"name\" field):
\n- label: \"Post Author\"\n name: \"author\"\n widget: \"relation\"\n collection: \"authors\"\n searchFields: [\"name.first\", \"twitterHandle\"]\n valueField: \"name.first\"\n displayFields: [\"twitterHandle\", \"followerCount\"]The generated UI input will search the authors collection by name and twitterHandle, and display each author's handle and follower count. On selection, the author name will be saved for the field.
\nThe select widget allows you to pick a string value from a dropdown menu.
\nselectOptions:
\ndefault: default values must be contained in options and are ignored otherwise
multiple: true enabled.label and value fields: accepts an object with label and value field or an array of such objects when multiple: true is enable. Defaults to no valueoptions: (required) a list of options for the dropdown menu; can be listed in two ways:
label and value fields: the label displays in the dropdown; the value is saved in the filemultiple: accepts a boolean; defaults to falsemin: minimum number of items; ignored if multiple is not truemax: maximum number of items; ignored if multiple is not trueExample (options as strings):
\n- label: \"Align Content\"\n name: \"align\"\n widget: \"select\"\n options: [\"left\", \"center\", \"right\"]Example (options as objects):
\n- label: \"City\"\n name: \"airport-code\"\n widget: \"select\"\n options:\n - { label: \"Chicago\", value: \"ORD\" }\n - { label: \"Paris\", value: \"CDG\" }\n - { label: \"Tokyo\", value: \"HND\" }Example (multiple):
\n- label: \"Tags\"\n name: \"tags\"\n widget: \"select\"\n multiple: true\n options: [\"Design\", \"UX\", \"Dev\"]\n default: [\"Design\"]Example (min/max):
\n- label: \"Tags\"\n name: \"tags\"\n widget: \"select\"\n multiple: true\n min: 1\n max: 3\n options: [\"Design\", \"UX\", \"Dev\"]\n default: [\"Design\"]The string widget translates a basic text input to a string value. For larger textarea inputs, use the text widget.
\nstringOptions:
\ndefault: accepts a string; defaults to an empty stringExample:
\n- {label: \"Title\", name: \"title\", widget: \"string\"}The text widget takes a multiline text field and saves it as a string. For shorter text inputs, use the string widget.
\ntextOptions:
\ndefault: accepts a string; defaults to an empty stringExample:
\n- {label: \"Description\", name: \"description\", widget: \"text\"}