diff --git a/_data/navigation.yml b/_data/navigation.yml index 710fe4ed..e6900f66 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -38,10 +38,10 @@ docs: path: configuration - title: "Navigation" path: navigation - - title: "Authors" - path: authors - title: "UI Text" path: ui-text + - title: "Authors" + path: authors - title: "Layouts" path: layouts diff --git a/_docs/03-installation.md b/_docs/03-installation.md index aba6931d..9e0986e8 100644 --- a/_docs/03-installation.md +++ b/_docs/03-installation.md @@ -8,7 +8,6 @@ sidebar: --- {% include base_path %} -{% include toc %} ## Install the Theme @@ -19,7 +18,7 @@ There are several ways to install the theme: **2.** For an **existing site** you have some more work ahead of you. What I suggest is to fork and rename the theme's repo as before, then clone it locally by running `git clone https://github.com/USERNAME/REPONAME.git` --- replacing **USERNAME** and **REPONAME** with your own.
- copy GitHub repo URL + copy GitHub repo URL
Tap the copy to clipboard button (outlined in red above) to grab your GitHub repo's path.
diff --git a/_docs/04-upgrading.md b/_docs/04-upgrading.md index 4b8b0efa..e33ab995 100644 --- a/_docs/04-upgrading.md +++ b/_docs/04-upgrading.md @@ -8,7 +8,6 @@ sidebar: --- {% include base_path %} -{% include toc %} Currently there is no good way of upgrading the theme without doing a bit of manual work. The future looks promising with [**gem based themes**](https://github.com/jekyll/jekyll/pull/4595) on the horizon, but for now here's some suggestions on how handle theme updates. diff --git a/_docs/07-ui-text.md b/_docs/07-ui-text.md new file mode 100644 index 00000000..bd19ceb6 --- /dev/null +++ b/_docs/07-ui-text.md @@ -0,0 +1,18 @@ +--- +title: "UI Text" +permalink: /docs/ui-text/ +excerpt: +sidebar: + title: "v3.0" + nav: docs +--- + +{% include base_path %} + +Text found various UI elements, `_layouts`, and `_includes` have all been grouped together as a set of translation keys. This is by no means a full-on i18n solution, but it does help make customizing things a bit easier. + +Currently all of the keys in `_data/ui-text.yml` are English only. If you're are interested in localizing for other languages feel free to submit pull-requests and I will be happy to look the over and merge in. + +Many of the label based keys like `meta_label`, `categories_label`, `tags_label`, `share_on_label`, `follow_label`, and more can be left blank if you'd like to omit them. It really depends on you and if you want an even more minimal look to your site. + +![UI text labels]({{ base_path }}/images/mm-ui-text-labels.jpg) \ No newline at end of file diff --git a/_docs/08-authors.md b/_docs/08-authors.md new file mode 100644 index 00000000..904836eb --- /dev/null +++ b/_docs/08-authors.md @@ -0,0 +1,43 @@ +--- +title: "Authors" +permalink: /docs/authors/ +excerpt: +sidebar: + title: "v3.0" + nav: docs +--- + +{% include base_path %} + +Sites that may have content authored from various individuals can be accommodated by using [data files](https://jekyllrb.com/docs/datafiles/). + +To attribute an author to a post or page that is different from the site author specified in `_config.yml`: + +**Step 1.** Create `_data/authors.yml` and add authors using the following format. Anything variables found under `author` in `_config.yml` can be used (e.g. `name`, `avatar`, `uri`, social media profiles, etc.). + +```yaml +# /_data/authors.yml + +Billy Rick: + name: "Billy Rick" + uri: "http://thewhip.com" + email: "billy@rick.com" + bio: "What do you want, jewels? I am a very extravagant man." + avatar: "bio-photo-2.jpg" + twitter: "extravagantman" + +Cornelius Fiddlebone: + name: "Cornelius Fiddlebone" + email: "cornelius@thewhip.com" + bio: "I ordered what?" + avatar: "bio-photo.jpg" + twitter: "rhymeswithsackit" +``` + +**Step 2.** Assign one of the authors in `authors.yml` to a post or page you wish to override the `site.author` with. + +Example: To assign `Billy Rick` as an author for a post the following YAML Front Matter would be applied: + +```yaml +author: Billy Rick +``` diff --git a/_posts/2012-03-15-layout-author-override.md b/_posts/2012-03-15-layout-author-override.md index 31e8bcd0..c27aa668 100644 --- a/_posts/2012-03-15-layout-author-override.md +++ b/_posts/2012-03-15-layout-author-override.md @@ -4,33 +4,35 @@ author: Billy Rick excerpt: "A post to test author overrides using a data file." --- -For those of you who may have content written by multiple authors on your site you can now assign different authors to each post if desired. +Sites that may have content authored from various individuals can be accommodated by using [data files](https://jekyllrb.com/docs/datafiles/). -Previously the theme used a global author for the entire site and those attributes would be used in all bylines, social networking links, Twitter Card attribution, and Google Authorship. These `owner` variables were defined in `config.yml` +To attribute an author to a post or page that is different from the site author specified in `_config.yml`: -Start by modifying or creating a new `authors.yml` file in the `_data` folder and add your authors using the following format. +**Step 1.** Create `_data/authors.yml` and add authors using the following format. Anything variables found under `author` in `_config.yml` can be used (e.g. `name`, `avatar`, `uri`, social media profiles, etc.). ```yaml # /_data/authors.yml Billy Rick: - name: Billy Rick - uri: http://thewhip.com - email: billy@rick.com + name: "Billy Rick" + uri: "http://thewhip.com" + email: "billy@rick.com" bio: "What do you want, jewels? I am a very extravagant man." - avatar: bio-photo-2.jpg - twitter: extravagantman + avatar: "bio-photo-2.jpg" + twitter: "extravagantman" Cornelius Fiddlebone: - name: Cornelius Fiddlebone - email: cornelius@thewhip.com + name: "Cornelius Fiddlebone" + email: "cornelius@thewhip.com" bio: "I ordered what?" - avatar: bio-photo.jpg - twitter: rhymeswithsackit + avatar: "bio-photo.jpg" + twitter: "rhymeswithsackit" ``` -To assign Billy Rick as an author for our post. You'd add the following YAML front matter to a post: +**Step 2.** Assign one of the authors in `authors.yml` to a post or page you wish to override the `site.author` with. + +Example: To assign `Billy Rick` as an author for a post the following YAML Front Matter would be applied: ```yaml author: Billy Rick -``` +``` \ No newline at end of file diff --git a/images/mm-github-copy-repo-url.jpg b/images/mm-github-copy-repo-url.jpg new file mode 100644 index 00000000..0a62b555 Binary files /dev/null and b/images/mm-github-copy-repo-url.jpg differ diff --git a/images/mm-github-copy-repo-url.png b/images/mm-github-copy-repo-url.png deleted file mode 100644 index bde74ada..00000000 Binary files a/images/mm-github-copy-repo-url.png and /dev/null differ diff --git a/images/mm-ui-text-labels.jpg b/images/mm-ui-text-labels.jpg new file mode 100644 index 00000000..5b51ceb3 Binary files /dev/null and b/images/mm-ui-text-labels.jpg differ