Skip to content

Commit

Permalink
add two Rmd files for demo purposes
Browse files Browse the repository at this point in the history
  • Loading branch information
yihui committed Jun 21, 2017
1 parent ab6500e commit 2d53f6b
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 2 deletions.
24 changes: 24 additions & 0 deletions exampleSite/content/_index.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Home
---

[<img src="https://simpleicons.org/icons/github.svg" style="max-width:15%;min-width:40px;float:right;" alt="Github repo" />](https://github.com/yihui/hugo-xmin)

# HUGO XMIN

## _Keep it simple, but not simpler_

**XMin** is a Hugo theme written by [Yihui Xie](https://yihui.name) in about four hours: half an hour was spent on the Hugo templates, and 3.5 hours were spent on styling. The main motivation for writing this theme was to provide a really minimal example to beginners of Hugo templates. This XMin theme contains about 130 lines of code in total, including the code in HTML templates and CSS (also counting empty lines).

```{bash, comment='', echo=2}
cd ../..;
find . -not -path '*/exampleSite/*' \( -name '*.html' -o -name '*.css' \) | xargs wc -l
```

I can certainly further reduce the code, for example, by eliminating the CSS, but I believe a tiny bit CSS can greatly improve readability. You cannot really find many CSS frameworks that only contain 50 lines of code.

Although it is a minimal theme, it is actually fully functional. It supports pages (including the home page), blog posts, a navigation menu, categories, tags, and RSS. With [a little bit customization](https://github.com/yihui/hugo-xmin/blob/master/exampleSite/layouts/partials/foot_custom.html), it can easily support LaTeX math expressions, e.g.,

`$${\sqrt {n}}\left(\left({\frac {1}{n}}\sum _{i=1}^{n}X_{i}\right)-\mu \right)\ {\xrightarrow {d}}\ N\left(0,\sigma ^{2}\right)$$`

All pages not under the root directory of the website are listed below. You can also visit the list page of a single section, e.g., [posts](/post/), or [notes](/note/). See the [About](/about/) page for the usage of this theme.
4 changes: 2 additions & 2 deletions exampleSite/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ find . -not -path '*/exampleSite/*' \( -name '*.html' -o -name '*.css' \) | xarg
12 ./layouts/_default/single.html
16 ./layouts/_default/terms.html
0 ./layouts/partials/foot_custom.html
9 ./layouts/partials/footer.html
19 ./layouts/partials/footer.html
0 ./layouts/partials/head_custom.html
19 ./layouts/partials/header.html
7 ./static/css/fonts.css
50 ./static/css/style.css
136 total
146 total
```

I can certainly further reduce the code, for example, by eliminating the CSS, but I believe a tiny bit CSS can greatly improve readability. You cannot really find many CSS frameworks that only contain 50 lines of code.
Expand Down
19 changes: 19 additions & 0 deletions exampleSite/content/post/2017-06-21-an-r-markdown-example.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: An R Markdown Example
author: Yihui Xie
date: '2017-06-21'
categories:
- Example
- R
tags:
- blogdown
slug: an-r-markdown-example
---

This is a simple R Markdown example, with a single R code chunk below.

```{r}
knitr::kable(head(mtcars))
```

The table shows the first 6 rows of the `mtcars` dataset in base R.
31 changes: 31 additions & 0 deletions exampleSite/content/post/2017-06-21-an-r-markdown-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: An R Markdown Example
author: Yihui Xie
date: '2017-06-21'
categories:
- Example
- R
tags:
- blogdown
slug: an-r-markdown-example
---

This is a simple R Markdown example, with a single R code chunk below.


```r
knitr::kable(head(mtcars))
```



| | mpg| cyl| disp| hp| drat| wt| qsec| vs| am| gear| carb|
|:-----------------|----:|---:|----:|---:|----:|-----:|-----:|--:|--:|----:|----:|
|Mazda RX4 | 21.0| 6| 160| 110| 3.90| 2.620| 16.46| 0| 1| 4| 4|
|Mazda RX4 Wag | 21.0| 6| 160| 110| 3.90| 2.875| 17.02| 0| 1| 4| 4|
|Datsun 710 | 22.8| 4| 108| 93| 3.85| 2.320| 18.61| 1| 1| 4| 1|
|Hornet 4 Drive | 21.4| 6| 258| 110| 3.08| 3.215| 19.44| 1| 0| 3| 1|
|Hornet Sportabout | 18.7| 8| 360| 175| 3.15| 3.440| 17.02| 0| 0| 3| 2|
|Valiant | 18.1| 6| 225| 105| 2.76| 3.460| 20.22| 1| 0| 3| 1|

The table shows the first 6 rows of the `mtcars` dataset in base R.

0 comments on commit 2d53f6b

Please sign in to comment.