{"id":14981365,"url":"https://github.com/kakawait/hugo-tranquilpeak-theme","last_synced_at":"2025-05-15T21:06:25.317Z","repository":{"id":37706476,"uuid":"55093419","full_name":"kakawait/hugo-tranquilpeak-theme","owner":"kakawait","description":"A gorgeous responsive theme for Hugo blog framework","archived":false,"fork":false,"pushed_at":"2023-10-08T03:42:45.000Z","size":17984,"stargazers_count":929,"open_issues_count":112,"forks_count":517,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-05-13T13:08:45.268Z","etag":null,"topics":["blog","blog-theme","gorgeous-responsive-theme","hacktoberfest","hugo","hugo-theme","responsive","static-site-generator","syntax-highlighting","theme","tranquilpeak"],"latest_commit_sha":null,"homepage":"https://tranquilpeak.kakawait.com","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kakawait.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-30T19:55:05.000Z","updated_at":"2025-05-02T08:52:19.000Z","dependencies_parsed_at":"2024-10-11T22:21:46.066Z","dependency_job_id":"80e4b8b5-389b-44dc-a6a5-d9018abf2d8b","html_url":"https://github.com/kakawait/hugo-tranquilpeak-theme","commit_stats":{"total_commits":289,"total_committers":47,"mean_commits":6.148936170212766,"dds":0.301038062283737,"last_synced_commit":"3b5676afca7e667fc0d5c7f012c2ad00ca6dd9f0"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kakawait%2Fhugo-tranquilpeak-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kakawait%2Fhugo-tranquilpeak-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kakawait%2Fhugo-tranquilpeak-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kakawait%2Fhugo-tranquilpeak-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kakawait","download_url":"https://codeload.github.com/kakawait/hugo-tranquilpeak-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254422761,"owners_count":22068678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog","blog-theme","gorgeous-responsive-theme","hacktoberfest","hugo","hugo-theme","responsive","static-site-generator","syntax-highlighting","theme","tranquilpeak"],"created_at":"2024-09-24T14:03:23.558Z","updated_at":"2025-05-15T21:06:20.307Z","avatar_url":"https://github.com/kakawait.png","language":"SCSS","funding_links":[],"categories":["SCSS"],"sub_categories":[],"readme":"# Tranquilpeak\n\n[![Twitter Follow](https://img.shields.io/twitter/follow/thibaudlepretre.svg?style=social\u0026label=%40thibaudlepretre)](https://twitter.com/intent/follow?screen_name=thibaudlepretre)\n\nA gorgeous responsive theme for Hugo blog framework.\n\n![Tranquilpeak](https://raw.githubusercontent.com/kakawait/hugo-tranquilpeak-theme/master/showcase.png)\n\n## Alpha/Beta versions\n\n**ATTENTION** during *alpha* or *beta* [versions](https://github.com/kakawait/hugo-tranquilpeak-theme/milestones) breaking changes are possible on config file.\n\nYou can track [breaking changes label](https://github.com/kakawait/hugo-tranquilpeak-theme/issues?q=is%3Aissue+is%3Aopen+label%3A%22breaking+changes%22).\n\nHow can I migrate my current version? Please read [CHANGELOG.md](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/CHANGELOG.md).\n\n## Summary\n\n- [General](#general)\n- [Features](#features)\n- [Quick start](#quick-start)\n- [Demo](#demo)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [Showcase](#showcase)\n- [License](#license)\n\n## General\n\n- **Authors**: [Thibaud Leprêtre (kakawait)](https://github.com/kakawait) and [Louis Barranqueiro (LouisBarranqueiro)](https://github.com/LouisBarranqueiro)\n- **Version**: 0.5.3-BETA (based on Hexo version 3.1.0)\n- **Compatibility**: Hugo v0.53\n\n## Features\n\n**General features:**\n\n- Fully responsive\n- Optimized for tablets \u0026 mobiles\n- Configurable menu of the sidebar\n- Pages to filter tags, categories and archives\n- Background cover image\n- Beautiful about page\n- Support Open Graph protocol\n- Easily customizable (fonts, colors, layout elements, code coloration, etc..)\n- Support internationalization (i18)\n\n**Posts features:**\n\n- Thumbnail image\n- Cover image\n- Responsive videos \u0026 images\n- Sharing options\n- Navigation menu\n- GitHub theme for code highlighting (customizable)\n- Image gallery\n- Tags for images (FancyBox), wide images, tabbed code blocks, highlighted text, alerts\n- Table of contents\n\n**Integrated services:**\n\n- Disqus\n- Gitlak\n- Google analytics\n- Gravatar\n- Facebook Insights\n\n### Missing features from original *Hexo* version\n\n- [ ] Algolia (https://github.com/kakawait/hugo-tranquilpeak-theme/issues/8)\n- [ ] Pagination customization `tagPagination`, `categoryPagination` and `archivePagination` (https://github.com/kakawait/hugo-tranquilpeak-theme/issues/17)\n\n**ATTENTION** following features will not be possible due to *Hugo* limitations\n\n- Archives pages by years `/archives/2015`\n- Archives pages by month `/archives/2015/01`\n\n## Quick start\n\n**Please read [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md), it's short and useful to discover all features and possibilities of the theme, especially the  [writing posts](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md#writing-posts) section**\n\n### For people who want to use the original version of Tranquilpeak without modifications (users)\n\nGo to the directory where you have your Hugo site and run:\n\n```shell\nmkdir themes\ncd themes\ngit clone https://github.com/kakawait/hugo-tranquilpeak-theme.git\n```\n\nAfter installing the Tranquilpeak theme successfully, we recommend you to take a look at the [exampleSite](exampleSite) directory. You will find a working Hugo site configured with the Tranquilpeak theme that you can use as a starting point for your site.\n\nFirst, let's take a look at the [config.toml](exampleSite/config.toml). It will be useful to learn how to customize your site. Feel free to play around with the settings.\n\nMore information on [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md) to install and configure the theme\n\n### For people who want to create their own version of tranquilpeak (developers)\n\n1. Run `git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git`\n2. Follow [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md) to edit and build the theme\n\n## Demo\n\nCheck out Tranquilpeak theme in live : [hugo-tranquilpeak-theme demo](https://tranquilpeak.kakawait.com)\n\n## Showcase\n\nCheckout showcase https://tranquilpeak.kakawait.com/2015/06/who-is-using-tranquilpeak-hugo-theme/\n\n### How can I add my site to the showcase\n\n**Click [here](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/new?title=Add%20my%20blog%20into%20the%20showcase\u0026body=Hey,%20add%20my%20blog%20into%20the%20showcase:) to add your blog into the showcase.**\n\nPlease fill the following information:\n\n1. public url\n2. name (optional)\n3. description (optional)\n\n## Documentation\n\nIf it's your first time using Hugo, please check [Hugo official documentation](https://gohugo.io/overview/introduction/)\n\n### For users\n\nTo install and configure the theme, consult the following documentation : [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)\n\n### For developers\n\nTo understand the code, the workflow and edit the theme, consult the following documentation : [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md)\n\n## Contributing\n\nAll kinds of contributions (enhancements, features, documentation \u0026 code improvements, bugs reporting) are welcome.\n\nRead [guidelines for contributing](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/.github/CONTRIBUTING.md) for more information.\n\n## Credits\n\n*Hugo* version of Tranquilpeak is a based on original *Hexo* version https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak. This version is simply a port to *Hugo* static site generator.\n\n## License\n\nhugo-tranquilpeak-theme is released under the terms of the [GNU General Public License v3.0](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkakawait%2Fhugo-tranquilpeak-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkakawait%2Fhugo-tranquilpeak-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkakawait%2Fhugo-tranquilpeak-theme/lists"}