parent
798a1092c6
commit
c851da021b
4 changed files with 4 additions and 92 deletions
@ -1,89 +1,2 @@ |
|||||||
 |
|
||||||
|
|
||||||
# Hugo Theme Stack |
# Custom Hugo Theme |
||||||
|
|
||||||
> Card-style Hugo theme designed for bloggers. |
|
||||||
|
|
||||||
## Quickstart |
|
||||||
|
|
||||||
Use this template: [CaiJimmy/hugo-theme-stack-starter](https://github.com/CaiJimmy/hugo-theme-stack-starter) |
|
||||||
|
|
||||||
## Demo |
|
||||||
|
|
||||||
[Example Site](https://demo.stack.jimmycai.com/) |
|
||||||
|
|
||||||
[](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 |
|
||||||
* Multilingual mode and RTL support |
|
||||||
|
|
||||||
## Requirements |
|
||||||
|
|
||||||
It's necessary to use **Hugo Extended ≥ 0.87.0**. |
|
||||||
|
|
||||||
## Installation |
|
||||||
|
|
||||||
* Route 1: Clone / Download this repository to themes folder |
|
||||||
* Route 2: Turn your site into a hugo module and add this theme as a module dependency |
|
||||||
|
|
||||||
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: |
|
||||||
|
|
||||||
[](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) | |
|
||||||
|
|||||||
Loading…
Reference in new issue