mirror of
https://github.com/chaoming/hugo-saasify-theme.git
synced 2025-04-20 07:11:52 +02:00
updated README
This commit is contained in:
parent
3a570e36d9
commit
a89df57429
1 changed files with 35 additions and 35 deletions
70
README.md
70
README.md
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
A modern and elegant Hugo theme specifically designed for SaaS websites. Built with TailwindCSS, this theme provides a clean, professional look while maintaining excellent performance and customization options.
|
A modern and elegant Hugo theme specifically designed for SaaS websites. Built with TailwindCSS, this theme provides a clean, professional look while maintaining excellent performance and customization options.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
@ -42,7 +42,39 @@ git init
|
||||||
git submodule add https://github.com/chaoming/hugo-saasify-theme themes/hugo-saasify-theme
|
git submodule add https://github.com/chaoming/hugo-saasify-theme themes/hugo-saasify-theme
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Install dependencies
|
### 3. Example Site (Optional)
|
||||||
|
|
||||||
|
The theme comes with a fully functional example site that demonstrates its features and capabilities. You can use this as a reference when building your own site.
|
||||||
|
|
||||||
|
### Using the Example Site
|
||||||
|
|
||||||
|
1. Copy the example site content:
|
||||||
|
```bash
|
||||||
|
cp -r themes/hugo-saasify-theme/exampleSite/* .
|
||||||
|
```
|
||||||
|
|
||||||
|
2. The example site includes:
|
||||||
|
- Complete content structure with sample pages
|
||||||
|
- Blog posts with various layouts
|
||||||
|
- Feature pages
|
||||||
|
- Career/Jobs section
|
||||||
|
- Pricing page
|
||||||
|
- Company information page
|
||||||
|
- Properly configured hugo.toml
|
||||||
|
|
||||||
|
3. Start the development server:
|
||||||
|
```bash
|
||||||
|
npm run start
|
||||||
|
```
|
||||||
|
|
||||||
|
The example site provides a great starting point to understand how to:
|
||||||
|
- Structure your content
|
||||||
|
- Use different page layouts
|
||||||
|
- Configure navigation menus
|
||||||
|
- Set up site parameters
|
||||||
|
- Implement common SaaS website features
|
||||||
|
|
||||||
|
### 4. Install dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Copy package.json and other config files to your site root
|
# Copy package.json and other config files to your site root
|
||||||
|
@ -82,39 +114,7 @@ module.exports = {
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Example Site
|
### 5. Configure your Hugo site
|
||||||
|
|
||||||
The theme comes with a fully functional example site that demonstrates its features and capabilities. You can use this as a reference when building your own site.
|
|
||||||
|
|
||||||
### Using the Example Site
|
|
||||||
|
|
||||||
1. Copy the example site content:
|
|
||||||
```bash
|
|
||||||
cp -r themes/hugo-saasify-theme/exampleSite/* .
|
|
||||||
```
|
|
||||||
|
|
||||||
2. The example site includes:
|
|
||||||
- Complete content structure with sample pages
|
|
||||||
- Blog posts with various layouts
|
|
||||||
- Feature pages
|
|
||||||
- Career/Jobs section
|
|
||||||
- Pricing page
|
|
||||||
- Company information page
|
|
||||||
- Properly configured hugo.toml
|
|
||||||
|
|
||||||
3. Start the development server:
|
|
||||||
```bash
|
|
||||||
npm run start
|
|
||||||
```
|
|
||||||
|
|
||||||
The example site provides a great starting point to understand how to:
|
|
||||||
- Structure your content
|
|
||||||
- Use different page layouts
|
|
||||||
- Configure navigation menus
|
|
||||||
- Set up site parameters
|
|
||||||
- Implement common SaaS website features
|
|
||||||
|
|
||||||
### 4. Configure your Hugo site
|
|
||||||
|
|
||||||
Create or update your `hugo.toml` with the following configuration:
|
Create or update your `hugo.toml` with the following configuration:
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue