decaporg / decap-cms

A Git-based CMS for Static Site Generators
https://decapcms.org
MIT License
17.67k stars 3.03k forks source link

Not able to use local_backend in a Hugo website #7030

Closed alanlivio closed 5 months ago

alanlivio commented 5 months ago

Describe the bug

I want to use the Hugo website[1] with local_backend[2]. My problem is where I can put the config.yml. The tutorial [1] says to put the config.yml at static/admin/config.yml while the tutorial[2] says to put it in the root. I tried to follow [2] using relative paths but I received the error below.

[1] https://decapcms.org/docs/hugo/ [2] https://decapcms.org/docs/beta-features/#working-with-a-local-git-repository

To Reproduce

  1. git clone https://github.com/HugoBlox/theme-academic-cv
  2. cd theme-academic-cv
  3. git apply theme-academic-cv-decap-cms.patch # theme-academic-cv-decap-cms.patch
  4. hugo server
  5. cd static/admin && npx decap-server # at other shell

Expected behavior Hugo app

Screenshots Screenshot 2024-01-11 204432

Applicable Versions:

CMS configuration

local_backend: true
backend:
  name: git-gateway
  branch: main
media_folder: ../../content/media
public_folder: /img
collections:
  - name: 'blog'
    label: 'Blog'
    folder: '../../content/post'
    create: true
    slug: '{{year}}-{{month}}-{{day}}-{{slug}}'
    editor:
      preview: false
    fields:
      - { label: 'Title', name: 'title', widget: 'string' }
      - { label: 'Publish Date', name: 'date', widget: 'datetime' }
      - { label: 'Description', name: 'description', widget: 'string' }
      - { label: 'Body', name: 'body', widget: 'markdown' }
alanlivio commented 5 months ago

I was able to find a solution from the Hugo theme document I am using, called Hugo Blox [1]. See below how to do it.

Although I found the solution, maybe it is a good indication to update the document about the local git backend. I suggest highlighting that the npx decap-server is independent of the config.yml location and should always run from the repository root.

[1] https://docs.hugoblox.com/getting-started/cms/decap/ [2] https://decapcms.org/docs/beta-features/#working-with-a-local-git-repository

To Reproduce

  1. git clone https://github.com/HugoBlox/theme-academic-cv
  2. cd theme-academic-cv
  3. git apply theme-academic-cv-decap-cms.patch # theme-academic-cv-decap-cms.patch
  4. hugo server
  5. npx decap-server # at other shell

CMS configuration at config/_default/params.yml

extensions:
  cms:
    branch: main
    publish_mode: editorial_workflow
    local_backend: true
martinjagodic commented 5 months ago

Hi @alanlivio I understand that you found a solution, so I am closing the issue. It also seems that this is more of pa problem with the Hugo theme docs, not Decap docs.