Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added install instructions aligned to Hugo Quickstart Guide #14

Merged
merged 8 commits into from
Nov 9, 2022
Merged
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,26 @@ It also supports features that are probably not even worth mentioning:

Most features can be configured through `config.toml`, and a few can be enabled by custom layouts. Please see the detailed documentation on the [About](https://xmag.yihui.org/about/) page of the theme website. The source code is available [on Github](https://github.com/yihui/hugo-xmag) (MIT license).

## Quickstart guide

If you are an R user, the easiest way to get started with this theme is to install the **blogdown** package, and [use `blogdown::new_site()` to create a new site](https://bookdown.org/yihui/blogdown/a-quick-example.html):

```r
install.packages('blogdown')
blogdown::new_site(theme = 'yihui/hugo-xmag')
```

If you do not use R, please read on.

**Watch out** The standard [Quickstart Guide](https://gohugo.io/getting-started/quick-start/) fails. In Step 3 do not proceed past `git init`.

Then, to install this theme in your Hugo site

1. Download this repo and unzip it
1. Change directory to the site root
1. Copy the downloaded theme into `themes/`: `cp -r ~/Downloads/hugo-mag-master themes/hugo-mag`
1. Copy the example site into your site root: `cp -r themes/hugo-mag/exampleSite .`

Now resume the Quickstart Guide at Step 5.

[![Screenshot](https://github.com/yihui/hugo-xmag/raw/master/images/screenshot.png)](https://xmag.yihui.org)