Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
foo-dogsquared committed Sep 9, 2019
1 parent d933ad0 commit db1a6ea
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 37 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ https://en.wikibooks.org/wiki/LaTeX/Counters[LaTeX counters]) with the
* Add a compact list mode for the homepage post list with `params.enableCompactListMode`.
* Add a "Back to top" button on the footer with `params.enableBackToTopLink`.
* Add JSON+LD schema.
It is disabled by default so you have to manually switch the `params.enableJsonld` first.
It is disabled by default so you have to manually switch the `params.enableJsonLdSchema` first.
* Add a image zoom feature (using
https://github.com/francoischalifour/medium-zoom[medium-zoom library]) that can be
switched with `params.enableContentImageZoom`.
Expand Down Expand Up @@ -67,6 +67,8 @@ default MathJax version since MathJax v3 got the official production release.
One of the biggest change is the consideration of
https://zellwk.com/blog/why-vertical-rhythms/[vertical rhythms] and the absence of
the custom styles.
* Twitter cards and OpenGraph schema are now disabled by default and has to be
enabled with `params.enableTwitterCard` and `params.enableOpenGraphSchema` respectively.

=== Fixed
* Update the SCSS load order to make the automatic second theming work.
Expand Down
16 changes: 14 additions & 2 deletions MANUAL.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ the alternate theme even if you didn't customize it yourself!
* Custom 404 messages.
* Detailed or compact list for your posts on the homepage.
* Custom content reader mode for easier readability for your readers.
* JSON+LD schema.
* Twitter cards, OpenGraph schema, and JSON+LD schema.
* Image zoom feature for your content. footnote:requires_hugo_extended[]
* Built-in search indexing and widget with https://fusejs.io/[Fuse.js]. footnote:requires_hugo_extended[]
* Quick taxonomy search query list.
Expand Down Expand Up @@ -647,7 +647,7 @@ be listed at a time (with less information, if that's okay with you).
| Yes
|

| `params.enableJsonld`
| `params.enableJsonLdSchema`
| boolean
| Creates a https://www.w3.org/TR/json-ld/[JSON+LD] schema for additional SEO
capabilities.
Expand Down Expand Up @@ -679,13 +679,25 @@ Hallejulah!
| Yes (but not for me)
| For performance reasons, it'll be used through a CDN.

| `params.enableOpenGraphSchema`
| boolean
| Adds OpenGraph meta tags to the site for improved SEO.
| Yes
|

| `params.enableThemeToggle`
| boolean
| Enables theme toggling.
Puts an additional theme toggle button at the header logo.
| Yes (but no for others)
|

| `params.enableTwitterCard`
| boolean
| Adds the appropriate meta tags to be shareable for Twitter.
| Yes
|

| `params.feedLimit`
| boolean
| Specifies how many posts should be listed at a time in the
Expand Down
52 changes: 18 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ It's supposed to be minimal, after all.)

* Support RSS, Atom, and JSON feeds.
* Suitable for creating a quick single homepage portfolio and/or blogging.
* https://www.mathjax.org/[MathJax] support.
* Lazy syntax highlighting support with https://highlightjs.org/[highlight.js]
or https://prismjs.com/[PrismJS]. <sup>[[1](#footnoteref1)]</sup>
* [MathJax](https://www.mathjax.org/) support.
* Lazy syntax highlighting support with [highlight.js](https://highlightjs.org/)
or [PrismJS](https://prismjs.com/). <sup>[[1](#footnoteref1)]</sup>
* Multilingual mode support.
* Theme switch toggle (also known as dark mode).
* Customizable normal and alternate theme appearance. The theme will also set
Expand All @@ -58,7 +58,7 @@ the alternate theme even if you didn't customize it yourself!
* Custom content reader mode for easier readability for your readers.
* JSON+LD schema.
* Image zoom feature for your content. <sup>[[1](#footnoteref1)]</sup>
* Built-in search indexing and widget with https://fusejs.io/[Fuse.js]. <sup>[[1](#footnoteref1)]</sup>
* Built-in search indexing and widget with [Fuse.js](https://fusejs.io/). <sup>[[1](#footnoteref1)]</sup>
* Quick taxonomy search query list.
* Adding custom JS libraries for the whole site or for specific posts.
* Google Analytics integration.
Expand Down Expand Up @@ -451,53 +451,29 @@ canonifyURLs = true
# The tagline that'll appear in the homepage as the first header.
tagline = "Making near destructive blogs all around the world."

# Hide posts on home. :)
hidePostsOnHome = true

# Indicates if the site sections should be listed instead.
# Requires `hidePostsOnHome` to be disabled.
# listSiteSectionsOnHome = true

# Puts a pagination section on the posts linking to the previous and next posts.
# enableContentPagination = true

# Enables syntax highlighting. ;p
# enableLazySyntaxHighlighting = true

# Set the syntax highlighter to be used.
# Only valid options are "highlighterjs" or "prismjs".
# By default, it uses highlighter.js as the syntax highlighter if there's no set value.
# syntaxHighlighter = "prismjs"

# Indicates to show the icon whether the link leads to a page or a section.
# The effect is visible if `hidePostsOnHome` is at least disabled.
# showPageTypeIcon = true

# Shows breadcrumbs in the post.
# enableBreadcrumbs = true

# Places a theme toggle button at the header logo
# enableThemeToggle = true

# Enable MathJax support
# enableMathjax = true

# If you want to use MathJax v2
# setMathjaxToV2 = true

# 404
notFoundHeader = "404 Not Found :("
notFoundLinkMessage = "Now get back here."
notFoundMessage = "I see you're an explorer. I like that."

# Enable content counters similar to LaTeX counters
# useContentCounters = true
```

### Advanced configuration

Here's a sample of a more advanced configuration made for configuring this theme.
This includes RSS, Atom, and JSON feeds,
This includes RSS, Atom, and JSON feeds, SEO improvements, additional configurable
views for your homepage and content, MathJax support, lazy syntax highlighting,
and other tiny stuff.

Like the starter config, you can simply uncomment/comment certain things for
the features that you want to enable/disable.
Expand Down Expand Up @@ -562,6 +538,11 @@ canonifyURLs = true

# Hide posts on home. :)
# hidePostsOnHome = true

# SEO improvements
# enableTwitterCard = true
# enableOpenGraphSchema = true
# enableJsonLdSchema = true

# Indicates if the site sections should be listed instead.
# Requires `hidePostsOnHome` to be disabled.
Expand All @@ -573,6 +554,12 @@ canonifyURLs = true
# Enable content reader mode for decluttered interface for your visitors
# enableContentReaderMode = true

# Include image zoom feature similar to Medium articles
# enableContentImageZoom = true

# Enable compact list view for your post lists
# enableCompactListMode = true

# Enables syntax highlighting. ;p
# enableLazySyntaxHighlighting = true

Expand Down Expand Up @@ -604,9 +591,6 @@ canonifyURLs = true

# Enable content counters similar to LaTeX counters
# useContentCounters = true

# Include image zoom feature similar to Medium articles
# enableContentImageZoom = true
```


Expand Down

0 comments on commit db1a6ea

Please sign in to comment.