feat: migrate Hugo Bootstrap theme to latest Hugo with Tailwind CSS and refactor codebase
* replace Bootstrap-based styling with Tailwind CSS * update theme compatibility for latest Hugo version * refactor templates and partials * fix outdated code and broken components * improve project structure and maintainability * optimize styling and frontend build setup
This commit is contained in:
79
README.md
Normal file → Executable file
79
README.md
Normal file → Executable file
@@ -1,50 +1,65 @@
|
||||
<h1>Roxo Hugo</h1>
|
||||
<img src="https://user-images.githubusercontent.com/16266381/76162082-10850b80-6164-11ea-8b20-f30b2611f92c.png" alt="screenshot" width="100%">
|
||||
## 🌟 Roxo Hugo
|
||||
|
||||
Roxo Hugo is a digital agency Hugo theme for creative agencies, freelancers, graphic designers, photographers. Can be used for any kind of corporate websites who provides digital services with many expertise such as Design, Digital Products, Development, Campaign & Content, Employer Branding, Animation & Motion Graphics ,Packaging & Product Design, Retail & Spacial, Print & Editorial Design, Concept/Text, Information Design etc. Roxo Hugo’s contact form is supported fabform.
|
||||
A hugo powered static website.
|
||||
|
||||
## Table of Contents
|
||||
### Prerequisites
|
||||
|
||||
- [Live Demo](#live-demo)
|
||||
- [Installation](#installation)
|
||||
- [Main Features](#features)
|
||||
- [Support](#support)
|
||||
- [Licensing](#licensing)
|
||||
- [Hire](#hire)
|
||||
To contribute effectively, you'll need some prerequisites installed on your machine:
|
||||
|
||||
## Live Demo
|
||||
- **Hugo Extended v0.161+**: [[https://gohugo.io/installation/](https://gohugo.io/installation/)]
|
||||
- **Node v18+**: [[https://nodejs.org/en/download/](https://nodejs.org/en/download/)]
|
||||
- **Go v1.22+**: [[https://go.dev/doc/install](https://go.dev/doc/install)]
|
||||
|
||||
Checkout the live demo [here](https://roxo-hugo.staticmania.com/)
|
||||
### Installation (as a theme)
|
||||
|
||||
## Installation
|
||||
To use Roxo in a new Hugo site, install the theme and configure your site with `hugo.toml` (not `config.toml`). The theme expects the Hugo config file to be named `hugo.toml`; using `config.toml` will result in a 404 / "page not found".
|
||||
|
||||
1. Add the repository into your Hugo Project repository as a submodule, `git submodule add git@github.com:StaticMania/roxo-hugo.git themes/roxo-hugo`.
|
||||
2. Copy the `data`, `content`, `static`, `resources` & `config.toml` files from the `exampleSite` directory and paste it on you Hugo Project repository/directory. From the site home directory:
|
||||
```bash
|
||||
hugo new site mysite
|
||||
cd mysite
|
||||
git submodule add https://github.com/furioustheme/roxo-hugo.git themes/roxo-hugo
|
||||
```
|
||||
|
||||
cp -a themes/roxo-hugo/exampleSite/* .
|
||||
Then create `hugo.toml` at the root of your site (copy `themes/roxo-hugo/exampleSite/hugo.toml` as a starting point) and set:
|
||||
|
||||
3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`.
|
||||
```toml
|
||||
theme = "roxo-hugo"
|
||||
```
|
||||
|
||||
Run the site:
|
||||
|
||||
## Features
|
||||
```bash
|
||||
hugo server
|
||||
```
|
||||
|
||||
* Responsive Ready.
|
||||
* Powered by Bootstrap 4.
|
||||
* Dedicated portfolio page.
|
||||
* Blog Support.
|
||||
* Well formatted code.
|
||||
* Easy Customization.
|
||||
* FabForm.io [static website form](https://fabform.io).
|
||||
* Crafted for Design Agency/ Portfolio
|
||||
### Install Dependencies
|
||||
|
||||
## Support
|
||||
Install all the necessary dependencies using the following command:
|
||||
|
||||
Have some question or facing any technical trouble feel free to [Contact Us](https://staticmania.com/contact/)
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Licensing
|
||||
### Project Setup
|
||||
|
||||
This Repository is licensed under the [MIT](https://github.com/StaticMania/roxo-hugo/blob/master/LICENSE) License
|
||||
To set up the project, run the following command:
|
||||
|
||||
## Hire
|
||||
```bash
|
||||
yarn project-setup
|
||||
```
|
||||
|
||||
Need help to build HUGO websites with your custom requirements. Feel free to [contact](https://staticmania.com/contact/) with us. We provide custom development service for HUGO.
|
||||
### Development Command
|
||||
|
||||
Start the development server using the following command:
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
### Preview Command
|
||||
|
||||
Start the production server to preview your changes and test functionality:
|
||||
|
||||
```bash
|
||||
yarn preview
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user