From f46f84b1a1eca274fd0baef23dd4e6246404f1f6 Mon Sep 17 00:00:00 2001 From: KemoNine Date: Sat, 18 Mar 2023 18:47:09 -0400 Subject: [PATCH] tweak first post to be more narrow in scope, remove welcome page ; update index page to be more useful and cover the welcome text ; add example page of various supported syntax and what it looks like when rendered --- content/_index.md | 9 ++- content/posts/2023-03-18-first-post.md | 9 +-- content/tips/_example.md | 103 +++++++++++++++++++++++++ content/tips/_welcome.md | 20 ----- 4 files changed, 111 insertions(+), 30 deletions(-) create mode 100644 content/tips/_example.md delete mode 100644 content/tips/_welcome.md diff --git a/content/_index.md b/content/_index.md index be4365e..b6fdb0b 100644 --- a/content/_index.md +++ b/content/_index.md @@ -4,6 +4,11 @@ title: Home # accessible.tips -## A collection of accessibility tips +## A collection of accessibility tips, tricks and life hacks + +Welcome to the accessible.tips knowledge base. Here you will find a variety of tips that can help manage living with disability. The intent of the site is to be something of a [zettelkasten](https://zettelkasten.de/) mind map of various things that make living with disability easier. + +You can use the different headings at the top to discover content. The search function has also been setup to work across the whole website if you are looking for a specific term. + +We have also published an [RSS feed](/index.xml) if you'd like to subscribe to updates. -Please use the main menu at the top of the page to browse diff --git a/content/posts/2023-03-18-first-post.md b/content/posts/2023-03-18-first-post.md index f6631ce..b715079 100644 --- a/content/posts/2023-03-18-first-post.md +++ b/content/posts/2023-03-18-first-post.md @@ -1,19 +1,12 @@ +++ title = "First Post" author = "KemoNine" -publishDate = 2023-03-17 +publishDate = 2023-03-18 lastmod = 2023-03-18 draft = false -tags = [ - "foo", - "bar" -] categories = [ - "tips", "blog" ] +++ The site has been created and more details will be published as time permits. - -The intent of the site is to be something of a [zettelkasten](https://zettelkasten.de/) of various things that making living with any disability easier. diff --git a/content/tips/_example.md b/content/tips/_example.md new file mode 100644 index 0000000..c66d3c6 --- /dev/null +++ b/content/tips/_example.md @@ -0,0 +1,103 @@ ++++ +title = "_Example" +author = "KemoNine" +publishDate = 2023-03-16 +lastmod = 2023-03-18 +toc = true +draft = false +categories = [ + "blog", + "tips" +] +tags = [ + "faq", + "example" +] ++++ + +## Changelog +{{< back_to_top >}} +{{< changelog >}} +{{< change 2023-03-17 "test change 1" >}} +{{< change 2023-03-18 "test change 2" >}} +{{< /changelog >}} + +This sample post is mainly for [**blogdown**](https://github.com/rstudio/blogdown) users. If you do not use **blogdown**, you can skip the first section. + +## 1. Markdown or R Markdown +{{< back_to_top >}} + +This is a post written in plain Markdown (`*.md`) instead of R Markdown (`*.Rmd`). The major differences are: + +1. You cannot run any R code in a plain Markdown document, whereas in an R Markdown document, you can embed R code chunks (```` ```{r} ````); +2. A plain Markdown post is rendered through [Blackfriday](https://gohugo.io/overview/configuration/), and an R Markdown document is compiled by [**rmarkdown**](http://rmarkdown.rstudio.com) and [Pandoc](http://pandoc.org). + +There are many differences in syntax between Blackfriday's Markdown and Pandoc's Markdown. For example, you can write a task list with Blackfriday but not with Pandoc: + +- [x] Write an R package. +- [ ] Write a book. +- [ ] ... +- [ ] Profit! + +Similarly, Blackfriday does not support LaTeX math and Pandoc does. I have added the MathJax support to this theme ([hugo-xmin](https://github.com/yihui/hugo-xmin)) but there is a caveat for plain Markdown posts: you have to include math expressions in a pair of backticks (inline: `` `$ $` ``; display style: `` `$$ $$` ``), e.g., `$S_n = \sum_{i=1}^n X_i$`.^[This is because we have to protect the math expressions from being interpreted as Markdown.] For R Markdown posts, you do not need the backticks, because Pandoc can identify and process math expressions. + +When creating a new post, you have to decide whether the post format is Markdown or R Markdown, and this can be done via the `rmd` argument of the function `blogdown::new_post()`, e.g. + +```r +blogdown::new_post("Post Title", rmd = FALSE) +``` + +Actually I recommend you to use the RStudio addin "New Post" instead: + +![RStudio addin New Post](https://bookdown.org/yihui/blogdown/images/new-post.png) + +## 2. Sample Text +{{< back_to_top >}} + +### Third-level header +{{< back_to_top >}} + +#### Fourth-level header +{{< back_to_top >}} + +A paragraph (with a footnote): + +**Lorem ipsum** dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore _magna aliqua_. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.^[I'm sure you are bored by the text here.] + +A blockquote (a gray bar at the left and lightgray background): + +> Quisque mattis volutpat lorem vitae feugiat. Praesent porta est quis porta imperdiet. Aenean porta, mi non cursus volutpat, mi est mollis libero, id suscipit orci urna a augue. In fringilla euismod lacus, vitae tristique massa ultricies vitae. Mauris accumsan ligula tristique, viverra nulla sed, porta sapien. Vestibulum facilisis nec nisl blandit convallis. Maecenas venenatis porta malesuada. Ut ac erat tortor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla sodales quam sit amet tincidunt egestas. In et turpis at orci vestibulum ullamcorper. Aliquam sed ante libero. Sed hendrerit arcu lacus. + +Some code (with a drop-shadow effect): + +```js +(function() { + var quotes = document.getElementsByTagName('blockquote'), i, quote; + for (i = 0; i < quotes.length; i++) { + quote = quotes[i]; + var n = quote.children.length; + if (n === 0) continue; + var el = quote.children[n - 1]; + if (!el || el.nodeName !== 'P') continue; + // right-align a quote footer if it starts with --- + if (/^—/.test(el.textContent)) el.style.textAlign = 'right'; + } +})(); +``` + +A table (centered by default): + +| Sepal.Length| Sepal.Width| Petal.Length| Petal.Width|Species | +|------------:|-----------:|------------:|-----------:|:-------| +| 5.1| 3.5| 1.4| 0.2|setosa | +| 4.9| 3.0| 1.4| 0.2|setosa | +| 4.7| 3.2| 1.3| 0.2|setosa | +| 4.6| 3.1| 1.5| 0.2|setosa | +| 5.0| 3.6| 1.4| 0.2|setosa | +| 5.4| 3.9| 1.7| 0.4|setosa | + +An image (automatically centered when it is appropriate): + +![Happy Elmo](https://slides.yihui.org/gif/happy-elmo.gif) + +Looks good? diff --git a/content/tips/_welcome.md b/content/tips/_welcome.md deleted file mode 100644 index 9697f98..0000000 --- a/content/tips/_welcome.md +++ /dev/null @@ -1,20 +0,0 @@ -+++ -title = "_Welcome" -author = "KemoNine" -publishDate = 2023-03-18 -lastmod = 2023-03-18 -draft = false -tags = [ - "foo", - "bar" -] -categories = [ - "welcome" -] -+++ - -Welcome to the knowledge base. Here you will find a variety of tips that can help manage living with disability. - -Please poke around the different headings at the top to discover content. The search function works across the whole website and does *not* use a 3rd party search service. - -We have also published an [RSS feed](/index.xml) if you'd like to subscribe to updates.