Skip to content

Commit 1488cf9

Browse files
author
Nir Galon
committed
docs: add demo section into README file
1 parent a20eaae commit 1488cf9

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
1-
# devRes Theme
1+
# devRes Theme | Hugo
22

33
[![CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-orange.svg)](http://creativecommons.org/licenses/by/4.0/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/nirgn975/devRes)](https://github.com/nirgn975/devRes/releases) ![Continuous Deployment](https://github.com/nirgn975/devRes/workflows/Continuous%20Deployment/badge.svg?branch=main) [![Hugo](https://img.shields.io/badge/Hugo-%5E0.41.0-ff4088?logo=hugo)](https://gohugo.io/) [![Donate](https://img.shields.io/badge/PayPal-Donate-lightgrey.svg)](https://www.paypal.me/nirgn/2)
44

55
> A Hugo resume theme with a Developer focus in mind.
66
77
![Screenshot](images/screenshot.webp)
88

9-
# Getting started
9+
## DEMO
1010

11-
If you want to use the theme in your own [hugo](https://gohugo.io) website just `clone` the repo to your `theme` directory and add it to your `config.toml` file.
12-
13-
```toml
14-
theme = "devRes"
15-
```
11+
To see this theme in action, Here is a [live demo](https://nirgn975.github.io/devRes) site which is rendered with this theme and some content for documentation.
1612

17-
# Features
13+
## Features
1814

1915
- Responsive layout.
2016
- Light / Dark mode.
@@ -23,16 +19,24 @@ theme = "devRes"
2319
- Use [Font Awesome](https://fontawesome.com) or [Devicons](https://devicon.dev) icons.
2420
- Support [Google](https://analytics.google.com/analytics) and [Plausible](https://plausible.io) analytics.
2521
- Optimized for Performance, Accessibility, Best Practices, and SEO: 90+ (out of 100) on mobile and desktop in [Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights).
26-
- **CDN** for all third-party libraries supported
22+
- **CDN** for all third-party libraries supported.
23+
24+
## Getting started
25+
26+
If you want to use the theme in your own [hugo](https://gohugo.io) website just `clone` the repo to your `theme` directory and add it to your `config.toml` file.
27+
28+
```toml
29+
theme = "devRes"
30+
```
2731

28-
# Customization
32+
## Customization
2933

3034
1. You can change the theme colors in the `config.toml` file.
3135
2. Your resume data should be added in the `data/content.yaml` file.
3236

3337
You can check the `exampleSite` directory for an example.
3438

35-
# Want to help?
39+
## Want to help?
3640

3741
Great! All issues and pull requests are welcome.
3842

0 commit comments

Comments
 (0)