diff options
author | Stephen Taylor <sjt@5jt.com> | 2022-11-09 18:05:52 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-11-09 18:05:52 +0300 |
commit | d771674f97b1d472285689c05d600037cb48563c (patch) | |
tree | 364181f9e6d46e0636489dbf6597206de62dba76 /README.md | |
parent | ee94952fda389cbbeb339e585e07682753b97915 (diff) |
fix #13 and also fix #23
Co-authored-by: Stephen Taylor <stephen@kx.com>
Co-authored-by: Yihui Xie <xie@yihui.name>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -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) |