Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/vickylaixy/hugo-theme-introduction.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVicky <vicky@vickylai.com>2018-09-03 10:49:47 +0300
committerVicky <vicky@vickylai.com>2018-09-03 10:49:47 +0300
commit03e80406a580dc59f5e7c99b8e18c3401462ed74 (patch)
tree9d86a69b5515f45e9d402e54edc520efb8dc44f0 /README.md
parentf43e8a50584698bbec15ec7872559096ef26efac (diff)
Update README and screenshots
Diffstat (limited to 'README.md')
-rw-r--r--README.md178
1 files changed, 132 insertions, 46 deletions
diff --git a/README.md b/README.md
index 91322b8..5220225 100644
--- a/README.md
+++ b/README.md
@@ -2,87 +2,173 @@
[![Build Status](https://travis-ci.com/vickylai/hugo-theme-introduction.svg?branch=master)](https://travis-ci.com/vickylai/hugo-theme-introduction)
![Latest Release](https://img.shields.io/github/tag/vickylai/hugo-theme-introduction.svg)
-A minimal, smooth-scrolling theme for Hugo. Can be configured as a single page site or full-featured site with many sections.
+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.
![Main page screenshot](https://github.com/vickylai/hugo-theme-introduction/blob/master/images/screenshot.png)
Features:
-- Minimalist home page
- - About section with profile photo
- - Contact section with option to show your local timezone
- - Optional Projects and Blog sections
-- Light and Dark themes
-- Browser friendly CSS fade-in effect for some pizzaz
-- Smooth scroll-to-section navigation
-- Responsive and fast
-
-## Getting started
-### Requirements
-- [Hugo](https://gohugo.io/getting-started/installing/) extended version 0.45 or greater
-- [autoprefixer](https://github.com/postcss/autoprefixer): `npm install -g autoprefixer`
-- [postcss-cli](https://github.com/postcss/postcss-cli):`npm install -g postcss-cli`
-
-### Get the theme
+
+* 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
+
+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
+
+# Getting started
+## Requirements
+- [Hugo](https://gohugo.io/getting-started/installing/) Static Site Generator (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`
+
+## Get the theme
Run from the root of your Hugo site:
```sh
$ git clone https://github.com/vickylai/hugo-theme-introduction.git themes/introduction
```
-Alternatively you can include this repository as a [git submodule](https://git-scm.com/book/de/v1/Git-Tools-Submodule). This makes it easier to update this theme if you have your Hugo site in git as well. For this you need to run:
+Alternatively, you can include this repository as a [git submodule](https://git-scm.com/book/de/v1/Git-Tools-Submodule). 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/vickylai/hugo-theme-introduction.git themes/introduction
```
-### Configure your site
-From the exampleSite, copy `config.toml` to the root folder of your Hugo site and change the fields as you like.
+## Preview the theme
+
+Introduction ships with an fully configured example site. For a quick preview:
-The following explains how to add content to your hugo site. Introduction ships with an fully configured example site. For a quick preview just go into `exampleSite/` and run `hugo --themesDir ../..`. If you have configuration problems, you might want to check out how its done in `exampleSite/`.
+```
+cd exampleSite/
+hugo serve --themesDir ../..
+```
-### Home page
-Content for the home page lives under `content/home/`. Create `index.md` (`hugo new home/index.md`) and set a *title*. The content of this file will be shown as a tag line. You might want to set [*headless*](https://gohugo.io/content-management/page-bundles/#headless-bundle) to `true`. You may add more files to the home section. They show up automaticity on the home page and can be ordered via *weight*. You can set *image* for a page to show an image on the left side. The image has to be placed inside `content/home`.
+Then visit `http://localhost:1313/` in your browser to view the example site.
+
+
+# Add content
+
+The following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder.
+
+## Introduction section
+
+Create `index.md`:
+
+```
+hugo new home/index.md
+```
+
+The `title` frontmatter will be the first large heading.
+
+The content of `index.md` will be shown as a subtitle line.
+
+You 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.
+
+## Home page
+
+Content for the home page lives under `content/home/`. You may add as many files as you want to in markdown format.
+
+Each 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.
You may add a contact section by creating
-`contact.md` (`hugo new home/contact.md`). This will allways be shown last on the home page.
+`contact.md`:
+
+```
+hugo new home/contact.md
+```
+
+This will always be shown as the last section on the home page.
+
+## Projects section
+
+Introduction provides an easy way to showcase your projects. Each project can even have its own gallery, shown as an image carousel.
+
+Start by creating an index file for the projects section:
-### Projects section
-Introduction provides an easy way to your projects. You can even add a gallery to your projects. Start by creating an index file (`hugo new projects/_index.md`), which you needs a *title*. You can also add some text.
+```
+hugo new projects/_index.md
+```
+
+Add a `title` and some optional content to the file.
+
+To create a project, run:
+
+```
+hugo new projects/YourProjectName/index.md
+```
+
+The frontmatter of your new file contains some comments to help your configure your project.
+
+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:
-Now you are ready to add some projects. Jet again, create an index file (`hugo new creating/YourProjectName/index.md`). You can add *external_link* to create a link to a website. Or add images to your project by placing them in the same folder as the index file you just created. If you add more then one photo, a gallery will be created. Images are ordered by there filename. The first image will be used as a project preview image. If you want to change the order of your image, you can do this by adding *weight* to some image via font matter in your index file:
```
resources:
- src: NameOfYourImage.jpg
params:
weight: -100
```
-The projects themself can also be ordered by *weight*.
-### Blog section
-Creating a blog section is quite simple with Introduction. Just add an index file for the section (`hugo new blog/_index.md`). Then you can create as many blog entry as you like via (`hugo new blog/YourEntryTitle.md`). They will also automaticity appear on the home page.
+## Blog section
-## Advanced configuration
-### Multilingual Mode
-You can create a multilingual website with Introduction. The default config file even contains all necessary configuration option. You just have to adjust the accordingly.
+Create an index file for the blog:
-Introduction ships with some translation. If you want to add a new language, you have to add a necessary translations to `i18n`. See the [hugo documentation](https://gohugo.io/content-management/multilingual/) for more details.
+```
+hugo new blog/_index.md
+```
-### Menu
-Introduction contains a default menu. If you want to override this, you can do so by defining a *menu.main* in your config file.
+Create a new blog post with:
+
+```
+hugo new blog/YourEntryTitle.md
+```
-### Disqus and Google Analytics
-Introduction supports comments from Disqus. You just have to set *disqusshortname* in your config file.
+Posts will also display in the Blog section of the home page.
-It also offers tracking via Google Analytics. For this to work, you have to set *googleAnalytics*.
+
+# 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
+
+Introduction currently ships with support for English, German, and Spanish. 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.
+
+See the [hugo documentation](https://gohugo.io/content-management/multilingual/) for more details.
+
+## Menu
+
+Introduction contains a default menu. If you want to override this, you can do so by defining a `menu.main` in `config.toml`.
+
+## Google Analytics
+
+Set `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analytics template](https://gohugo.io/templates/internal/#google-analytics).
+
+## Disqus
+
+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 your css file to *customCSS* in your config file.
+You can add custom css files by placing them under `assets/` and adding the path to the file to `customCSS` in `config.toml`.
+
+# Issues
+
+If you have a question or get stuck, please [open an issue](https://github.com/vickylai/hugo-theme-introduction/issues) for help and to help those who come after you. The more information you can provide, the better!
-## Contributing
-Pull requests for bug fixes and suggestions are welcome.
+# Contributing
+This theme would not be nearly as awesome without its amazing community of open source contributors, who are [listed here.]() Thank you so much! 🖤
-Contributors are listed in [CHANGELOG.md](https://github.com/vickylai/hugo-theme-introduction/blob/master/CHANGELOG.md). Thank you so much! 🖤
+Pull requests for bug fixes and improvements are welcome.
-## License
-Copyright (C) 2018 [Vicky Lai](https://vickylai.com/introduction/)
+# License
+Copyright (C) 2018 [Vicky Lai](https://vickylai.com/)
-Licensed under [AGPL-3.0](https://github.com/vickylai/hugo-theme-introduction/blob/master/LICENSE)
+Licensed under [Apache-2.0](https://github.com/vickylai/hugo-theme-introduction/blob/master/LICENSE)