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

github.com/AngeloStavrow/indigo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAngelo Stavrow <angelo@fogcreek.com>2018-10-05 13:54:51 +0300
committerAngelo Stavrow <angelo@fogcreek.com>2018-10-05 13:54:51 +0300
commitfb2984079a942aba751778d3ab393ab457f5e2c2 (patch)
treee0619067846a379364456d1755033e82efdba3ef /exampleSite
parent716e1cf22a3e8d71125037b6cfa2e7f7e14243b1 (diff)
Add example site with content (closes #16)
Diffstat (limited to 'exampleSite')
-rw-r--r--exampleSite/archetypes/default.md6
-rw-r--r--exampleSite/config.toml39
-rw-r--r--exampleSite/config.toml.bak3
-rw-r--r--exampleSite/content/about.md13
-rw-r--r--exampleSite/content/adding-menu-items.md9
-rw-r--r--exampleSite/content/post/author-bios.md57
-rw-r--r--exampleSite/content/post/featured-typefaces.md53
-rw-r--r--exampleSite/content/post/introducing-indigo.md85
8 files changed, 265 insertions, 0 deletions
diff --git a/exampleSite/archetypes/default.md b/exampleSite/archetypes/default.md
new file mode 100644
index 0000000..00e77bd
--- /dev/null
+++ b/exampleSite/archetypes/default.md
@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
new file mode 100644
index 0000000..6c2329a
--- /dev/null
+++ b/exampleSite/config.toml
@@ -0,0 +1,39 @@
+baseURL = "https://example.com/"
+title = "Indigo Theme"
+copyright = "Copyright © 2018, Angelo Stavrow"
+languageCode = "en-US"
+theme = "../.."
+paginate = 3
+
+[params]
+ Author = "Author Name"
+ Description = "Description of website for head meta tag"
+ Subtitle = "A subtitle for your site"
+ Avatar = "images/site-logo.svg"
+ Biography = "A short description, a few sentences describing the author. Set the 'ShowBio' parameter to false to hide this."
+ ShowBio = true
+ PermalinkText = "🔗"
+
+ # Contact/social-network identifiers for social icons
+ EmailAddress = "email.address@example.com"
+ FacebookUser = "FacebookUserName"
+ FlickrUser = "FlickrUserName"
+ GitHubUser = "GitHubUserName"
+ GitLabUser = "GitLabUserName"
+ GlitchUser = "GlitchUserName"
+ KeybaseUser = "KeybaseUserName"
+ MicroBlogUser = "MicroBlogUserName"
+ StackOverflowUser = "StackOverflowUserName"
+ TumblrUser = "TumblrUserName"
+ TwitterUser = "TwitterUserName"
+
+ # These are parameters used for indieweb identity. You should set these along
+ # with the above email/social network parameters.
+ [params.indieWeb]
+ EmailAddress = "email.address@example.com"
+ FlickrUser = "FlickrUserName"
+ GitHubUser = "GitHubUserName"
+ TwitterUser = "TwitterUserName"
+ MicroBlogUser = "MicroBlogUserName"
+ Country = "CountryName"
+ City = "CityName" \ No newline at end of file
diff --git a/exampleSite/config.toml.bak b/exampleSite/config.toml.bak
new file mode 100644
index 0000000..e4b7418
--- /dev/null
+++ b/exampleSite/config.toml.bak
@@ -0,0 +1,3 @@
+baseURL = "http://example.org/"
+languageCode = "en-us"
+title = "My New Hugo Site"
diff --git a/exampleSite/content/about.md b/exampleSite/content/about.md
new file mode 100644
index 0000000..1e5303f
--- /dev/null
+++ b/exampleSite/content/about.md
@@ -0,0 +1,13 @@
+---
+title: "About The Theme"
+menu: "main"
+draft: false
+---
+
+Indigo is a lightweight theme for [Hugo][hugo] with [IndieWeb][indieweb] features baked in. It's great for longer-form blogging, placing its focus on distraction-free reading and beautiful typefaces.
+
+Read more about the theme [here][intro].
+
+[hugo]: https://gohugo.io
+[indieweb]: https://indieweb.org/
+[intro]: /post/introducing-indigo \ No newline at end of file
diff --git a/exampleSite/content/adding-menu-items.md b/exampleSite/content/adding-menu-items.md
new file mode 100644
index 0000000..36016cb
--- /dev/null
+++ b/exampleSite/content/adding-menu-items.md
@@ -0,0 +1,9 @@
+---
+title: "Adding Page Items"
+menu: "main"
+draft: false
+---
+
+Indigo supports adding a simple navigation-style menu items across the top of the site. To do so, simply add a `menu: "main"` entry in your page's front matter (TOML format shown).
+
+If no date is included in the front matter, then the published date won't be shown (as in this page). \ No newline at end of file
diff --git a/exampleSite/content/post/author-bios.md b/exampleSite/content/post/author-bios.md
new file mode 100644
index 0000000..0c2af9a
--- /dev/null
+++ b/exampleSite/content/post/author-bios.md
@@ -0,0 +1,57 @@
+---
+title: "Author Bios"
+date: 2018-10-01T08:00:00-04:00
+draft: false
+categories: ["meta"]
+tags: ["options"]
+---
+
+The bottom of every page in the theme can optionally show a short biography of the site author, including a profile picture, email link, and location.
+
+<!--more-->
+
+## Setting up the author bio
+
+A set of configuration options are used for displaying the biography.
+
+```
+[params]
+ Author = "Author Name"
+ Avatar = "images/site-logo.svg"
+ Biography = "A short description, a few sentences describing the author. Set
+ the 'ShowBio' parameter to false to hide this."
+ ShowBio = true
+
+[params.indieWeb]
+ EmailAddress = "email.address@example.com"
+ Country = "CountryName"
+ City = "CityName"
+```
+
+Specifics on each setting item are as follows:
+
+- `Author`: Your name; this is the site author name.
+- `Avatar`: The path to your profile picture. By default, it will show the theme's logo (`/static/images/site-logo.svg`).
+- `Biography`: Hopefully the placeholder text here is self-explanatory; add a couple of short sentences about yourself here.
+- `ShowBio`: If you prefer not to show the author bio, set this to `false`. By default, it's set to `true`.
+- `EmailAddress`: The email address at which you can be contacted.
+- `Country`: The name of the country in which you live.
+- `City`: The name of the city in which you live.
+
+## IndieWeb features
+
+The following classes are used to mark up the author bio for [IndieWeb][indieweb] parsing:
+
+| Element | Class |
+| :-------------- | :-------------------------- |
+| The author card | `h-card` |
+| Profile picture | `u-photo` |
+| Author URL* | `p-name`, `u-url`, `rel=me` |
+| City | `p-locality` |
+| Country | `p-country-name` |
+| Email address | `u-email` |
+| Biography | `p-note` |
+
+*Author URL is set to the site's base URL.
+
+[indieweb]: https://indieweb.org/ \ No newline at end of file
diff --git a/exampleSite/content/post/featured-typefaces.md b/exampleSite/content/post/featured-typefaces.md
new file mode 100644
index 0000000..3df7a45
--- /dev/null
+++ b/exampleSite/content/post/featured-typefaces.md
@@ -0,0 +1,53 @@
+---
+title: "Featured Typefaces"
+date: 2018-10-01T08:30:00-04:00
+draft: false
+categories: ["meta"]
+tags: ["typography"]
+---
+
+Indigo uses a combination of three beautiful typefaces to render your words.
+
+<!--more-->
+
+- [Fira Sans][fira-sans] for heading text
+- [Charter][charter] for body text
+- [Fira Code][fira-code] for monospaced text
+
+Licenses are included in the theme’s `static/fonts` folder.
+
+Have a look at a couple of paragraphs of placeholder text using the wonderfully readable Charter:
+
+---
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer eleifend nulla ac elit venenatis posuere. Sed id aliquam arcu, et malesuada lectus. **Donec et dignissim massa. Pellentesque in laoreet nibh. Pellentesque sagittis, libero quis vestibulum aliquam, ante risus imperdiet magna, at ornare dolor libero quis nunc.** Donec quis tempus purus. Cras ornare magna ac facilisis tristique. Nulla aliquet purus quis massa rutrum interdum ac at magna. Cras fermentum magna id orci viverra facilisis. Ut vitae lobortis nisl.
+
+Sed interdum tincidunt venenatis. Sed hendrerit dictum nisi, at dignissim orci consectetur quis. Aenean sed nisl et nisl placerat euismod. Proin hendrerit nulla at rhoncus molestie. Cras eu gravida erat, vestibulum ornare diam. _Praesent nunc arcu, ultrices et risus sed, dictum mattis dui. Maecenas vitae nisl at massa porta pellentesque_. Donec eget urna eget nisl imperdiet scelerisque eget a mauris. Nam fringilla sem id vehicula rhoncus. Curabitur tincidunt massa mauris, facilisis placerat odio eleifend sit amet. Etiam nec vehicula sapien, at dignissim risus. Sed elit erat, lacinia eu vulputate at, semper eu nulla. Quisque a urna sed nulla viverra egestas nec quis nunc. Curabitur iaculis elit in orci sollicitudin suscipit.
+
+---
+
+And code snippets look great with Fira Code:
+
+```
+<article>
+ <header>
+ {{ if .Title }}
+ <h2 class="list-title"><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
+ {{ end }}
+ <p class="list-post-date">
+ <time datetime="{{ .Date.Format "2006-01-02T15:04:05Z07:00" | safeHTML }}">
+ {{ .PublishDate.Format "2 January, 2006 at 15:04 MST" }}
+ </time>
+ </p>
+ </header>
+ <div>
+ {{ .Summary | plainify | safeHTML }}
+ </div>
+ {{ if .Truncated }}
+ <p><a class="read-more" href="{{ .Permalink }}">Read more &rarr;</a></p>
+ {{ end }}
+</article>
+```
+
+[fira-sans]: https://bboxtype.com/typefaces/FiraSans/#!layout=specimen
+[charter]: https://practicaltypography.com/charter.html
+[fira-code]: https://github.com/tonsky/FiraCode \ No newline at end of file
diff --git a/exampleSite/content/post/introducing-indigo.md b/exampleSite/content/post/introducing-indigo.md
new file mode 100644
index 0000000..2f2a0d4
--- /dev/null
+++ b/exampleSite/content/post/introducing-indigo.md
@@ -0,0 +1,85 @@
+---
+title: "Introducing Indigo"
+date: 2018-10-01T09:00:00-04:00
+draft: false
+categories: ["meta"]
+tags: ["typography", "indieweb"]
+---
+
+Indigo is a lightweight theme for [Hugo][hugo] with [IndieWeb][indieweb] features baked in. It's great for longer-form blogging, placing its focus on distraction-free reading and beautiful typefaces.
+
+<!--more-->
+
+## IndieWeb features
+
+A key feature of this theme is its support for IndieWeb features, including microformats and web sign-in.
+
+### Web sign-in
+
+Indigo handles web sign-in by setting the `authorization_endpoint` to [IndieAuth.com][indieauth]:
+
+> IndieAuth.com is part of the [IndieWeb movement][why] to take back control of your online identity. Instead of logging in to websites as "you on Twitter" or "you on Facebook", **you should be able to log in as just "you"**.
+
+This allows you to sign in to certain services simply by providing your site's domain name.
+
+### microformats
+
+Indigo marks up content with appropriate [microformats][mf2], which provides semantic definitions of your content to other software. Posts are marked up with `h-entry` classes, like `p-name`, `p-author`, and `e-content`, while the author bio is marked up with `h-card` classes, including `u-photo`, `u-url`, `p-locality`/`p-country-name`, and `p-note`.
+
+## Open typefaces
+
+Indigo uses a combination of three beautiful typefaces to render your words.
+
+- [Fira Sans][fira-sans] for heading text
+- [Charter][charter] for body text
+- [Fira Code][fira-code] for monospaced text
+
+Licenses are included in the theme’s `static/fonts` folder.
+
+Have a look at a couple of paragraphs of placeholder text using the wonderfully readable Charter:
+
+---
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer eleifend nulla ac elit venenatis posuere. Sed id aliquam arcu, et malesuada lectus. **Donec et dignissim massa. Pellentesque in laoreet nibh. Pellentesque sagittis, libero quis vestibulum aliquam, ante risus imperdiet magna, at ornare dolor libero quis nunc.** Donec quis tempus purus. Cras ornare magna ac facilisis tristique. Nulla aliquet purus quis massa rutrum interdum ac at magna. Cras fermentum magna id orci viverra facilisis. Ut vitae lobortis nisl.
+
+Sed interdum tincidunt venenatis. Sed hendrerit dictum nisi, at dignissim orci consectetur quis. Aenean sed nisl et nisl placerat euismod. Proin hendrerit nulla at rhoncus molestie. Cras eu gravida erat, vestibulum ornare diam. _Praesent nunc arcu, ultrices et risus sed, dictum mattis dui. Maecenas vitae nisl at massa porta pellentesque_. Donec eget urna eget nisl imperdiet scelerisque eget a mauris. Nam fringilla sem id vehicula rhoncus. Curabitur tincidunt massa mauris, facilisis placerat odio eleifend sit amet. Etiam nec vehicula sapien, at dignissim risus. Sed elit erat, lacinia eu vulputate at, semper eu nulla. Quisque a urna sed nulla viverra egestas nec quis nunc. Curabitur iaculis elit in orci sollicitudin suscipit.
+
+---
+
+And code snippets look great with Fira Code:
+
+```
+<article>
+ <header>
+ {{ if .Title }}
+ <h2 class="list-title"><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
+ {{ end }}
+ <p class="list-post-date">
+ <time datetime="{{ .Date.Format "2006-01-02T15:04:05Z07:00" | safeHTML }}">
+ {{ .PublishDate.Format "2 January, 2006 at 15:04 MST" }}
+ </time>
+ </p>
+ </header>
+ <div>
+ {{ .Summary | plainify | safeHTML }}
+ </div>
+ {{ if .Truncated }}
+ <p><a class="read-more" href="{{ .Permalink }}">Read more &rarr;</a></p>
+ {{ end }}
+</article>
+```
+
+## Contributions welcome
+
+Indigo is distributed under the [MIT license][license], so feel free to fork the repository and make it your own! If you've got ideas on how to improve the theme, let me know by [opening an issue in GitHub](issue) — but please be sure to review the documentation on [contributing][contributing].
+
+[hugo]: https://gohugo.io
+[indieweb]: https://indieweb.org/
+[indieauth]: https://indieauth.com
+[why]: https://indieweb.org/why
+[mf2]: http://microformats.org
+[fira-sans]: https://bboxtype.com/typefaces/FiraSans/#!layout=specimen
+[charter]: https://practicaltypography.com/charter.html
+[fira-code]: https://github.com/tonsky/FiraCode
+[license]: https://github.com/AngeloStavrow/indigo/blob/master/LICENSE.md
+[issue]: https://github.com/AngeloStavrow/indigo/issues
+[contributing]: https://github.com/AngeloStavrow/indigo/blob/master/CONTRIBUTING.md \ No newline at end of file