diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 124 |
1 files changed, 79 insertions, 45 deletions
@@ -1,67 +1,81 @@ # Introduction theme for Hugo [](https://app.netlify.com/sites/hugo-introduction/deploys) -[](https://travis-ci.com/victoriadrake/hugo-theme-introduction) +  Introduction 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. - + Features: -* Multilingual - supports side-by-side content in different language versions -* Custom index page sections from Markdown files -* Projects and Blog sections -* Page load fade-in CSS effect and smooth scrolling to anchor links -* Straightforward customization via `config.toml` -* Styled Markdown throughout with syntax highlighting +- Multilingual - supports side-by-side content in different language versions +- Custom index page sections from Markdown files +- Projects and Blog sections +- Page load fade-in CSS effect and smooth scrolling to anchor links +- Straightforward customization via `config.toml` +- Styled Markdown throughout, including post titles +- Syntax highlighting Developer-friendly: -* 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/) -* Thoughtful use of Sass variables makes creating new colour schemes easy +- 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/) +- Thoughtful use of Sass variables makes creating new colour schemes easy -# Getting started -## Requirements -- Extended version of [Hugo](https://gohugo.io/getting-started/installing/) (latest version recommended) -- To make changes to the theme CSS: - - [autoprefixer](https://github.com/postcss/autoprefixer): `npm install -g autoprefixer` - - [postcss-cli](https://github.com/postcss/postcss-cli):`npm install -g postcss-cli` +## Getting started -Note: If you are using [Hugo as a snap app](https://snapcraft.io/hugo), the above two Node.js packages have to be [installed locally inside `exampleSite`](https://gohugo.io/hugo-pipes/postcss/). +Requires 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). +To 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`. + +```sh +npm i -g postcss postcss-cli autoprefixer ``` + +[Learn how to install and use npm here](https://www.npmjs.com/get-npm). + +Note: 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/). + +```sh cd exampleSite/ -npm install autoprefixer -npm install postcss-cli +npm i postcss postcss-cli autoprefixer ``` +If you see an error message like: + +```text +Error: Error building site: POSTCSS: failed to transform "css/main.css" (text/css): resource "sass/sass/style..." not found in file cache +``` + +See [issue #210](https://github.com/victoriadrake/hugo-theme-introduction/issues/210#issuecomment-645661326) for more information. + ## Get the theme + Run from the root of your Hugo site: + ```sh -$ git clone https://github.com/victoriadrake/hugo-theme-introduction.git themes/introduction +git clone https://github.com/victoriadrake/hugo-theme-introduction.git themes/introduction ``` Alternatively, 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: ```sh -$ git submodule add https://github.com/victoriadrake/hugo-theme-introduction.git themes/introduction +git submodule add https://github.com/victoriadrake/hugo-theme-introduction.git themes/introduction ``` ## Preview the theme Introduction ships with an fully configured example site. For a quick preview: -``` -cd exampleSite/ +```sh +cd themes/introduction/exampleSite/ hugo serve --themesDir ../.. ``` Then visit `http://localhost:1313/` in your browser to view the example site. - -# Add content +## Add content The following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder. @@ -69,7 +83,7 @@ The following explains how to add content to your Hugo site. You can find sample Create `index.md`: -``` +```sh hugo new home/index.md ``` @@ -88,7 +102,7 @@ Each markdown file will show as a section on the home page and can be ordered by You may add a contact section by creating `contact.md`: -``` +```sh hugo new home/contact.md ``` @@ -100,7 +114,7 @@ Introduction provides an easy way to showcase your projects. Each project can ev Start by creating an index file for the projects section: -``` +```sh hugo new projects/_index.md ``` @@ -109,7 +123,7 @@ Add an optional `weight` for ordering projects section. To create a project, run: -``` +```sh hugo new projects/YourProjectName/index.md ``` @@ -119,38 +133,41 @@ You can set `external_link` to make the project link to another website. Add 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: -``` +```sh resources: - src: NameOfYourImage.jpg params: weight: -100 +project_timeframe: "June-December" ``` +You can add a `project_timeframe` parameter to the frontmatter of your project to optionally display an arbitrary string on the homepage and modal. + ## Blog section Create an index file for the blog: -``` +```sh hugo new blog/_index.md ``` + Add an optional `weight` for ordering blog section on your homepage Create a new blog post with: -``` +```sh hugo new blog/YourEntryTitle.md ``` Posts will also display in the Blog section of the home page. - -# Configure your site +## Configure your site From `exampleSite/`, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. Helpful comments are provided. -## Multilingual Mode +## Multilingual -Introduction currently ships with support for English, German, Spanish and French. Contributions for other language translations are welcome. +Introduction currently ships with support for [many languages](https://github.com/victoriadrake/hugo-theme-introduction/tree/master/i18n). Contributions for other language translations are welcome. To create a new language translation, add the `.toml` file to the `i18n/` folder. See the existing files for the necessary fields. @@ -160,6 +177,14 @@ See the [hugo documentation](https://gohugo.io/content-management/multilingual/) Introduction contains a default menu. If you want to override this, you can do so by defining a `menu.main` in `config.toml`. +## Contact section clock + +Introduction 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`. + +## Plausible + +You 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. + ## Google Analytics Set `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analytics template](https://gohugo.io/templates/internal/#google-analytics). @@ -168,19 +193,28 @@ Set `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analy Set `disqusshortname` in `config.toml` to activate Hugo's [internal Disqus template](https://gohugo.io/templates/internal/#disqus). -## Custom css -You can add custom css files by placing them under `assets/` and adding the path to the file to `customCSS` in `config.toml`. +## Custom CSS + +You can add custom CSS files by placing them under `assets/` and adding the paths to the files to the `customCSS` list in `config.toml`. -# Issues +## Custom JavaScript + +You can add custom JavaScript files by placing them under `assets/` and adding the paths to the files to the `customJS` list in `config.toml`. + +## Issues If 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! -# Contributing -This theme would not be nearly as awesome without its amazing community of open source contributors, who are [listed here.](https://github.com/victoriadrake/hugo-theme-introduction/releases) Thank you so much! 🖤 +## Contributing + +Contributions for new translations, fixes, and features are welcome. + +This 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! ❤ + +## License -Pull requests for bug fixes and improvements are welcome. +Copyright (C) 2017-2021 [Victoria Drake](https://victoria.dev/) -# License -Copyright (C) 2017-2020 [Victoria Drake](https://victoria.dev/) +Licensed 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). -Licensed under [Apache-2.0](https://github.com/victoriadrake/hugo-theme-introduction/blob/master/LICENSE) +Unless 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. |