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

github.com/yihui/hugo-xmag.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYihui Xie <xie@yihui.name>2017-07-12 01:20:14 +0300
committerYihui Xie <xie@yihui.name>2017-07-12 01:22:02 +0300
commit80ef808b5e5cf341ced42258e6fcee576a55ba0a (patch)
treede16c87c7fe9afb21414b105b897b2d8366b477a
parentca7b46a66f3d4c4e67c5751a686d4f62785316b5 (diff)
extend readme
-rw-r--r--README.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7eeef5b..310dda5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,31 @@
# HUGO XMAG
-A minimal magazine theme for Hugo.
+**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 (&Bfr;&Lfr;&Afr;&Cfr;&Kfr; &Lfr;&Efr;&Tfr;&Tfr;&Efr;&Rfr;)
+
+- 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.name/about/) page of the theme website. The source code is available [on Github](https://github.com/yihui/hugo-xmag) (MIT license).
[![Screenshot](https://github.com/yihui/hugo-xmag/raw/master/images/screenshot.png)](https://xmag.yihui.name)