{"id":13425192,"url":"https://github.com/victoriadrake/hugo-theme-introduction","last_synced_at":"2025-05-14T19:07:29.696Z","repository":{"id":18713734,"uuid":"84793453","full_name":"victoriadrake/hugo-theme-introduction","owner":"victoriadrake","description":"Minimal, single page, smooth-scrolling theme for Hugo static site generator.","archived":false,"fork":false,"pushed_at":"2025-01-30T19:06:22.000Z","size":11990,"stargazers_count":688,"open_issues_count":3,"forks_count":267,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-04T21:02:08.684Z","etag":null,"topics":["blog-theme","hugo","hugo-blog-theme","hugo-theme","language-translation","light","personal-website","postcss","smooth-scrolling","theme"],"latest_commit_sha":null,"homepage":"https://hugo-introduction.netlify.app/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victoriadrake.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"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},"funding":{"github":"victoriadrake"}},"created_at":"2017-03-13T06:50:23.000Z","updated_at":"2025-04-30T10:59:15.000Z","dependencies_parsed_at":"2024-01-16T12:49:59.090Z","dependency_job_id":"9ca7f034-85ed-4193-a56b-871c13742eae","html_url":"https://github.com/victoriadrake/hugo-theme-introduction","commit_stats":{"total_commits":396,"total_committers":64,"mean_commits":6.1875,"dds":0.702020202020202,"last_synced_commit":"7bbb117bebd6844dccdf60785f8588f98f7628b1"},"previous_names":["vickylaixy/hugo-theme-introduction"],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fhugo-theme-introduction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fhugo-theme-introduction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fhugo-theme-introduction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Fhugo-theme-introduction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victoriadrake","download_url":"https://codeload.github.com/victoriadrake/hugo-theme-introduction/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254209859,"owners_count":22032897,"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-theme","hugo","hugo-blog-theme","hugo-theme","language-translation","light","personal-website","postcss","smooth-scrolling","theme"],"created_at":"2024-07-31T00:01:07.007Z","updated_at":"2025-05-14T19:07:28.629Z","avatar_url":"https://github.com/victoriadrake.png","language":"HTML","funding_links":["https://github.com/sponsors/victoriadrake"],"categories":["HTML"],"sub_categories":[],"readme":"# Introduction theme for Hugo\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/51d09485-c9d1-4a88-90ba-894f09e5a29d/deploy-status)](https://app.netlify.com/sites/hugo-introduction/deploys)\n![Test Hugo versions](https://github.com/victoriadrake/hugo-theme-introduction/workflows/test-versions/badge.svg)\n![Latest Release](https://img.shields.io/github/tag/victoriadrake/hugo-theme-introduction.svg)\n\nIntroduction is a minimalist, highly-versatile theme for Hugo. It can be configured as a single page, or as a full-featured site with multiple sections. It is multilingual, responsive, and includes a light and dark theme.\n\nNew to the Hugo static site generator? [Learn the fundamentals here](https://gohugo.io/categories/fundamentals).\n\n![Device mockups](https://github.com/victoriadrake/hugo-theme-introduction/blob/master/images/mockup.png)\n\nFeatures:\n\n- Multilingual - supports side-by-side content in different language versions\n- Custom index page sections from Markdown files\n- Projects and Blog sections\n- Page load fade-in CSS effect and smooth scrolling to anchor links\n- Straightforward customization via `config.toml`\n- Styled Markdown throughout, including post titles\n- Syntax highlighting\n\nDeveloper-friendly:\n\n- Sass files included with instant compiling to CSS thanks to [Hugo Pipes](https://gohugo.io/hugo-pipes/postcss/) and [PostCSS](https://gohugo.io/hugo-pipes/postcss/)\n- Thoughtful use of Sass variables makes creating new colour schemes easy\n\n## Getting started\n\nRequires the **extended** version of Hugo. You can find [installation instructions here](https://gohugo.io/getting-started/installing/) (latest version recommended). Here's a handy [Bash function for downloading a specific Hugo version](https://victoria.dev/blog/how-to-do-twice-as-much-with-half-the-keystrokes-using-.bashrc/#bash-function-for-downloading-extended-hugo).\n\nTo make changes to the theme CSS, extended Hugo's [PostCSS](https://gohugo.io/hugo-pipes/postcss/) requires JavaScript packages to compile the styles. You'll need `postcss`, `postcss-cli`, and `autoprefixer`. Install these globally with `npm`.\n\n```sh\nnpm i -g postcss postcss-cli autoprefixer\n```\n\n[Learn how to install and use npm here](https://www.npmjs.com/get-npm).\n\nNote: If you are using [Hugo as a snap app](https://snapcraft.io/hugo), the above Node.js packages have to be [installed locally inside `exampleSite`](https://gohugo.io/hugo-pipes/postcss/).\n\n```sh\ncd exampleSite/\nnpm i postcss postcss-cli autoprefixer\n```\n\nIf you see an error message like:\n\n```text\nError: Error building site: POSTCSS: failed to transform \"css/main.css\" (text/css): resource \"sass/sass/style...\" not found in file cache\n```\n\nSee [issue #210](https://github.com/victoriadrake/hugo-theme-introduction/issues/210#issuecomment-645661326) for more information.\n\n## Get the theme\n\nRun from the root of your Hugo site:\n\n```sh\ngit clone https://github.com/victoriadrake/hugo-theme-introduction.git themes/introduction\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/victoriadrake/hugo-theme-introduction.git themes/introduction\n```\n\n## Preview the theme\n\nIntroduction ships with an fully configured example site. For a quick preview:\n\n```sh\ncd exampleSite \u0026\u0026 HUGO_THEME=\"hugo-theme-introduction\" hugo server --themesDir ../..\n```\n\nThen visit `http://localhost:1313/` in your browser to view the example site.\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## Introduction section\n\nCreate `index.md`:\n\n```sh\nhugo new home/index.md\n```\n\nThe `title` frontmatter will be the first large heading.\n\nThe content of `index.md` will be shown as a subtitle line.\n\nYou might want to set `headless` to `true` in the frontmatter. See [headless bundles](https://gohugo.io/content-management/page-bundles/#headless-bundle) for more information.\n\n## Home page\n\nContent for the home page lives under `content/home/`. You may add as many files as you want to in markdown format.\n\nEach markdown file will show as a section on the home page and can be ordered by the `weight` value in the file's frontmatter. You can set `image` to show an image on the left side of the section. The image file must be in the `content/home/` folder.\n\nYou may add a contact section by creating\n`contact.md`:\n\n```sh\nhugo new home/contact.md\n```\n\nThis will always be shown as the last section on the home page.\n\n## Projects section\n\nIntroduction provides an easy way to showcase your projects. Each project can even have its own gallery, shown as an image carousel.\n\nStart by creating an index file for the projects section:\n\n```sh\nhugo new projects/_index.md\n```\n\nAdd a `title` and some optional content to the file.\nAdd an optional `weight` for ordering projects section.\n\nTo create a project, run:\n\n```sh\nhugo new projects/YourProjectName/index.md\n```\n\nThe frontmatter of your new file contains some comments to help your configure your project.\n\nYou can set `external_link` to make the project link to another website.\n\nAdd images to your project by placing image files in the `YourProjectName/` folder. If you add more then one photo, they will display as a carousel gallery. Images will be ordered by filename. The first image will be shown as the project preview image. You can change the order of your images by adding a `weight` to that resource's parameters:\n\n```sh\nresources:\n    - src: NameOfYourImage.jpg\n      params:\n          weight: -100\nproject_timeframe: \"June-December\"\n```\n\nYou can add a `project_timeframe` parameter to the frontmatter of your project to optionally display an arbitrary string on the homepage and modal.\n\n## Blog section\n\nCreate an index file for the blog:\n\n```sh\nhugo new blog/_index.md\n```\n\nAdd an optional `weight` for ordering blog section on your homepage\n\nCreate a new blog post with:\n\n```sh\nhugo new blog/YourEntryTitle.md\n```\n\nPosts will also display in the Blog section of the home page.\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## Multilingual\n\nIntroduction currently ships with support for [many languages](https://github.com/victoriadrake/hugo-theme-introduction/tree/master/i18n). Contributions for other language translations are welcome.\n\nTo create a new language translation, add the `.toml` file to the `i18n/` folder. See the existing files for the necessary fields.\n\nSee the [hugo documentation](https://gohugo.io/content-management/multilingual/) for more details.\n\n## Menu\n\nIntroduction contains a default menu. If you want to override this, you can do so by defining a `menu.main` in `config.toml`.\n\nOptionally, you can disable this menu by setting `showMenu` to `false` in your `config.toml`.\n\n## Contact section clock\n\nIntroduction can optionally show your current local time in your [contact section](https://hugo-introduction.netlify.app/#contact). This uses vanilla JS and variables you provide. You can set this up by copying the settings in the exampleSite `config.toml` for `localTime`, `timeZone`, and `timeFormat`.\n\n## Plausible\n\nYou can easily use Plausible.io for analytics by setting `plausible = true` in your `config.toml`. Plausible offers a privacy-friendly alternative to Google Analytics. You'll need your own Plausible account - see [plausible.io](https://plausible.io/) for more.\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). This supports both Google Analytics 3 (Universal Analytics) and Google Analytics 4. Google Analytics 3 tracking id is of the form 'UA-PROPERTY_ID', and Google Analytics 4 tracking is of the form 'G-MEASUREMENT_ID'.\n\n## Disqus\n\nSet `disqusshortname` in `config.toml` to activate Hugo's [internal Disqus template](https://gohugo.io/templates/internal/#disqus).\n\n## Custom CSS\n\nYou can add custom CSS files by placing them under `assets/` and adding the paths to the files to the `customCSS` list in `config.toml`.\n\n## Custom JavaScript\n\nYou can add custom JavaScript files by placing them under `assets/` and adding the paths to the files to the `customJS` list in `config.toml`.\n\n## Issues\n\nIf you have a question or get stuck, please [open an issue](https://github.com/victoriadrake/hugo-theme-introduction/issues) for help and to help those who come after you. The more information you can provide, the better!\n\n## Contributing\n\nContributions for new translations, fixes, and features are welcome.\n\nThis theme would not be nearly as awesome without its amazing community of open source [contributors](https://github.com/victoriadrake/hugo-theme-introduction/graphs/contributors). Thank you so much! ❤\n\n## License\n\nCopyright (C) 2017-2025 [Victoria Drake](https://victoria.dev/)\n\nLicensed under the [Apache License, Version 2.0](https://github.com/victoriadrake/hugo-theme-introduction/blob/master/LICENSE) (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictoriadrake%2Fhugo-theme-introduction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictoriadrake%2Fhugo-theme-introduction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictoriadrake%2Fhugo-theme-introduction/lists"}