Hugo-theme-stack/README.md

![Stack](https://i.imgur.com/cCiHOGS.jpg)
# Hugo Theme Stack

> Card-style Hugo theme designed for bloggers.

## Demo

[Example Site](https://theme-stack.jimmycai.com/)

[![Netlify Status](https://api.netlify.com/api/v1/badges/a2d2807a-a905-4bcb-97da-8da8d847da3d/deploy-status)](https://app.netlify.com/sites/hugo-theme-stack/deploys)

## Documentation

[Documentation](https://docs.stack.jimmycai.com/) | [中文文档](https://docs.stack.jimmycai.com/zh/)

## Introduction

Stack is a simple card-style Hugo theme designed for bloggers, some of its features are:

- Responsive images support
- Lazy load images
- Dark mode
- Local search
- [PhotoSwipe](https://photoswipe.com/) integration
- Archive page template
- Full native JavaScript, no jQuery or any other frameworks are used
- No CSS framework, keep it simple and minimal
- Properly cropped thumbnails
- Subsection support
- Table of contents

## Requirements

It's necessary to use **Hugo Extended ≥ 0.87.0**.

## Installation

Clone / Download this repository to `theme` folder, and edit your site config following `exampleSite/config.yaml`.

*Note: Remove `config.toml` if there is one in the site folder.*

Check [documentation](https://docs.stack.jimmycai.com/) for more details.

## Copyright

**Licensed under the GNU General Public License v3.0**

Please do not remove the "*Theme Stack designed by Jimmy*" text and link.

If you want to port this theme to another blogging platform, please let me know🙏.

## Sponsoring

If you like this theme, give it a star, and consider supporting its development:

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C530AXX)

Your support is greatly appreciated :)

## Thanks to

| Project | Description | Licence |
| ------- | ----------- | ------- |
| [PhotoSwipe](https://photoswipe.com/) | For the lightbox effect | [MIT](https://github.com/dimsemenov/PhotoSwipe/blob/master/LICENSE) |
| [Normalize.css](https://github.com/necolas/normalize.css) | - | [MIT](https://github.com/necolas/normalize.css/blob/master/LICENSE.md) |
| [Node Vibrant](https://github.com/Vibrant-Colors/node-vibrant) | To extract the color from images | [MIT](https://github.com/Vibrant-Colors/node-vibrant/blob/master/LICENSE.md)
| [Tabler icons](https://github.com/tabler/tabler-icons) | Default menu icons | [MIT](https://github.com/tabler/tabler-icons/blob/master/LICENSE) |
| [jonsuh/hamburgers](https://github.com/jonsuh/hamburgers) | Hamburger icon of menu | [MIT](https://github.com/jonsuh/hamburgers/blob/master/LICENSE) |
| [lepture/yue.css](https://github.com/lepture/yue.css) | Part of it is used for styling article content | MIT |
| [Typlog](https://typlog.com/) | Where the markdown gallery syntax is borrowed from | The author gave me the permission | 
| [Pure CSS implementation of Google Photos / 500px image layout](https://github.com/xieranmaya/blog/issues/6) | Used for image gallery | - |

### References

Some references that I took while building this theme:

| Project | Licence|
| ------- | ------|
| [artchen/hexo-theme-element](https://github.com/artchen/hexo-theme-element) | [MIT](https://github.com/artchen/hexo-theme-element/blob/master/LICENSE) |
| [MunifTanjim/minimo](https://github.com/MunifTanjim/minimo) | [MIT](https://github.com/MunifTanjim/minimo/blob/master/LICENSE) |
doc(README): update README 2020-09-12 16:34:39 -04:00			`![Stack](https://i.imgur.com/cCiHOGS.jpg)`
📝 Add README 2020-08-23 02:55:34 -04:00			`# Hugo Theme Stack`
doc: update README and theme.toml 2020-09-12 07:33:36 -04:00
doc(README): update README 2020-09-12 16:34:39 -04:00			`> Card-style Hugo theme designed for bloggers.`
doc(README): add Netlify deploy status badge 2020-08-24 17:22:38 -04:00
doc(README): add more information 2020-09-07 06:13:51 -04:00			`## Demo`

doc(exampleSite): change example site domain 2020-09-08 17:49:06 -04:00			`[Example Site](https://theme-stack.jimmycai.com/)`
doc(README): add more information 2020-09-07 06:13:51 -04:00
doc(README): update README 2020-09-12 16:34:39 -04:00			`[![Netlify Status](https://api.netlify.com/api/v1/badges/a2d2807a-a905-4bcb-97da-8da8d847da3d/deploy-status)](https://app.netlify.com/sites/hugo-theme-stack/deploys)`

doc: update README to include license information 2021-07-09 07:04:30 -04:00			`## Documentation`
doc: update README and theme.toml 2020-09-12 07:33:36 -04:00
doc(README): fix Chinese doc URL (#253) Co-authored-by: Jimmy Cai <github@jimmycai.com> 2021-07-04 12:41:50 -04:00			`[Documentation](https://docs.stack.jimmycai.com/) \| [中文文档](https://docs.stack.jimmycai.com/zh/)`
doc: update README and theme.toml 2020-09-12 07:33:36 -04:00
doc(README): update README 2020-09-12 16:34:39 -04:00			`## Introduction`
doc(README): add more information 2020-09-07 06:13:51 -04:00
doc(README): update README 2020-09-12 16:34:39 -04:00			`Stack is a simple card-style Hugo theme designed for bloggers, some of its features are:`
doc(README): add more information 2020-09-07 06:13:51 -04:00
doc(README): update README 2020-09-12 16:34:39 -04:00			`- Responsive images support`
			`- Lazy load images`
			`- Dark mode`
doc: update README 2020-12-23 16:37:21 -05:00			`- Local search`
doc(README): update README 2020-09-12 16:34:39 -04:00			`- [PhotoSwipe](https://photoswipe.com/) integration`
			`- Archive page template`
			`- Full native JavaScript, no jQuery or any other frameworks are used`
			`- No CSS framework, keep it simple and minimal`
			`- Properly cropped thumbnails`
doc: update README 2020-12-23 16:37:21 -05:00			`- Subsection support`
feat: Table of Contents (#232) Currently, the new table of contents is disabled by default. I will change that after several versions. ------------- * feat: Table of Content (WIP) * fix: set scratch inside define block * fix(toc): darkmode text color * feat: unify page layout, and add config to disable toc * feat: add scroll-behavior: smooth to html * fix: use <ol> for TOC. And Disable TOC by default for now * refactor: use css flexbox for article page with toc enable toc for example site * feat(i18n): add i18n entry for "Back" and "Table of Contents" * style: remove unused `keep-sidebar` class * doc: add table of contents as feature 2021-06-21 12:44:54 -04:00			`- Table of contents`
doc(README): update README 2020-09-12 16:34:39 -04:00
			`## Requirements`

feat(menu): support open an entry in new tab (#294) * feat(menu): support open an entry in new tab closes https://github.com/CaiJimmy/hugo-theme-stack/issues/230 * Revert change in markup.tableOfContents.ordered * Upgrade Netlify Hugo version * doc: require Hugo Extended >= 0.87.0 2021-08-08 11:39:33 -04:00			`It's necessary to use Hugo Extended ≥ 0.87.0.`
📝 Add README 2020-08-23 02:55:34 -04:00
			`## Installation`

doc: update README to include license information 2021-07-09 07:04:30 -04:00			Clone / Download this repository to `theme` folder, and edit your site config following `exampleSite/config.yaml`.

			Note: Remove `config.toml` if there is one in the site folder.
📝 Add README 2020-08-23 02:55:34 -04:00
doc: update README 2020-12-23 16:37:21 -05:00			`Check [documentation](https://docs.stack.jimmycai.com/) for more details.`
doc(README): update README 2020-09-12 16:34:39 -04:00
📝 Add README 2020-08-23 02:55:34 -04:00			`## Copyright`

doc(README): add more information 2020-09-07 06:13:51 -04:00			`Licensed under the GNU General Public License v3.0`

			`Please do not remove the "Theme Stack designed by Jimmy" text and link.`

doc(README): update README 2020-09-12 16:34:39 -04:00			`If you want to port this theme to another blogging platform, please let me know🙏.`

doc(README): add sponsoring link 2020-10-04 18:32:57 -04:00			`## Sponsoring`

doc: update README 2020-12-23 16:37:21 -05:00			`If you like this theme, give it a star, and consider supporting its development:`
doc(README): add sponsoring link 2020-10-04 18:32:57 -04:00
chore: change funding link to Ko-fi 2020-12-23 07:20:53 -05:00			`[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C530AXX)`
doc(README): add sponsoring link 2020-10-04 18:32:57 -04:00
			`Your support is greatly appreciated :)`

doc(README): add more information 2020-09-07 06:13:51 -04:00			`## Thanks to`
📝 Add README 2020-08-23 02:55:34 -04:00
doc: update README to include license information 2021-07-09 07:04:30 -04:00			`\| Project \| Description \| Licence \|`
			`\| ------- \| ----------- \| ------- \|`
			`\| [PhotoSwipe](https://photoswipe.com/) \| For the lightbox effect \| [MIT](https://github.com/dimsemenov/PhotoSwipe/blob/master/LICENSE) \|`
			`\| [Normalize.css](https://github.com/necolas/normalize.css) \| - \| [MIT](https://github.com/necolas/normalize.css/blob/master/LICENSE.md) \|`
			`\| [Node Vibrant](https://github.com/Vibrant-Colors/node-vibrant) \| To extract the color from images \| [MIT](https://github.com/Vibrant-Colors/node-vibrant/blob/master/LICENSE.md)`
			`\| [Tabler icons](https://github.com/tabler/tabler-icons) \| Default menu icons \| [MIT](https://github.com/tabler/tabler-icons/blob/master/LICENSE) \|`
			`\| [jonsuh/hamburgers](https://github.com/jonsuh/hamburgers) \| Hamburger icon of menu \| [MIT](https://github.com/jonsuh/hamburgers/blob/master/LICENSE) \|`
			`\| [lepture/yue.css](https://github.com/lepture/yue.css) \| Part of it is used for styling article content \| MIT \|`
			`\| [Typlog](https://typlog.com/) \| Where the markdown gallery syntax is borrowed from \| The author gave me the permission \|`
			`\| [Pure CSS implementation of Google Photos / 500px image layout](https://github.com/xieranmaya/blog/issues/6) \| Used for image gallery \| - \|`

			`### References`

			`Some references that I took while building this theme:`

			`\| Project \| Licence\|`
			`\| ------- \| ------\|`
			`\| [artchen/hexo-theme-element](https://github.com/artchen/hexo-theme-element) \| [MIT](https://github.com/artchen/hexo-theme-element/blob/master/LICENSE) \|`
			`\| [MunifTanjim/minimo](https://github.com/MunifTanjim/minimo) \| [MIT](https://github.com/MunifTanjim/minimo/blob/master/LICENSE) \|`