{"id":14981479,"url":"https://github.com/filipecarneiro/hugo-bootstrap-theme","last_synced_at":"2025-05-16T14:08:12.891Z","repository":{"id":37441807,"uuid":"492466316","full_name":"filipecarneiro/hugo-bootstrap-theme","owner":"filipecarneiro","description":"Hugo theme for a secure, blazing fast and SEO-ready static website, using Bootstrap 5.","archived":false,"fork":false,"pushed_at":"2025-03-20T14:48:13.000Z","size":8799,"stargazers_count":154,"open_issues_count":0,"forks_count":30,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-15T06:40:13.152Z","etag":null,"topics":["bootstrap","bootstrap5","bootstrap5-template","hugo","hugo-theme","static-site-generator"],"latest_commit_sha":null,"homepage":"https://filipecarneiro.github.io/hugo-bootstrap-theme/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/filipecarneiro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2022-05-15T11:23:56.000Z","updated_at":"2025-05-15T03:09:16.000Z","dependencies_parsed_at":"2023-12-19T12:24:32.187Z","dependency_job_id":"7441cada-4ff4-411a-8701-effaef4d1161","html_url":"https://github.com/filipecarneiro/hugo-bootstrap-theme","commit_stats":{"total_commits":213,"total_committers":3,"mean_commits":71.0,"dds":0.3661971830985915,"last_synced_commit":"5ea7b3439df0e69144f64b66924fa6870a295579"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipecarneiro%2Fhugo-bootstrap-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipecarneiro%2Fhugo-bootstrap-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipecarneiro%2Fhugo-bootstrap-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/filipecarneiro%2Fhugo-bootstrap-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/filipecarneiro","download_url":"https://codeload.github.com/filipecarneiro/hugo-bootstrap-theme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"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":["bootstrap","bootstrap5","bootstrap5-template","hugo","hugo-theme","static-site-generator"],"created_at":"2024-09-24T14:03:41.093Z","updated_at":"2025-05-16T14:08:07.879Z","avatar_url":"https://github.com/filipecarneiro.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hugo Bootstrap Theme\n\n[![Build and Deploy to gh-pages branch](https://github.com/filipecarneiro/hugo-bootstrap-theme/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/filipecarneiro/hugo-bootstrap-theme/actions/workflows/gh-pages.yml) [![Publish to GitHub Pages](https://github.com/filipecarneiro/hugo-bootstrap-theme/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/filipecarneiro/hugo-bootstrap-theme/actions/workflows/pages/pages-build-deployment)\n\nTheme for a blazing fast static website and/or blog using bootstrap 5.\n\n![Screenshot](https://github.com/filipecarneiro/hugo-bootstrap-theme/blob/main/images/tn.png)\n\n## Demo\n\n- [https://filipecarneiro.github.io/hugo-bootstrap-theme/](https://filipecarneiro.github.io/hugo-bootstrap-theme/)\n\n## Features\n\n- 🛡️ Security aware\n  \n  Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.\n\n- ⚡Fast by default\n  \n  Get 100 scores on Google Lighthouse by default. Hugo Bootstrap Theme removes unused css, prefetches links, and lazy loads images.\n  \n- 📈 SEO-ready\n  \n  Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the Search Engine Optimization settings to your liking.\n\n## Framework\n\n### Hugo\n\nHugo is the **world’s fastest static website engine**. It’s written in Go (aka Golang).\n\n- [Hugo Documentation](https://gohugo.io/documentation/)\n\n- [Go template documentation](https://golang.org/pkg/text/template/#hdr-Functions)\n\n### Bootstrap\n\nGet started with Bootstrap\n\n- [Bootstrap 5.3](https://getbootstrap.com/docs/5.3/getting-started/introduction/)\n\n- [Install Bootstrap in your Node.js powered apps with the npm package](https://getbootstrap.com/docs/5.3/getting-started/download/#npm)\n\n### Requirements\n\nThe tools used are cross-platform and should work on Windows, MacOS and Linux. You will need the following tools to be downloaded and installed:\n\n- [Hugo static site builder](https://github.com/goHugoio/Hugo/releases) - IMPORTANT: make sure you pick the extended version, Hugo_extended_0.xx.x_…\n\n- [Node \u0026 NPM](https://nodejs.org/) - We use this to maintain project dependencies\n\n- [Git](https://git-scm.com/downloads) - This is optional, but highly recommended for version control and remote backups.\n\n## Usage\n\n### Test the theme locally on your computer\n\nClone this repo:\n\n```\ngit clone https://github.com/filipecarneiro/hugo-bootstrap-theme.git\n```\n\nTest if the site is working:\n\n```\nhugo server -D --disableFastRender --source exampleSite\n```\n\nThis launches Hugo development server and you can see the example site by opening http://localhost:1313/hugo-bootstrap-theme/.\n\nYou can also use Hugo as an installed NPM local package. In this case, you don't need to install Hugo globally:\n\n```\nnpm install\nnpm run start\n```\n\nThis will install Hugo in a `bin` subfolder and then run it, using the NPM package `exec-bin`.\n\n### Install on an existing Hugo site\n\n#### Step 1: Install via NPM\n\n```\nnpm install @filipecarneiro/hugo-bootstrap-theme\n```\n\nHugo bootstrap theme package will also add bootstrap and feather-icons to node modules.\n\n#### Step 2: Add to Config\n\nThen add the theme `hugo-bootstrap-theme` to your sites [configuration file](https://gohugo.io/getting-started/configuration/#configuration-file) `config.toml`, `config.yaml` or `config.json`:\n\n```toml\ntheme = \"hugo-bootstrap-theme\"\nthemesdir = \"node_modules/@filipecarneiro\"\n```\n\nThe new themes directory (themesdir) is needed to get the new theme from the `node_modules` folder.\n\n#### Step 3: Test your site\n\n```\nhugo server -D --disableFastRender\n```\n\n#### Step 4: Check your parameters\n\nCheck your `copyright` variable, your menus (the theme supports `main`, `footer` and `social` menus), etc.\n\nHave a look on exampleSite for inspiration :)\n\n### Start from Scratch\n\n#### Step 1: Create a new Hugo site\n\nFollow [Hugo Quick Start](https://gohugo.io/getting-started/quick-start/) to create a new site, add a sample page and change basic settings.\n\nSince you've created an Git repository, let's specify some Hugo files and folders to ignore.\n\nCreate a `.gitignore` file on the root of your project with this content:\n\n```txt\npublic\nnode_modules\nresources\n.hugo_build.lock\n```\n\nOptionally, add a remote repository and push your code.\n\n#### Step 2: Install and configure Hugo Bootstrap Theme\n\nUpdate npm to the latest version:\n\n```\nnpm install -g npm\n```\n\nIf you don't have npm, [download and install Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).\n\nThen, create an npm package for your site:\n\n```\nnpm init -y\n```\n\nIf wanted, you can customize your package information, editing the generated `package.json` file.\n\nNow, install Hugo Bootstrap Theme:\n\n```\nnpm install @filipecarneiro/hugo-bootstrap-theme --save-dev\n```\n\nThen add the theme `hugo-bootstrap-theme` to your site configuration file `config.toml`:\n\n```toml\ntheme = 'hugo-bootstrap-theme'\nthemesdir = 'node_modules/@filipecarneiro'\n```\n\nChange the existing `theme` value from `ananke` to `hugo-bootstrap-theme` and add a new line for `themesdir`, like above.\n\nAdd some [configuration](https://gohugo.io/getting-started/configuration/), like `copyright`, `description` and your menus (the theme supports `main`, `footer` and `social` menus).\n\nHave a look on exampleSite for inspiration :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilipecarneiro%2Fhugo-bootstrap-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffilipecarneiro%2Fhugo-bootstrap-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilipecarneiro%2Fhugo-bootstrap-theme/lists"}