├── archetypes └── default.md ├── .gitignore ├── layouts ├── 404.html ├── post │ ├── list.html │ └── single.html ├── _default │ ├── single.html │ ├── baseof.html │ └── list.html ├── partials │ ├── footer.html │ ├── head.html │ ├── category-posts.html │ └── header.html ├── index.html ├── categories │ └── list.html └── tag │ └── list.html ├── exampleSite ├── content │ ├── homepage │ │ ├── index.md │ │ ├── about.md │ │ └── work.md │ ├── _index.md │ ├── archives.md │ ├── post │ │ ├── _index.md │ │ ├── rich-content.md │ │ ├── emoji-support.md │ │ ├── math-typesetting.mmark │ │ ├── placeholder-text.md │ │ └── markdown-syntax.md │ └── about.md ├── static │ ├── favicon.ico │ └── images │ │ └── avatar.png └── config.toml ├── images ├── tn.png └── screenshot.png ├── static ├── images │ └── avatar.png └── webfonts │ ├── fa-brands-400.ttf │ ├── fa-solid-900.ttf │ ├── fa-brands-400.woff2 │ ├── fa-regular-400.ttf │ ├── fa-regular-400.woff2 │ ├── fa-solid-900.woff2 │ ├── fa-v4compatibility.ttf │ └── fa-v4compatibility.woff2 ├── package.json ├── theme.toml ├── LICENSE ├── assets └── sass │ └── override.scss └── README.md /archetypes/default.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | exampleSite/Makefile 2 | -------------------------------------------------------------------------------- /layouts/404.html: -------------------------------------------------------------------------------- 1 |
🙈 :see_no_evil: 🙉 :hear_no_evil: 🙊 :speak_no_evil:
33 | {{ if isset .Site.Params "header_subtitle" }} 34 | {{ .Site.Params.header_subtitle }} 35 | {{ else }} 36 | Your Creative Subtitle 37 | {{ end }} 38 |
39 | 47 | 56 |Test
86 | 87 | 88 | ``` 89 | #### Code block indented with four spaces 90 | 91 | 92 | 93 | 94 | 95 |Test
99 | 100 | 101 | 102 | #### Code block with Hugo's internal highlight shortcode 103 | {{< highlight html >}} 104 | 105 | 106 | 107 | 108 |Test
112 | 113 | 114 | {{< /highlight >}} 115 | 116 | ## List Types 117 | 118 | #### Ordered List 119 | 120 | 1. First item 121 | 2. Second item 122 | 3. Third item 123 | 124 | #### Unordered List 125 | 126 | * List item 127 | * Another item 128 | * And another item 129 | 130 | #### Nested list 131 | 132 | * Item 133 | 1. First Sub-item 134 | 2. Second Sub-item 135 | 136 | ## Other Elements — abbr, sub, sup, kbd, mark 137 | 138 | GIF is a bitmap image format. 139 | 140 | H2O 141 | 142 | Xn + Yn = Zn 143 | 144 | Press CTRL+ALT+Delete to end the session. 145 | 146 | Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. 147 | 148 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Devise 2 | 3 | A fast, minimal, responsive [Hugo](https://gohugo.io/) theme for blogs. 4 | 5 |  6 | 7 | For a live demo of the theme, see at: 8 | - [themes.gohugo.io/devise](https://themes.gohugo.io/devise) 9 | - [austingebauer.dev](https://austingebauer.dev) 10 | 11 | ## Features 12 | 13 | - All of Hugo's builtin [Content Management](https://gohugo.io/content-management/) 14 | - Easy installation of [Google Analytics](https://analytics.google.com/analytics/web/provision/#/provision) via Hugo [configuration](https://gohugo.io/getting-started/configuration/) file 15 | - Fast loading with a 95-100 score on [Google PageSpeed](https://developers.google.com/speed/pagespeed/insights/) 16 | - Ability to use [Bootstrap 4](https://getbootstrap.com/docs/4.0/getting-started/introduction/) CSS classes via HTML/CSS in Markdown 17 | - Ability to use [Font Awesome](https://fontawesome.com/) icons 18 | - Ability to customize the theme styles via [Sass](https://sass-lang.com/) 19 | - Ability to customize the following items via Hugo [configuration](https://gohugo.io/getting-started/configuration/) file 20 | - Meta description 21 | - Title 22 | - Subtitle 23 | - Image 24 | - Image border color 25 | - Navigation menu 26 | - Social icons 27 | - Last 'n' recent posts 28 | - Background color 29 | - Font family 30 | - Font color 31 | 32 | ## Usage 33 | 34 | This following guides installation, configuration, and updating of the Devise Hugo theme. 35 | 36 | ### Installation 37 | 38 | Before installing this theme, be sure to [install Hugo](https://gohugo.io/getting-started/quick-start/) 39 | and [create a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). 40 | 41 | To install the theme, run the following from the root directory of your Hugo site: 42 | 43 | ```bash 44 | $ git submodule add https://github.com/austingebauer/devise.git themes/devise 45 | ``` 46 | 47 | ### Configuration 48 | 49 | Next, open the `config.toml` file in the root of your Hugo site and set the theme: 50 | 51 | ```toml 52 | theme = "devise" 53 | ``` 54 | 55 | Example `config.toml` file with all configuration features filled out: 56 | 57 | ```toml 58 | baseURL = "https://example.com" 59 | title = "Your Website Title" 60 | languageCode = "en-us" 61 | theme = "devise" 62 | relativeURLs = true 63 | enableEmoji = true 64 | googleAnalytics = "" 65 | enableRobotsTXT = true 66 | copyright = "© Copyright Year, Your Name" 67 | 68 | # Main menu items 69 | [menu] 70 | [[menu.main]] 71 | identifier = "about" 72 | name = "About" 73 | title = "About" 74 | url = "/about/" 75 | weight = -110 76 | [[menu.main]] 77 | identifier = "posts" 78 | name = "Posts" 79 | title = "Posts" 80 | url = "/post/" 81 | weight = -100 82 | [[menu.main]] 83 | identifier = "categories" 84 | name = "Categories" 85 | title = "Categories" 86 | url = "/categories/" 87 | weight = -90 88 | 89 | # Configuration Features 90 | [params] 91 | description = "Your meta description" # Your meta description of the site 92 | header_title = "Your Name" # Your header title 93 | header_subtitle = "Your Creative Subtitle" # Your header subtitle 94 | home_image = "/images/avatar.png" # Path to header image starting from the static directory (optional) 95 | recent_posts = 5 # Max amount of recent posts to show 96 | mainSections = ["posts", "post", "blog"] # Main sections to include in recent posts 97 | [params.style] # CSS style overrides 98 | backgroundColor = "#f8f9fa" 99 | homeImageBorderColor = "#ffffff" 100 | fontFamilyBase = "Helvetica Neue" # First-choice font 101 | fontColor = "#212529" 102 | [[params.social]] 103 | fa_icon = "fab fa-github fa-1x" # Font Awesome icon class 104 | href = "http://github.com/youruser" # Link to associate with icon (http://, https://, mailto:) 105 | [[params.social]] 106 | fa_icon = "fab fa-linkedin-in fa-1x" 107 | href = "" 108 | [[params.social]] 109 | fa_icon = "fab fa-twitter fa-1x" 110 | href = "" 111 | [[params.social]] 112 | fa_icon = "fas fa-at fa-1x" 113 | href = "" 114 | ``` 115 | 116 | ### Updating 117 | 118 | To get updates to the theme, run the following from the root directory of your Hugo site: 119 | 120 | ``` 121 | $ git submodule update --remote themes/devise 122 | ``` 123 | 124 | ### Adding Custom Styles 125 | 126 | Adding custom styles to the devise theme is simple. There are two options 127 | available for doing so. 128 | 129 | #### Option 1: 130 | 131 | In the `config.toml` file of your website, you can set the following custom style 132 | parameters: 133 | 134 | ```toml 135 | [params.style] 136 | backgroundColor = "#f8f9fa" 137 | homeImageBorderColor = "#ffffff" 138 | fontFamilyBase = "Helvetica Neue" 139 | fontColor = "#212529" 140 | ``` 141 | 142 | If you'd like to see other custom styles available as config parameters, please open an [issue](https://github.com/austingebauer/devise/issues). 143 | 144 | #### Option 2: 145 | 146 | To add custom [Sass](https://sass-lang.com/) styles to the devise theme, you'll 147 | need to add the following file to the [assets](https://gohugo.io/hugo-pipes/introduction/#asset-directory) 148 | directory of your site: 149 | 150 | - `assets/sass/custom.scss` 151 | 152 | In the file, you can use [Sass](https://sass-lang.com/) syntax to declare 153 | your custom styles. After doing so, you should see custom styling added to 154 | your devise based Hugo site. 155 | 156 | ## Demo 157 | 158 | To run a live demo of the theme on your laptop, run the following from the `exampleSite` directory of the 159 | devise theme: 160 | 161 | ```bash 162 | hugo server --themesDir ../.. --watch --verbose --cleanDestinationDir --disableFastRender 163 | ``` 164 | 165 | For a live demo of the theme, see at: 166 | - [themes.gohugo.io/devise](https://themes.gohugo.io/devise) 167 | - [austingebauer.dev](https://austingebauer.dev) 168 | 169 | ## Contributing 170 | 171 | If you have an idea for a new feature or found a bug, please feel free to use Github 172 | [issues](https://github.com/austingebauer/devise/issues) to let me know. 173 | 174 | ## License 175 | 176 | [MIT](LICENSE) 177 | --------------------------------------------------------------------------------