Hugolify Admin on Hugolify

Migration from v0.9

Mon, 01 Jan 0001 00:00:00 +0000

Overview

v1 introduces a two-layer architecture for blocks and a widget partial system that replaces raw YAML. These are breaking changes for any custom blocks, fields or collections.

Blocks

In v0.9, a custom block was a single YAML file directly in blocks:

layouts/partials/admin/blocks/
└── myblock.yml ← single file, raw YAML

In v1, each block requires two files:

layouts/partials/admin/blocks/
├── fields/
│ └── myblock.html ← returns field array
└── types/
 └── myblock.yml ← block config using widget partials

/layouts/partials/admin/blocks/fields/myblock.html

Setup

Mon, 01 Jan 0001 00:00:00 +0000

Install

/config/_default/module.yaml

imports:
 - path: github.com/hugolify/hugolify-admin

CMS params

/config/_default/params.yaml

# Default params
admin:

 cms: decapcms # optional, decapcms by default, list: https://www.hugolify.io/docs/cms/admin/cms/
 branch: main # optional, default "main"
 git: git-gateway # optional, default "git-gateway" but not supported for Sveltia CMS
 repo: # optional, e.g "hugolify/hugolify-template"

 config:
 id: false # use ID for dir/name files and relation
 nested:
 depth: 2 # optional, set minimum 2, not supported for Sveltia CMS
 preview: false
 publish_mode: simple # optional, default "simple"

 # Auth
 auth:
 app_id: # The Client ID provided by Gitea/GitLab
 api_root: # API URL of your Gitea/GitLab instance
 auth_endpoint: # Auth endpoint of your Gitea/GitLab instance
 base_url: # Root URL of your Gitea/GitLab instance
 netlify_identity: true # Add Netlify identity

 # Languages
 i18n:
 default_locale: en # master lang for an i18n website 
 locales: false # "[en,fr]" for an i18n website

 # Assets
 media:
 media_folder: 'assets/images/uploads'
 public_folder: '/images/uploads'
 audio_max_file_size: 700000 # 700ko
 max_file_size: 700000 # 700ko
 pdf_max_file_size: 5000000 # 5Mo
 specific_filter: false # set true to add a selected filter by image
 video_max_file_size: 5000000 # 5Mo

 # Optional cloud settings [start], not supported for Sveltia CMS
 cloud:
 name: cloudinary # or uploadcare
 cloud_name: # your cloudinary cloud name
 api_key: # your cloudinary api key
 publicKey: # your uploadcare public api key
 # Optional cloud settings [end]

 providers: # for sveltia-cms

CMS language

/config/_default/hugo.yaml

Collections

Mon, 01 Jan 0001 00:00:00 +0000

Collections are automatically added based on Hugolify modules added (Sections) or (Taxonomies)

Enable or disable collections

/config/_default/params.yaml

admin:
 collections:
 indexes:
 enable: true
 pages:
 enable: true
 # e.g. set to false to disable posts even if you load hugolify-theme-posts
 posts:
 enable: false
 # …

Enable or disable file creation

/config/_default/params.yaml

admin:
 collections:
 pages:
 create: false

Override fields avalaible for a collection

/config/_default/params.yaml

admin:
 collections:
 pages:
 fields:
 - is_draft
 - title_page
 - description
 - featured_image
 - body

Add filter

/config/_default/params.yaml

Blocks

Mon, 01 Jan 0001 00:00:00 +0000

Add or remove blocks

/config/_default/params.yaml

All blocks are available by default but if you want hide or add your blocks, you can do it:

params:
 admin:
 blocks:
 # Array of available blocks
 enable:
 - alert
 - cta
 - editorial
 # …

Add or remove fields in blocks

/config/_default/params.yaml

params:
 admin:
 blocks:
 # Array of available fields for a block
 # e.g with paragraph block
 paragraph:
 fields:
 - title
 - text_markdown
 # …

See Hugolify fields in repository

Create a block

Create file

Add a yml block file in blocks directory.

Fields

Mon, 01 Jan 0001 00:00:00 +0000

How to create a field

Create file

Add a yml field file in fields directory.

layouts/
└── partials/
 └── admin/
 └── fields/

{
 label: '',
 name: '',
 widget: '',
 required: false,
 i18n: true 
}

{{- $fields := slice 
 "title" 
 "text" 
 "image" -}}
# This line allows you to modify the fields via the parameters
{{- $fields = partial "admin/func/get_fields.html" (dict "block" . "fields" $fields) -}}
{
 label: '',
 name: '',
 widget: 'object',
 required: false,
 i18n: true,
 collapsed: true,
 {{ partial "admin/fields/_fields.yml" $fields }}
}

Use our relation field partial .

Shortcodes

Mon, 01 Jan 0001 00:00:00 +0000

Available for Decap CMS and Netlify CMS

Add or remove shortcodes

/config/_default/params.yaml

All shortcodes are available by default but if you want hide or add your shortcodes, you can do it:

params:
 admin:
 shortcodes:
 # Array of available shortcodes
 enable:
 - alert
 - badge
 - blank_link
 - blockquote
 - button
 - details
 - map
 - twitter
 - youtube

Disable shortcodes

/config/_default/params.yaml

params:
 admin:
 shortcodes:
 enable: false

Create a shortcodes

Create file

Add a js shortcode file in shortcodes directory.

Hugolify Admin on Hugolify

Migration from v0.9

Overview

Blocks

Setup

Install

CMS params

CMS language

Collections

Enable or disable collections

Enable or disable file creation

Override fields avalaible for a collection

Add filter

Blocks

Add or remove blocks

Add or remove fields in blocks

Create a block

Create file

Fields

How to create a field

Create file

Simple widget

List or Object widget

Relation widget

Shortcodes

Add or remove shortcodes

Disable shortcodes

Create a shortcodes

Create file