diff options
author | Austin Gebauer <agebauer@hashicorp.com> | 2020-04-06 02:37:10 +0300 |
---|---|---|
committer | Austin Gebauer <agebauer@hashicorp.com> | 2020-04-06 02:37:10 +0300 |
commit | f1c94edf4fc7f756d495e9ff3d69422587993234 (patch) | |
tree | 4df3e8261c72269ad336a219db091bb2f1255251 | |
parent | 9d713dc3593bc604d4557454654768986e261640 (diff) |
docs: update readme
-rw-r--r-- | README.md | 117 | ||||
-rw-r--r-- | exampleSite/config.toml | 18 |
2 files changed, 114 insertions, 21 deletions
@@ -1,29 +1,122 @@ # Devise -A fast and minimal [Hugo](https://gohugo.io/) theme for blogs. +A fast, minimal, and responsive [Hugo](https://gohugo.io/) theme for blogs. -![screenshot.png](images/screenshot.png) +Configuration Features: +- General + - Hugo's Builtin [Content Management](https://gohugo.io/content-management/) Features + - Google Analytics +- Header + - Title and Subtitle + - Image + - Navigation Menu + - [Font Awesome](https://fontawesome.com/) Icons with Links +- Main Body + - Last 'N' Recent Pages + - Categorical Page Grouping -## Installation +![screenshot.png](https://raw.githubusercontent.com/austingebauer/devise/master/images/screenshot.png) -- Hugo Version [0.60.0+](https://github.com/gohugoio/hugo/releases/) +## Usage -From the root of your Hugo site, run the following: +This following guides installation, configuration, and updating of the Devise Hugo theme. -``` +### Installation + +Before installing this theme, be sure to [install Hugo](https://gohugo.io/getting-started/quick-start/) +and [create a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). + +To install the theme, run the following from the root directory of your Hugo site: + +```bash $ git submodule add https://github.com/austingebauer/devise.git themes/devise -$ git submodule init -$ git submodule update ``` -## Updates +### Configuration + +Next, open the `config.toml` file in the root of your Hugo site and set the theme: + +```toml +theme = "devise" +``` + +Example `config.toml` file with all configuration features filled out: -You can get updates to the Devise theme by running: +```toml +baseURL = "https://example.com" +title = "Your Website Title" +languageCode = "en-us" +theme = "devise" +relativeURLs = true +enableEmoji = true +googleAnalytics = "" +enableRobotsTXT = true +copyright = "© Copyright Year, Your Name" + +# Main menu items +[menu] + [[menu.main]] + identifier = "about" + name = "About" + title = "About" + url = "/about/" + weight = -110 + [[menu.main]] + identifier = "posts" + name = "Posts" + title = "Posts" + url = "/post/" + weight = -100 + [[menu.main]] + identifier = "categories" + name = "Categories" + title = "Categories" + url = "/categories/" + weight = -90 + +# Configuration Features +[params] + header_title = "Your Name" # Your header title + header_subtitle = "Your Creative Subtitle" # Your header subtitle + home_image = "/images/avatar.png" # Path to header image starting from the static directory + recent_posts = 5 # Max amount of recent posts to show + mainSections = ["posts", "post", "blog"] # Main sections to include in recent posts + [[params.social]] + fa_icon = "fab fa-github fa-1x" # Font Awesome icon class + href = "http://github.com/youruser" # Link to associate with icon + [[params.social]] + fa_icon = "fab fa-linkedin-in fa-1x" + href = "" + [[params.social]] + fa_icon = "fab fa-twitter fa-1x" + href = "" + [[params.social]] + fa_icon = "fas fa-at fa-1x" + href = "" +``` + +### Updating + +To get updates to the theme, run the following from the root directory of your Hugo site: ``` $ git submodule update --remote themes/devise ``` -## Configuration +## Demo + +To run a live demo of the theme, run the following from the `exampleSite` directory of the +devise theme: + +```bash +hugo server --themesDir ../.. --watch --verbose --cleanDestinationDir --disableFastRender +``` + +## Contributing + +If you have an idea for a new feature or found a bug, please feel free to use Github +[issues](https://github.com/austingebauer/devise/issues) to let me know. + +## License -TODO +[MIT](LICENSE) diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 9dc651a..2d64b56 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -8,6 +8,7 @@ googleAnalytics = "" enableRobotsTXT = true copyright = "© Copyright Year, Your Name" +# Main menu items [menu] [[menu.main]] identifier = "about" @@ -15,14 +16,12 @@ copyright = "© Copyright Year, Your Name" title = "About" url = "/about/" weight = -110 - [[menu.main]] identifier = "posts" name = "Posts" title = "Posts" url = "/post/" weight = -100 - [[menu.main]] identifier = "categories" name = "Categories" @@ -30,15 +29,16 @@ copyright = "© Copyright Year, Your Name" url = "/categories/" weight = -90 +# Configuration Features [params] - header_title = "Your Name" - header_subtitle = "Your Creative Subtitle" - home_image = "/images/avatar.png" - recent_posts = 5 - mainSections = ["posts", "post", "blog"] + header_title = "Your Name" # Your header title + header_subtitle = "Your Creative Subtitle" # Your header subtitle + home_image = "/images/avatar.png" # Path to header image starting from the static directory + recent_posts = 5 # Max amount of recent posts to show + mainSections = ["posts", "post", "blog"] # Main sections to include in recent posts [[params.social]] - fa_icon = "fab fa-github fa-1x" - href = "" + fa_icon = "fab fa-github fa-1x" # Font Awesome icon class + href = "http://github.com/youruser" # Link to associate with icon [[params.social]] fa_icon = "fab fa-linkedin-in fa-1x" href = "" |