- 
+ 
- A clean, responsive and fully-customizable hugo theme + A clean, responsive, and programmer-friendly hugo theme
## 💿 Installation @@ -22,18 +22,20 @@ See [Configuration](https://kaiiiz.github.io/hugo-theme-graytr/configuration/) ## 🎁 Features -**Multiple layouts is available:** +**Multiple layouts:** * [Balloon](https://kaiiiz.github.io/hugo-theme-graytr/layouts/demo/balloon/) * [Bookcase](https://kaiiiz.github.io/hugo-theme-graytr/layouts/demo/bookcase/) -* [Catalog](https://kaiiiz.github.io/hugo-theme-graytr/layouts/demo/catalog/) * [Gallery](https://kaiiiz.github.io/hugo-theme-graytr/layouts/demo/gallery/) **Responsive Layout** +**Support Nested Menu** + ## ❤️ Acknowledgement * [Hugo](https://gohugo.io/) for awesome CMS framework written by [golang](https://golang.org/) * [tailwindcss](https://tailwindcss.com/) for awesome utility-first CSS framework -* Icons made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com) ([Balloon](https://www.flaticon.com/free-icon/balloon_106616?term=ballon&page=1&position=40&page=1&position=40&related_id=106616), [Bookcase](https://www.flaticon.com/free-icon/bookcase_3780918?term=bookcase&page=1&position=8&page=1&position=8&related_id=3780918), [Catalogue](https://www.flaticon.com/free-icon/catalogue_3486568?term=catalogue&page=1&position=1&page=1&position=1&related_id=3486568), [Picture](https://www.flaticon.com/free-icon/picture_870392?term=museum&page=1&position=19&page=1&position=19&related_id=870392), [Vase](https://www.flaticon.com/free-icon/vase_3798619?related_id=3798619&origin=tag#), [List](https://www.flaticon.com/free-icon/list_3923539?term=list&page=1&position=24&page=1&position=24&related_id=3923539&origin=search)) +* Icons made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com) +* Material icons made by Google from [Material Design](https://material.io/resources/icons/) diff --git a/assets/css/components/article.sass b/assets/css/components/article.sass index 383a9bb8..5f14bd9f 100644 --- a/assets/css/components/article.sass +++ b/assets/css/components/article.sass @@ -2,26 +2,26 @@ article line-height: 1.7 - *:first-child + > *:first-child @apply mt-0 - *:last-child + > *:last-child @apply mb-0 h1, h2, h3, h4, h5, h6 @apply font-bold mt-8 mb-4 h1 - @apply text-3xl + @apply text-2xl h2 - @apply text-2xl + @apply text-xl h3 - @apply text-xl + @apply text-lg h4 - @apply text-lg + @apply text-md h5 @apply text-base diff --git a/assets/css/components/header.sass b/assets/css/components/header.sass index a0156d91..a4e73b07 100644 --- a/assets/css/components/header.sass +++ b/assets/css/components/header.sass @@ -32,5 +32,24 @@ header transform: rotate(45deg) #navbar_sm - @screen md + @screen xl display: none !important + + ul ul + @apply ml-2 + + #navbar + .navbar-item-dropdown + @apply relative + + .navbar-dropdown + @apply absolute rounded-sm hidden w-max shadow-xl bg-white z-50 + + li + @apply px-2.5 py-2 hover:bg-gray-100 hover:shadow-inner + + &:hover > .navbar-dropdown + @apply block + + &:hover + border-style: none !important diff --git a/assets/css/components/overflow-indicator.sass b/assets/css/components/overflow-indicator.sass deleted file mode 100644 index 8361e057..00000000 --- a/assets/css/components/overflow-indicator.sass +++ /dev/null @@ -1,46 +0,0 @@ - -.overflow-indicator-wrapper - @apply relative -mx-1 flex items-center - - .overflow-indicator-content - @apply px-1 flex overflow-x-auto overflow-y-hidden - - .overflow-indicator - @apply absolute w-1 h-full z-10 items-center - - .overflow-indicator-overlay-left - @apply top-0 left-0 - background: linear-gradient(270deg, rgba(255,255,255,0) 0%, rgba(255,255,255,1) 100%) - - .overflow-indicator-overlay-right - @apply top-0 right-0 - background: linear-gradient(90deg, rgba(255,255,255,0) 0%, rgba(255,255,255,1) 100%) - - .overflow-indicator-btn - @apply w-8 h-8 items-center justify-center bg-white opacity-75 cursor-pointer hidden z-20 - - .overflow-indicator-btn.show - @apply flex - - .overflow-indicator-btn-left - @apply left-0 sm:-left-8 - - &::before - @apply block absolute top-1/2 left-1/2 - content: '' - border-top: solid 6px transparent - border-right: solid 6px #000000 - border-bottom: solid 6px transparent - margin: -6px 0 0 -3px - - .overflow-indicator-btn-right - @apply right-0 sm:-right-8 - - &::before - @apply block absolute top-1/2 left-1/2 - content: '' - border-top: solid 6px transparent - border-left: solid 6px #000000 - border-bottom: solid 6px transparent - margin: -6px 0 0 -3px - diff --git a/assets/css/site.sass b/assets/css/site.sass index fd21a508..fb63d165 100644 --- a/assets/css/site.sass +++ b/assets/css/site.sass @@ -9,6 +9,5 @@ html @import "components/content" @import "components/article" @import "components/util" -@import "components/overflow-indicator" /*! purgecss end ignore */ diff --git a/assets/css/tailwind.config.js b/assets/css/tailwind.config.js index 3d5248f1..0fa99171 100644 --- a/assets/css/tailwind.config.js +++ b/assets/css/tailwind.config.js @@ -2,13 +2,31 @@ module.exports = { theme: { extend: {}, fill: theme => ({ - 'gray-500': theme('colors.gray.500') - }) + 'gray-400': theme('colors.gray.400'), + 'gray-500': theme('colors.gray.500'), + 'gray-600': theme('colors.gray.600'), + 'gray-800': theme('colors.gray.800') + }), + fontSize: { + 'xs': '.75rem', + 'sm': '.875rem', + 'base': '1rem', + 'md': '1.125rem', + 'lg': '1.25rem', + 'xl': '1.35rem', + '2xl': '1.5rem', + '3xl': '1.875rem', + '4xl': '2.25rem', + '5xl': '3rem', + '6xl': '4rem', + '7xl': '5rem', + } }, variants: { extend: { margin: ['first', 'last'], fill: ['hover'], + borderWidth: ['hover'], } }, plugins: [] diff --git a/assets/js/overflow-indicator.js b/assets/js/overflow-indicator.js deleted file mode 100644 index 352812b4..00000000 --- a/assets/js/overflow-indicator.js +++ /dev/null @@ -1,73 +0,0 @@ -function scrollHandler(target) { - const leftDistance = target.scrollLeft; - const rightDistance = target.scrollWidth - leftDistance - target.clientWidth; - - const indicatorWrapper = target.parentNode; - const rightBtn = indicatorWrapper.getElementsByClassName("overflow-indicator-btn-right")[0]; - const leftBtn = indicatorWrapper.getElementsByClassName("overflow-indicator-btn-left")[0]; - - if (rightDistance > 1) { - rightBtn.classList.add("show"); - } else { - rightBtn.classList.remove("show"); - } - - if (leftDistance > 1) { - leftBtn.classList.add("show"); - } else { - leftBtn.classList.remove("show"); - } -} - -function resizeHandler() { - const layerItems = document.querySelectorAll('.overflow-indicator-content'); - layerItems.forEach(i => scrollHandler(i)); -} - -function easeInOutQuad(t) { return t < .5 ? 2 * t * t : -1 + (4 - 2 * t) * t } - -function smoothScroll(target, offset) { - let start = null; - let startScrollLeft = target.scrollLeft; - let duration = 0.2; // s - duration = duration * 1000; - const step = (timestamp) => { - if (!start) start = timestamp; - let progress = timestamp - start; - let percentage = Math.min(progress / duration, 1); - - target.scrollLeft = easeInOutQuad(percentage) * offset + startScrollLeft; - if (progress < duration) { - window.requestAnimationFrame(step); - } - } - window.requestAnimationFrame(step); -} - -function rightBtnHandler(target) { - const indicatorWrapper = target.parentNode; - const content = indicatorWrapper.getElementsByClassName("overflow-indicator-content")[0]; - smoothScroll(content, 202); -} - -function leftBtnHandler(target) { - const indicatorWrapper = target.parentNode; - const content = indicatorWrapper.getElementsByClassName("overflow-indicator-content")[0]; - smoothScroll(content, -202); -} - -function registerListener() { - window.addEventListener('resize', resizeHandler); - document.querySelectorAll('.overflow-indicator-content').forEach(i => { - i.addEventListener('scroll', (e) => scrollHandler(e.target)); - }); - document.querySelectorAll('.overflow-indicator-btn-right').forEach(i => { - i.addEventListener('click', (e) => rightBtnHandler(e.target)); - }); - document.querySelectorAll('.overflow-indicator-btn-left').forEach(i => { - i.addEventListener('click', (e) => leftBtnHandler(e.target)); - }); -} - -registerListener(); -resizeHandler(); diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 0689f909..5e4129e0 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -23,3 +23,78 @@ lineNumbersInTable = true noClasses = true style = "monokai" tabWidth = 4 + +[taxonomies] +category = "categories" +tag = "tags" +series = "series" + +[menu] + [[menu.navbar]] + identifier = "setup" + name = "Setup" + url = "/setup/" + weight = 1 + [[menu.navbar]] + identifier = "configuration" + name = "Configuration" + url = "/configuration/" + weight = 2 + [[menu.navbar]] + identifier = "changelog" + name = "Changelog" + url = "/changelog/" + weight = 3 + [[menu.navbar]] + identifier = "layouts" + name = "Layouts" + url = "/layouts/" + weight = 4 + [[menu.navbar]] + identifier = "demo" + name = "Demostration" + url = "/layouts/demo" + parent = "layouts" + weight = 1 + [[menu.navbar]] + identifier = "balloon_demo" + name = "Balloon" + url = "/layouts/demo/balloon" + parent = "demo" + weight = 1 + [[menu.navbar]] + identifier = "bookcase_demo" + name = "Bookcase" + url = "/layouts/demo/bookcase" + parent = "demo" + weight = 2 + [[menu.navbar]] + identifier = "gallery_demo" + name = "Gallery" + url = "/layouts/demo/gallery" + parent = "demo" + weight = 3 + [[menu.navbar]] + identifier = "docs" + name = "Documents" + url = "/layouts/docs" + parent = "layouts" + weight = 2 + [[menu.navbar]] + identifier = "balloon_docs" + name = "Balloon" + url = "/layouts/docs/balloon" + parent = "docs" + weight = 1 + [[menu.navbar]] + identifier = "bookcase_docs" + name = "Bookcase" + url = "/layouts/docs/bookcase" + parent = "docs" + weight = 2 + [[menu.navbar]] + identifier = "gallery_docs" + name = "Gallery" + url = "/layouts/docs/gallery" + parent = "docs" + weight = 3 diff --git a/exampleSite/content/about/about-this-theme.md b/exampleSite/content/about/about-this-theme.md index b720273f..eb1b98e7 100644 --- a/exampleSite/content/about/about-this-theme.md +++ b/exampleSite/content/about/about-this-theme.md @@ -14,6 +14,6 @@ gallery_statistic: At first, I only designed the prototype of the theme based on my personal needs, and then I gradually discovered that hugo's well-designed structure allows me to abstract my personal needs into generic theme and apply it in different scenarios. -After a period of integration and testing, [hugo-theme-graytr](https://github.com/kaiiiz/hugo-theme-graytr) was born. This theme takes clean, responsiveness and highly customizablilty as philosophy. If you have any suggestions or improvements, feel free to open an issue or pull request on [github](https://github.com/kaiiiz/hugo-theme-graytr). +After a period of integration and testing, [hugo-theme-graytr](https://github.com/kaiiiz/hugo-theme-graytr) was born. This theme takes clean, responsiveness and programmer-friendly as philosophy. If you have any suggestions or improvements, feel free to open an issue or pull request on [github](https://github.com/kaiiiz/hugo-theme-graytr). Hope this theme can let you experience the beauty of hugo. Enjoy! diff --git a/exampleSite/content/about/acknowledgement.md b/exampleSite/content/about/acknowledgement.md index 9492e556..f65456b6 100644 --- a/exampleSite/content/about/acknowledgement.md +++ b/exampleSite/content/about/acknowledgement.md @@ -14,5 +14,5 @@ gallery_statistic: * [Hugo](https://gohugo.io/) for awesome CMS framework written by [golang](https://golang.org/) * [tailwindcss](https://tailwindcss.com/) for awesome utility-first CSS framework -* Icons made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com) ([Balloon](https://www.flaticon.com/free-icon/balloon_106616?term=ballon&page=1&position=40&page=1&position=40&related_id=106616), [Bookcase](https://www.flaticon.com/free-icon/bookcase_3780918?term=bookcase&page=1&position=8&page=1&position=8&related_id=3780918), [Catalogue](https://www.flaticon.com/free-icon/catalogue_3486568?term=catalogue&page=1&position=1&page=1&position=1&related_id=3486568), [Picture](https://www.flaticon.com/free-icon/picture_870392?term=museum&page=1&position=19&page=1&position=19&related_id=870392), [Vase](https://www.flaticon.com/free-icon/vase_3798619?related_id=3798619&origin=tag#), [List](https://www.flaticon.com/free-icon/list_3923539?term=list&page=1&position=24&page=1&position=24&related_id=3923539&origin=search)) -* Material Icons from [Google](https://material.io/resources/icons/) (Using [nightlight](https://material.io/resources/icons/?search=night&icon=nightlight&style=baseline), [sun](https://material.io/resources/icons/?search=sun&icon=brightness_5&style=baseline)) +* Icons made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com) +* Material icons made by Google from [Material Design](https://material.io/resources/icons/) diff --git a/exampleSite/content/about/timeline.md b/exampleSite/content/about/timeline.md index bdc10300..4c531160 100644 --- a/exampleSite/content/about/timeline.md +++ b/exampleSite/content/about/timeline.md @@ -12,5 +12,6 @@ gallery_statistic: value: value3 --- +* 2021/02/10 - v0.3.0 release * 2021/02/09 - v0.2.0 release * 2021/02/08 - v0.1.0 release diff --git a/exampleSite/content/changelog.md b/exampleSite/content/changelog.md index 794fafc0..584f303b 100644 --- a/exampleSite/content/changelog.md +++ b/exampleSite/content/changelog.md @@ -1,8 +1,5 @@ --- title: 'Changelog' -menu: - navbar: - weight: -1 toc: false --- @@ -10,20 +7,27 @@ toc: false ### TODO -* Nested menu * Dark mode supported * Multilingual supported * Highlight.js integration * Advanced SEO (Open Graph, Twitter Card... etc) -* Blog mode * Google Lighthouse * Code copy * Better math supported +* Site Search +* RSS + +### v0.3.0 - 2021/02/10 + +* Support nested navbar +* Implement default homepage layout +* Adjust the purpose of bookcase layout +* Remove catalog layout ### v0.2.0 - 2021/02/09 * A better responsive navbar -* Implement taxonomy and term page +* Implement default taxonomy and term layout * Adjust article styles ### v0.1.0 - 2021/02/08 diff --git a/exampleSite/content/configuration.md b/exampleSite/content/configuration.md index 9d6b2bda..bfa58741 100644 --- a/exampleSite/content/configuration.md +++ b/exampleSite/content/configuration.md @@ -1,8 +1,5 @@ --- title: 'Configuration' -menu: - navbar: - weight: -99 toc: true author: kaiiiz description: Configuration of hugo-theme-graytr @@ -54,6 +51,13 @@ Simply add `favicon.ico` to your site's static folder. ## Theme Settings +### Navbar mode + +```toml +[params] +navbarMode = "blog" +``` + ### Navbar title In your config.toml diff --git a/exampleSite/content/layouts/_index.md b/exampleSite/content/layouts/_index.md index 6bd178ce..dc02cfda 100644 --- a/exampleSite/content/layouts/_index.md +++ b/exampleSite/content/layouts/_index.md @@ -1,10 +1,6 @@ --- title: 'Layouts' type: 'bookcase' -menu: - navbar: - weight: 1 -bookcase_mode: 'expand' --- -Graytr support many different types of layout. You can change the layout of section or regular page according to your needs. +Graytr has many different types of layout built in. You can change the layout of section or regular page according to your needs. diff --git a/exampleSite/content/layouts/demo/_index.md b/exampleSite/content/layouts/demo/_index.md index 66b903d8..7822c891 100644 --- a/exampleSite/content/layouts/demo/_index.md +++ b/exampleSite/content/layouts/demo/_index.md @@ -1,7 +1,5 @@ --- title: 'Demonstration' type: 'bookcase' -bookcase_expand_sections: true -bookcase_expand_pages: true -bookcase_expand_reveal_content: true +bookcase_cover_src: 'desktop.png' --- diff --git a/exampleSite/content/layouts/demo/bookcase/_index.md b/exampleSite/content/layouts/demo/bookcase/_index.md index cba3dba2..64281d0b 100644 --- a/exampleSite/content/layouts/demo/bookcase/_index.md +++ b/exampleSite/content/layouts/demo/bookcase/_index.md @@ -11,8 +11,6 @@ Bookcase layout is useful for creating another viewpoint of list contents. . ├── balloon │ └── _index.md -├── multi-layer-bookcase -│ └── _index.md ├── regular-page.md ├── _index.md <- you are here └── normal diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/_index.md deleted file mode 100644 index 4222a1a8..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/_index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: 'Multi-Layer Bookcase' -bookcase_cover_src: 'bookcase.png' -type: 'bookcase' -bookcase_mode: 'expand' -weight: -500 ---- - -## Multi-Layer Bookcase - -Bookcase layout can expand each subsection's contents (another subsections or regular pages) to a layer of bookcase. - -It's useful if subsection is only used for categorize the inner content. - -``` -. -├── books <- category -│ ├── arts-and-photography <- inner subsection -│ │ └── _index.md -│ ├── biographies-and-memoirs -│ │ └── _index.md -│ ├── business-and-money -│ │ └── _index.md -│ └── _index.md -├── _index.md <- you are here -└── popular-in-books - ├── award-winner - │ └── _index.md - ├── bargain-books - │ └── _index.md - └── _index.md -``` diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/_index.md deleted file mode 100644 index 9fe44022..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: 'Books' -weight: 2 -type: 'catalog' ---- - -Contents inside "Books" section. diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/_index.md deleted file mode 100644 index e9b97f42..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Arts & Photography' -bookcase_cover_src: 'catalogue.png' ---- diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book1.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book1.md deleted file mode 100644 index 32a2c76c..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book1.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 1' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book2.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book2.md deleted file mode 100644 index b57703d2..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book2.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 2' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book3.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book3.md deleted file mode 100644 index 18157f35..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/arts-and-photography/book3.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 3' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/_index.md deleted file mode 100644 index 718c2cd3..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Biographies & Memoirs' -bookcase_cover_src: 'catalogue.png' ---- diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book1.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book1.md deleted file mode 100644 index 32a2c76c..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book1.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 1' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book2.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book2.md deleted file mode 100644 index b57703d2..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book2.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 2' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book3.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book3.md deleted file mode 100644 index 18157f35..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/biographies-and-memoirs/book3.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 3' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/_index.md deleted file mode 100644 index 0fddbe61..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Business & Money' -bookcase_cover_src: 'catalogue.png' ---- diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book1.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book1.md deleted file mode 100644 index 32a2c76c..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book1.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 1' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book2.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book2.md deleted file mode 100644 index b57703d2..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book2.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 2' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book3.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book3.md deleted file mode 100644 index 18157f35..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/books/business-and-money/book3.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 3' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/_index.md deleted file mode 100644 index 34ba0929..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: 'Popular in Books' -weight: 1 -type: 'catalog' -bookcase_expand_reveal_content: true ---- - -Contents inside "Popular in Books" section. diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/_index.md deleted file mode 100644 index 04d1e631..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Award winner' -bookcase_cover_src: 'catalogue.png' ---- diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book1.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book1.md deleted file mode 100644 index 32a2c76c..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book1.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 1' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book2.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book2.md deleted file mode 100644 index b57703d2..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book2.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 2' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book3.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book3.md deleted file mode 100644 index 18157f35..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/award-winner/book3.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 3' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/_index.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/_index.md deleted file mode 100644 index f2f586b3..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Bargain Books' -bookcase_cover_src: 'catalogue.png' ---- diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book1.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book1.md deleted file mode 100644 index 32a2c76c..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book1.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 1' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book2.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book2.md deleted file mode 100644 index b57703d2..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book2.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 2' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book3.md b/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book3.md deleted file mode 100644 index 18157f35..00000000 --- a/exampleSite/content/layouts/demo/bookcase/multi-layer-bookcase/popular-in-books/bargain-books/book3.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'book 3' -date: 2021-02-06 ---- - diff --git a/exampleSite/content/layouts/demo/catalog/_index.md b/exampleSite/content/layouts/demo/catalog/_index.md deleted file mode 100644 index 47a96b73..00000000 --- a/exampleSite/content/layouts/demo/catalog/_index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: 'Catalog' -bookcase_cover_src: 'catalogue.png' -type: 'catalog' -weight: 3 ---- - -Catalog layout is useful for customizing list contents. - -The default list layout will list all pages under the current section, but with catalog layout, you can put any word in any place! (Just like regular page) - -For example: [Go to catalog demo post 1](demo1), or [Go to home page](/hugo-theme-graytr) - -## Why catalog layout? - -You may wonder why not just use `index.md` to render a regular page? - -Consider this situation in bookcase layout (expand mode): - -``` -. -├── category1 -│ ├── subcategory -│ │ └── _index.md -│ └── _index.md -├── _index.md <- bookcase layout -└── category2 - ├── subcategory - │ └── _index.md - └── index.md <- !!!!! -``` - -Bookcase will not expand category2 to its index page, since it's not a subsection under bookcase layout. - -And if using `_index.md`, it will fallback to default list layout in `/category2`. If you don't want to use default list layout, catalog layout is used in this situation. diff --git a/exampleSite/content/layouts/demo/catalog/demo1.md b/exampleSite/content/layouts/demo/catalog/demo1.md deleted file mode 100644 index 20a7090a..00000000 --- a/exampleSite/content/layouts/demo/catalog/demo1.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'DEMO 1' ---- - -Catalog demo post diff --git a/exampleSite/content/layouts/docs/_index.md b/exampleSite/content/layouts/docs/_index.md index 20a49106..6fb3240e 100644 --- a/exampleSite/content/layouts/docs/_index.md +++ b/exampleSite/content/layouts/docs/_index.md @@ -1,4 +1,5 @@ --- title: 'Documents' type: 'bookcase' +bookcase_cover_src: 'catalogue.png' --- diff --git a/exampleSite/content/layouts/docs/bookcase.md b/exampleSite/content/layouts/docs/bookcase.md index 7d598535..69b0fb03 100644 --- a/exampleSite/content/layouts/docs/bookcase.md +++ b/exampleSite/content/layouts/docs/bookcase.md @@ -19,23 +19,6 @@ type: 'bookcase' > Specify `type` in front-matter will change the template lookup order. - -### bookcase_mode - -The mode of bookcase layout. Two options are available: 'list' or 'expand'. - -List mode will list subsections or pages in current level. - -Expand mode will expand the contents of subsection (another subsections or pages) to multi-layer. Checkout [Multi-Layer Bookcase](/hugo-theme-graytr/layouts/demo/bookcase/multi-layer-bookcase/) for demonstration. - -```yaml ---- -bookcase_mode: 'list' ---- -``` - -> default: 'list' - ### bookcase_cover_src The cover image URL. URL must be related to base URL. (without /) @@ -79,10 +62,6 @@ weight: 3 > default: sort pages by alphabetical order -## List mode - -These options will only be used if `bookcase_mode` is set to list. - ### bookcase_list_sections Expand sections to the layer of bookcase. @@ -106,73 +85,3 @@ bookcase_list_pages: true ``` > default: true - -## Expand mode - -These options will only be used if `bookcase_mode` is set to expand. - -### bookcase_expand_sections - -Expand sections to the layer of bookcase. - -This parameter is located in subsection. For example: - -``` -. -├── books -│ ├── _index.md <- bookcase_expand_sections is located in here! -│ └── business-and-money <- this subsection will show in bookcase -│ └── _index.md -└── _index.md <- your bookcase layout -``` - -```yaml ---- -bookcase_expand_sections: true ---- -``` - -> default: true - -### bookcase_expand_pages - -Expand regular pages to the layer of bookcase. - -This parameter is located in subsection. For example: - -``` -. -├── books -│ ├── _index.md <- bookcase_expand_pages is located in here! -│ └── business-and-money.md <- this page will show in bookcase -└── _index.md <- your bookcase layout -``` - -```yaml ---- -bookcase_expand_pages: true ---- -``` - -> default: true - -### bookcase_expand_reveal_content - -Decide whether reveal the content of `_index.md` into bookcase index page. - -This parameter is located in subsection. For example: - -``` -. -├── books -│ └── _index.md <- bookcase_expand_reveal_content is located in here! -└── _index.md <- your bookcase layout -``` - -```yaml ---- -bookcase_expand_reveal_content: true ---- -``` - -> default: true diff --git a/exampleSite/content/layouts/docs/catalog.md b/exampleSite/content/layouts/docs/catalog.md deleted file mode 100644 index 20dda405..00000000 --- a/exampleSite/content/layouts/docs/catalog.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 'Catalog' -bookcase_cover_src: 'catalogue.png' ---- - -Catalog layout is useful for customizing list contents. - -> This layout can only be used on list layout. - -## Configuration - -In page front-matter - -```yaml ---- -type: 'catalog' ---- -``` - -> Specify `type` in front-matter will change the template lookup order. diff --git a/exampleSite/content/setup.md b/exampleSite/content/setup.md index 0091db58..84f28ca5 100644 --- a/exampleSite/content/setup.md +++ b/exampleSite/content/setup.md @@ -1,8 +1,5 @@ --- title: 'Setup' -menu: - navbar: - weight: -100 --- This document shows a brief guide to setup hugo-theme-graytr in your hugo project. diff --git a/exampleSite/hugo_stats.json b/exampleSite/hugo_stats.json index 4fae0e39..19f8077e 100644 --- a/exampleSite/hugo_stats.json +++ b/exampleSite/hugo_stats.json @@ -42,6 +42,7 @@ "ul" ], "classes": [ + "-ml-2.5", "absolute", "bg-gray-300", "bg-gray-800", @@ -54,21 +55,23 @@ "border-gray-800", "border-transparent", "cursor-pointer", + "fill-gray-400", + "fill-gray-600", + "fill-gray-800", "flex", "flex-1", "flex-col", - "flex-shrink-0", "font-bold", "font-sans", "font-semibold", "gap-2", + "gap-4", "grid", "grid-cols-2", "h-20", "h-24", "h-4", - "h-64", - "h-auto", + "h-48", "h-full", "hidden", "highlight", @@ -77,10 +80,10 @@ "hover:duration-75", "hover:ease-out", "hover:fill-gray-500", + "hover:fill-gray-800", "hover:opacity-25", "hover:text-gray-800", "hover:transition", - "inline-block", "italic", "items-center", "justify-between", @@ -88,25 +91,24 @@ "language-bash", "language-toml", "language-yaml", - "last:mr-0", "leading-6", "leading-relaxed", "left-0", + "left-full", "lg:w-7/12", + "m-5", "m-auto", - "mb-10", "mb-16", "mb-2", "mb-4", "mb-6", + "mb-8", "md:-ml-7", - "md:block", "md:flex", "md:flex-row", "md:hidden", "md:justify-start", "md:ml-4", - "md:mr-0", "md:mt-0", "md:my-3", "md:order-4", @@ -114,44 +116,36 @@ "md:w-9/12", "menu-btn", "mr-2", - "mr-4", "mr-auto", + "mt-1.5", "mt-2", "mt-2.5", + "mt-3", "mt-8", "mx-auto", "my-0", "my-1", "my-2", "my-4", - "my-6", "my-7", "my-8", + "navbar-dropdown", + "navbar-item", + "navbar-item-dropdown", "navicon", - "no-scrollbar", "object-cover", "opacity-0", "order-3", "overflow-auto", - "overflow-indicator", - "overflow-indicator-btn", - "overflow-indicator-btn-left", - "overflow-indicator-btn-right", - "overflow-indicator-content", - "overflow-indicator-overlay-left", - "overflow-indicator-overlay-right", - "overflow-indicator-wrapper", "p-4", - "p-5", "pb-1", "px-6", - "py-2", "relative", "rounded", "rounded-full", "rounded-md", + "shadow-lg", "shadow-md", - "shadow-xl", "sm:-mx-5", "sm:w-10/12", "text-2xl", @@ -169,9 +163,11 @@ "w-20", "w-24", "w-28", + "w-32", "w-4", - "w-40", "w-full", + "xl:block", + "xl:hidden", "xl:w-5/12" ], "ids": [ @@ -183,12 +179,8 @@ "balloon_resources", "base-url", "bookcase_cover_src", - "bookcase_expand_pages", - "bookcase_expand_reveal_content", - "bookcase_expand_sections", "bookcase_list_pages", "bookcase_list_sections", - "bookcase_mode", "build-static-pages", "changelog", "configuration", @@ -199,7 +191,6 @@ "description", "disqus", "disqus-1", - "expand-mode", "favicon", "footer", "gallery_img_caption", @@ -213,11 +204,10 @@ "install-hugo", "keywords", "layout", - "list-mode", "metadata", - "multi-layer-bookcase", "navbar", "navbar-menu", + "navbar-mode", "navbar-title", "navbar_btn", "navbar_sm", @@ -238,8 +228,8 @@ "trick", "v010---20210208", "v020---20210209", + "v030---20210210", "weight", - "why-catalog-layout", "zoomingjs" ] } diff --git a/exampleSite/static/desktop.png b/exampleSite/static/desktop.png new file mode 100644 index 00000000..f01845b6 Binary files /dev/null and b/exampleSite/static/desktop.png differ diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index fdf386f3..b5af5483 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -7,8 +7,7 @@