Skip to content

Armoghan-ul-Mohmin/Hugo-Blowfish-Decap-CMS-Starter

Repository files navigation

Hugo Blowfish Decap CMS Module 🚀


Codacy Security Scan CodeQL Dependency review Minimum Hugo Version GitHub code-size Blowfish

Hugo Blowfish Decap CMS Module is a Content Management System designed to work seamlessly with the Blowfish Theme, a popular website builder theme. It leverages the power of Decap CMS and integrates with Netlify Identity to provide a comprehensive content management solution for your website projects.

Features

  • Blowfish Theme Integration: Decap CMS is specifically tailored to integrate smoothly with the Blowfish Theme, ensuring a cohesive and intuitive content management experience.
  • User-Friendly Interface: Decap CMS provides a user-friendly interface that allows content editors and administrators to manage website content efficiently without requiring technical expertise.
  • Netlify Identity Integration: With Netlify Identity integration, Decap CMS offers secure authentication and user management capabilities, allowing you to control access to content editing features based on user roles.
  • Flexible Content Management: Easily create, edit, and publish content such as pages, posts, media files, and more using Decap CMS. The system provides flexible content structuring options to suit your website's needs.

Getting Started

To get started with Decap CMS and the Blowfish Theme integration:

  1. Clone the Repository: Clone the Blowfish Theme repository and set up your local development environment following the theme's documentation. For detailed instructions on installing the Blowfish Theme, refer to the Blowfish Theme Installation Documentation.

  2. Install Decap CMS Module:

    • Follow the instructions in the Hugo-Blowfish-Decap-CMS-Module-Repository to install the Decap CMS module within your project.
    • Configure the integration settings for the Blowfish Theme to ensure seamless compatibility.

Install Decap CMS Module

Edit your project's configuration file based on the format you are using (YAML, TOML, or JSON) to import the Hugo-Blowfish-Decap-CMS-Module module:

config/_default/config.toml

    [module]
    [[module.imports]]
    path = "github.com/Armoghan-ul-Mohmin/Hugo-Blowfish-Decap-CMS-Module"

config/_default/config.yaml

   module:
     imports:
       - path: github.com/Armoghan-ul-Mohmin/Hugo-Blowfish-Decap-CMS-Module

config/_default/config.json

    {
    "module": {
        "imports": [
        {
            "path": "github.com/Armoghan-ul-Mohmin/Hugo-Blowfish-Decap-CMS-Module"
        }
        ]
    }
    }
  1. Configure Parameters:
  • Edit the config/_default/params.toml file to define parameters for your project. For example:
     # Decap Cms Settings
     DecapSettings = true
     # Blowfish Theme Settings
     BlowfishSettings = true
    [DecapCMS]
     development = true
     # branch = ""
     media = "/static/images"
     public = "/images"
     PublishMode = "editorial_workflow"
     # logo = ""
     preview = true
     search = false
     Cheatsheets = true
     Tutorials = true

config/_default/params.yaml

    # Decap Cms Settings
    DecapSettings: true
    # Blowfish Theme Settings
    BlowfishSettings: true
    DecapCMS:
     development: true
     # branch: ""
     media: "/static/images"
     public: "/images"
     PublishMode: "editorial_workflow"
     # logo: ""
     preview: true
     search: false
     Cheatsheets : true
     Tutorials : true

config/_default/params.json

{
 // Decap CMS Settings
 "DecapSettings": true,
 // Blowfish Theme Settings
 "BlowfishSettings": true,
 "DecapCMS": {
   "development": true,
   // "branch": "",
   "media": "/static/images",
   "public": "/images",
   "PublishMode": "editorial_workflow",
   // "logo": "",
   "preview": true,
   "search": false,
   "Cheatsheets" : true,
   "Tutorials" : true
 }
}
    

Update the parameters according to your project's requirements.

  1. Configure Netlify Identity: If you plan to deploy your website on Netlify, configure Netlify Identity to enable user authentication and access control for Decap CMS.
  2. Start Managing Content: Once everything is set up, you can start managing your website's content using Decap CMS. Create pages, add media, and manage user access as needed.

Documentation

For detailed documentation and guides on using Decap CMS with the Blowfish Theme and Netlify Identity, refer to the following resources:

Support and Feedback

If you encounter any issues, have questions, or want to provide feedback, please open an issue in the respective repositories or contact the project maintainers.

Contributing

Feel free to contribute by submitting issues or pull requests.

License

This project is licensed under the MIT License.

About

Hugo Module for blowfish theme to Use Decap CMS

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published