README
¶
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
-
Content Management API
Easily upload and manage articles, images, and other resources through Hugoverse's API. -
Theme Compatibility
Automatically adapts to your chosen Hugo theme, ensuring your site looks great without additional configuration. -
Live Preview
Preview your Hugo site in real-time to ensure your content and design align before deploying. -
Cloud Deployment
Deploy your site with a single click to the cloud, making it live and accessible instantly. -
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
-
Clone the repository:
git clone https://github.com/your-username/hugoverse.git cd hugoverse -
Install dependencies (if applicable):
# Example: pipenv, npm, etc. -
Start the Hugoverse server:
hugoverse serve
API Usage
Upload an Article:
Use the API to upload a markdown file.
curl -X POST -F "file=@article.md" https://your-hugoverse-instance/api/upload
Upload Resources (e.g., images):
curl -X POST -F "file=@image.png" 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.
- Fork the repository.
- Create a feature branch:
git checkout -b feature-name - Commit your changes:
git commit -m "Add new feature" - 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:
- Email: support@hugoverse.com
- Website: hugoverse.com
- GitHub Issues: Create an Issue
Start building and managing your Hugo site effortlessly with Hugoverse! 🎉s
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
interfaces/api/record/analytics
Package analytics provides the methods to run an analytics reporting system for API requests which may be useful to users for measuring access and possibly identifying bad actors abusing requests.
|
Package analytics provides the methods to run an analytics reporting system for API requests which may be useful to users for measuring access and possibly identifying bad actors abusing requests. |
|
pkg
|
|
|
bufferpool
Package bufferpool provides a pool of bytes buffers.
|
Package bufferpool provides a pool of bytes buffers. |
|
collections
Package collections contains common Hugo functionality related to collection handling.
|
Package collections contains common Hugo functionality related to collection handling. |
|
editor
Package editor enables users to create edit views from their content structs so that admins can manage content
|
Package editor enables users to create edit views from their content structs so that admins can manage content |
|
herrors
Package herrors contains common Hugo errors and error related utilities.
|
Package herrors contains common Hugo errors and error related utilities. |
|
hreflect
Package hreflect contains reflect helpers.
|
Package hreflect contains reflect helpers. |
|
loggers
package loggers contains some basic logging setup.
|
package loggers contains some basic logging setup. |
|
media
Package media contains Media Type (MIME type) related types and functions.
|
Package media contains Media Type (MIME type) related types and functions. |
|
output
Package output contains Output Format types and functions.
|
Package output contains Output Format types and functions. |
|
parser/pageparser
Package pageparser provides a parser for Hugo content files (Markdown, HTML etc.) in Hugo.
|
Package pageparser provides a parser for Hugo content files (Markdown, HTML etc.) in Hugo. |
|
template/cfg
Package cfg holds configuration shared by the Go command and internal/testenv.
|
Package cfg holds configuration shared by the Go command and internal/testenv. |
|
template/fmtsort
Package fmtsort provides a general stable ordering mechanism for maps, on behalf of the fmt and text/template packages.
|
Package fmtsort provides a general stable ordering mechanism for maps, on behalf of the fmt and text/template packages. |
|
template/funcs/cast
Package cast provides template functions for data type conversions.
|
Package cast provides template functions for data type conversions. |
|
template/funcs/collections
Package collections provides template functions for manipulating collections such as arrays, maps, and slices.
|
Package collections provides template functions for manipulating collections such as arrays, maps, and slices. |
|
template/funcs/crypto
Package crypto provides template functions for cryptographic operations.
|
Package crypto provides template functions for cryptographic operations. |
|
template/funcs/encoding
Package encoding provides template functions for encoding content.
|
Package encoding provides template functions for encoding content. |
|
template/funcs/inflect
Package inflect provides template functions for the inflection of words.
|
Package inflect provides template functions for the inflection of words. |
|
template/funcs/lang
Package lang provides template functions for content internationalization.
|
Package lang provides template functions for content internationalization. |
|
template/funcs/math
Package math provides template functions for mathematical operations.
|
Package math provides template functions for mathematical operations. |
|
template/funcs/os
Package os provides template functions for interacting with the operating system.
|
Package os provides template functions for interacting with the operating system. |
|
template/funcs/partials
Package partials provides template functions for working with reusable templates.
|
Package partials provides template functions for working with reusable templates. |
|
template/funcs/path
Package path provides template functions for manipulating paths.
|
Package path provides template functions for manipulating paths. |
|
template/funcs/safe
Package safe provides template functions for escaping untrusted content or encapsulating trusted content.
|
Package safe provides template functions for escaping untrusted content or encapsulating trusted content. |
|
template/funcs/strings
Package strings provides template functions for manipulating strings.
|
Package strings provides template functions for manipulating strings. |
|
template/funcs/time
Package time provides template functions for measuring and displaying time.
|
Package time provides template functions for measuring and displaying time. |
|
template/funcs/urls
Package urls provides template functions to deal with URLs.
|
Package urls provides template functions to deal with URLs. |
|
template/htmltemplate
Package template (html/template) implements data-driven templates for generating HTML output safe against code injection.
|
Package template (html/template) implements data-driven templates for generating HTML output safe against code injection. |
|
template/testenv
Package testenv provides information about what functionality is available in different testing environments run by the Go team.
|
Package testenv provides information about what functionality is available in different testing environments run by the Go team. |
|
template/texttemplate
Package template implements data-driven templates for generating textual output.
|
Package template implements data-driven templates for generating textual output. |
|
template/texttemplate/parse
Package parse builds parse trees for templates as defined by text/template and html/template.
|
Package parse builds parse trees for templates as defined by text/template and html/template. |
|
terminal
Package terminal contains helper for the terminal, such as coloring output.
|
Package terminal contains helper for the terminal, such as coloring output. |
Click to show internal directories.
Click to hide internal directories.