Skip to content

Commit

Permalink
rename .Rmd to .Rmarkdown and add the build script
Browse files Browse the repository at this point in the history
  • Loading branch information
yihui committed Aug 9, 2017
1 parent 4888812 commit 0a869e2
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ find . -not -path '*/exampleSite/*' \( -name '*.html' -o -name '*.css' \) | xarg
0 ./layouts/partials/foot_custom.html
9 ./layouts/partials/footer.html
0 ./layouts/partials/head_custom.html
19 ./layouts/partials/header.html
20 ./layouts/partials/header.html
7 ./static/css/fonts.css
50 ./static/css/style.css
136 total
137 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
6 changes: 6 additions & 0 deletions exampleSite/R/build.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
file.copy('content/_index.markdown', '../README.md', overwrite = TRUE)
system("sed -i '' -e '1,6d' -e '34,38d' ../README.md")
cat(
'[![Screenshot](https://github.com/yihui/hugo-xmin/raw/master/images/screenshot.png)](https://xmin.yihui.name)\n',
file = '../README.md', append = TRUE
)
2 changes: 1 addition & 1 deletion exampleSite/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title = "A minimal Hugo website"
theme = "hugo-xmin"
googleAnalytics = ""
disqusShortname = ""
ignoreFiles = ["\\.Rmd$", "_files$", "_cache$"]
ignoreFiles = ["\\.Rmd$", "\\.Rmarkdown$", "_files$", "_cache$"]
preserveTaxonomyNames = true
footnotereturnlinkcontents = ""

Expand Down
24 changes: 24 additions & 0 deletions exampleSite/content/_index.Rmarkdown
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.
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ find . -not -path '*/exampleSite/*' \( -name '*.html' -o -name '*.css' \) | xarg
0 ./layouts/partials/foot_custom.html
9 ./layouts/partials/footer.html
0 ./layouts/partials/head_custom.html
19 ./layouts/partials/header.html
20 ./layouts/partials/header.html
7 ./static/css/fonts.css
50 ./static/css/style.css
136 total
137 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

0 comments on commit 0a869e2

Please sign in to comment.