{"id":14981466,"url":"https://github.com/techmagus/hugo-theme-showcase","last_synced_at":"2025-10-02T22:31:37.212Z","repository":{"id":42618037,"uuid":"411146290","full_name":"techmagus/hugo-theme-showcase","owner":"techmagus","description":"Fork used in https://im.youronly.one; https://im.youronly.one/confidentraveler/; https://im.youronly.one/faithfulathlete/; https://im.youronly.one/yugenbard/","archived":false,"fork":true,"pushed_at":"2024-10-07T07:40:33.000Z","size":7245,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-11-15T12:18:35.264Z","etag":null,"topics":["hugo","hugo-theme","youronlyone"],"latest_commit_sha":null,"homepage":"https://im.youronly.one","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"apvarun/showcase-hugo-theme","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/techmagus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-28T05:16:01.000Z","updated_at":"2024-08-15T01:56:28.000Z","dependencies_parsed_at":"2023-01-28T03:46:46.118Z","dependency_job_id":null,"html_url":"https://github.com/techmagus/hugo-theme-showcase","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techmagus%2Fhugo-theme-showcase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techmagus%2Fhugo-theme-showcase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techmagus%2Fhugo-theme-showcase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techmagus%2Fhugo-theme-showcase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/techmagus","download_url":"https://codeload.github.com/techmagus/hugo-theme-showcase/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235049009,"owners_count":18927715,"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":["hugo","hugo-theme","youronlyone"],"created_at":"2024-09-24T14:03:36.969Z","updated_at":"2025-10-02T22:31:31.301Z","avatar_url":"https://github.com/techmagus.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Showcase theme for Hugo\n\n![Latest Release](https://img.shields.io/github/tag/apvarun/showcase-hugo-theme.svg)\n![Showcase hugo theme](https://img.shields.io/github/license/apvarun/showcase-hugo-theme)\n![Hugo generator](https://img.shields.io/badge/generator-hugo-brightgreen)\n\nShowcase is a minimal, single page theme for Hugo\n\n![Preview](https://github.com/apvarun/showcase-hugo-theme/raw/main/images/screenshot.png)\n\n![Preview Dark](https://github.com/apvarun/showcase-hugo-theme/raw/main/images/screenshot-dark.png)\n\nFeatures:\n\n- Auto-generated menu\n- Responsive content\n- Filtering content\n- Social links\n- Custom menu\n- Darkmode\n\n## Get the theme\n\nRun from the root of your Hugo site:\n\n```sh\ngit clone https://github.com/apvarun/showcase-hugo-theme.git themes/showcase\n```\n\nAlternatively, you can include this repository as a [git submodule](https://git-scm.com/docs/gitsubmodules). This makes it easier to update this theme if you have your Hugo site in git as well:\n\n```sh\ngit submodule add https://github.com/apvarun/showcase-hugo-theme.git themes/showcase\n```\n\n## Preview the theme with example content\n\nShowcase theme ships with an fully configured example site. For a quick preview:\n\nCopy the `package.json` file from `themes/showcase` folder to your hugo website root folder, and run `npm install`.\n\n```sh\ncd themes/showcase/exampleSite/\nhugo serve --themesDir ../..\n```\n\nThen visit `http://localhost:1313/` in your browser to view the example site.\n\n## Configuring theme to a hugo website\n\n1. Copy `package.json` and `package-lock.json` to the root folder of your the website\n2. Run `npm install` to install required packages for theme\n3. Run `npm i -g postcss-cli` to use PostCSS with Hugo build\n4. Set `theme = 'showcase'` in config.toml\n5. Run `npm start` to start your local server\n\nMake sure to commit the above changes to your repository.\n\nWhen deploying to services like Netlify or Vercel, use the following command for building your site:\n\n```sh\nnpm i \u0026\u0026 hugo -D --gc\n```\n\n## Migrating to v1.3.0\n\nMinimum Hugo Version: 0.69.0\n\n- Copy the `package.json` file from `themes/showcase` folder to your hugo website root folder, and run `npm install`.\n\n## Add content\n\nThe following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder.\n\n### Structure:\n    .\n    ├── ...\n    ├── projects       # Section Name\n    │   ├── project1   # Project 1\n    │   ├── project2   # Project 2\n    │   └── _index     # (optional) Customize section name \u0026\n    │                  # default image for section contents\n    └── ...\n\n\n## Configure your site\n\nFrom `exampleSite/`, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. Helpful comments are provided.\n\n## Menu\n\nMenu in Showcase theme is auto-generated from the sections inside your content folder.\n\n### Exclude Sections from Menu\n\nIt is possible to exclude sections from the auto-generated list. In order to exclude a section, create an `_index.md` file in that section and set the property `private` to `true`. Refer example [index file](https://github.com/apvarun/showcase-hugo-theme/blob/master/exampleSite/content/books/_index.md).\n\n### Custom Menu\n\nYou can also add a custom menu item using the `config.toml` and disable auto-generated sections if not required. Refer config in [exampleSite](https://github.com/apvarun/showcase-hugo-theme/blob/master/exampleSite/config.toml)\n\n## Dark mode\n\nIn order to enable darkmode toggle in your side, set the `params.darkMode` property to `true` in your `config.toml`.\n\n## Google Analytics\n\nSet `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analytics template](https://gohugo.io/templates/internal/#google-analytics).\n\n## Used By\n\n- [Madhu Akula](https://madhuakula.com/content/)\n- [@cloudmiracle](http://cloud.vn/)\n\n## Issues\n\nIf you have a question, please [open an issue](https://github.com/apvarun/showcase-hugo-theme/issues) for help and to help those who come after you. The more information you can provide, the better!\n\n## Contributing\n\nContributions are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\nLicensed under [MIT](LICENSE)\n\n## Acknowledgements\n\n[Madhu Akula](https://github.com/madhuakula)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechmagus%2Fhugo-theme-showcase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechmagus%2Fhugo-theme-showcase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechmagus%2Fhugo-theme-showcase/lists"}