Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yihui/hugo-xmag
A minimal magazine theme for Hugo
https://github.com/yihui/hugo-xmag
hugo-theme magazine-theme
Last synced: about 1 month ago
JSON representation
A minimal magazine theme for Hugo
- Host: GitHub
- URL: https://github.com/yihui/hugo-xmag
- Owner: yihui
- License: mit
- Created: 2017-07-10T05:09:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T18:57:15.000Z (7 months ago)
- Last Synced: 2024-08-01T12:27:22.250Z (4 months ago)
- Topics: hugo-theme, magazine-theme
- Language: HTML
- Homepage: https://xmag.yihui.org
- Size: 336 KB
- Stars: 96
- Watchers: 9
- Forks: 45
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - yihui/hugo-xmag - A minimal magazine theme for Hugo (others)
README
# HUGO XMAG
**XMag** is designed based on the Hugo theme [**XMin**](https://github.com/yihui/hugo-xmin), and similarly, features minimalism but with a magazine style on the homepage inspired by [The Signpost](https://en.wikipedia.org/wiki/Wikipedia:Wikipedia_Signpost) on Wikipedia.
This theme includes a few cool features:
- Responsive article summary blocks on homepage
- Thumbnails in summary blocks
- Magazine title in Blackletter (𝔅𝔏𝔄ℭ𝔎 𝔏𝔈𝔗𝔗𝔈ℜ)
- Github edit links
- Author info and site info at the bottom of an article
- MathJax for LaTeX math expressions
It also supports features that are probably not even worth mentioning:
- Google Analytics
- highlight.js for syntax highlighting of code blocks
- Display categories and tags on single pages
- Table of contents for single pages
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.
[](https://xmag.yihui.org)