Hugo Xiang Yun Theme | Demo

MDFriday showcase theme

Xiang Yun, meaning "Auspicious Cloud," is a theme designed to showcase all the themes supported by MDFriday.
It embodies a sense of harmony and elegance, making it perfect for displaying theme variations with clarity and style.
From simple previews to in-depth examples, this theme caters to MDFriday users looking for inspiration and customization.

• Features
• Requirements
• Installation
• Configuration
• Versioning
• Contributing

---

Features

• A unified showcase of all MDFriday-supported themes
• Elegant and minimal design inspired by auspicious clouds
• Responsive and mobile-friendly layout
• Configurable theme sections and navigation
• Optimized for quick theme previews and user exploration

---

Requirements

• Hugo 0.112.7 or higher
• Go Modules enabled

---

Installation

Install as Hugo Module

The recommended way to install Xiang Yun is via Hugo Modules.

Step 1: Initialize Hugo Modules

If you haven't already, initialize Hugo modules in your project:

hugo mod init github.com/your/repo

Step 2: Update config.toml

Add the theme as a module in your configuration file:

[module]
[[module.imports]]
path = "github.com/mdfriday/theme-xiang-yun"

Step 3: Load and Run

Download the module and run your site:

hugo mod get -u
hugo server --minify

Versioning

This theme follows a simple incremental versioning. e.g. v1, v2 and so on. There might be breaking changes between versions.

To ensure stability, use a released version tag. For the latest features and updates, use the main branch.

Contributing

Acknowledgements

Contributions are encouraged and highly appreciated.
Goals for contributions include:

• Enhancing customization options
• Maintaining simplicity and readability
• Supporting diverse MDFriday themes seamlessly
• Minimizing dependencies on external libraries

Report issues or suggest improvements via GitHub Issues.
Pull requests are always welcome!