Skip to content

Latest commit

 

History

History
113 lines (76 loc) · 2.9 KB

README.md

File metadata and controls

113 lines (76 loc) · 2.9 KB

Hugoverse: Headless CMS for Hugo

Hugoverse is a headless CMS designed for Hugo, providing a seamless way to manage your static website content. With its powerful APIs, you can upload articles and resources like images, preview your site in real-time, and deploy it effortlessly to the cloud—all tailored to your selected Hugo theme.

🚀 Features

  1. Content Management API
    Easily upload and manage articles, images, and other resources through Hugoverse's API.

  2. Theme Compatibility
    Automatically adapts to your chosen Hugo theme, ensuring your site looks great without additional configuration.

  3. Live Preview
    Preview your Hugo site in real-time to ensure your content and design align before deploying.

  4. Cloud Deployment
    Deploy your site with a single click to the cloud, making it live and accessible instantly.

  5. Streamlined Resource Handling
    Efficiently manage images and files for your Hugo website, ensuring all assets are properly organized and accessible.

🌟 Getting Started

Follow these steps to start using Hugoverse for your Hugo project:

Prerequisites

  • Install Hugo on your machine.
  • Create or clone a Hugo site.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/hugoverse.git
cd hugoverse

  2. Install dependencies (if applicable):

    # Example: pipenv, npm, etc.

  3. Start the Hugoverse server:

    hugoverse serve

API Usage

Upload an Article:
Use the API to upload a markdown file.

curl -X POST -F "[email protected]" https://your-hugoverse-instance/api/upload

Upload Resources (e.g., images):

curl -X POST -F "[email protected]" https://your-hugoverse-instance/api/resources

Preview Your Site:
Visit https://your-hugoverse-instance/preview.

Deploy Your Site to the Cloud:

curl -X POST https://your-hugoverse-instance/api/deploy

📄 Documentation

Visit the Hugoverse Documentation for detailed guides and API references.

🛠️ Contributing

We welcome contributions from the community! Feel free to open issues, suggest features, or submit pull requests.

  1. Fork the repository.
  2. Create a feature branch: 
    git checkout -b feature-name
  3. Commit your changes: 
    git commit -m "Add new feature"
  4. Push the branch and open a pull request.

📝 License

Hugoverse is licensed under the MIT License.

✨ Contact

For questions or support, feel free to reach out:

Start building and managing your Hugo site effortlessly with Hugoverse! 🎉s