Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare new release #309

Merged
merged 5 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
source "https://rubygems.org"

gem "elixir-toolkit-theme-plugins", "~> 0.1.10"
gem "webrick", "~> 1.8.2"
gem "webrick", "~> 1.9.1"
gem "jekyll", "~> 4.3.2"
gem "jemoji", "~> 0.13.0"
gem "kramdown-parser-gfm", "~> 1.1"
Expand Down
4 changes: 2 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ GEM
concurrent-ruby (~> 1.0)
unicode-display_width (2.6.0)
uri (1.0.2)
webrick (1.8.2)
webrick (1.9.1)

PLATFORMS
x86_64-linux
Expand All @@ -146,7 +146,7 @@ DEPENDENCIES
jekyll-sitemap (~> 1.4)
jemoji (~> 0.13.0)
kramdown-parser-gfm (~> 1.1)
webrick (~> 1.8.2)
webrick (~> 1.9.1)

BUNDLED WITH
2.2.33
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ remote_theme: ELIXIR-Belgium/elixir-toolkit-theme
You can lock it onto a specific version using:

```yaml
remote_theme: ELIXIR-Belgium/elixir-toolkit-theme@3.2.0
remote_theme: ELIXIR-Belgium/elixir-toolkit-theme@4.0.0
```

### Using Ruby Gems (alternative)
Expand All @@ -50,7 +50,7 @@ gem "elixir-toolkit-theme"
You can lock it onto a specific version like this:

```ruby
gem "elixir-toolkit-theme", "~> 3.2.0"
gem "elixir-toolkit-theme", "~> 4.0.0"
```

And add this line to your Jekyll site's `_config.yml`:
Expand Down
2 changes: 1 addition & 1 deletion _data/sidebars/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ subitems:
url: /all_trainings
- title: List of page IDs
url: /list_page_ids
- title: 404 page not found
- title: Example 404 page"
url: /404
hr: true

4 changes: 2 additions & 2 deletions elixir-toolkit-theme.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Gem::Specification.new do |spec|
spec.name = "elixir-toolkit-theme"

spec.version = "3.2.0"
spec.version = "4.0.0"
spec.authors = ["bedroesb"]
spec.email = ["[email protected]\n"]

Expand All @@ -13,7 +13,7 @@ Gem::Specification.new do |spec|

spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r!^(assets|_layouts|_includes|_sass|LICENSE|README|_data/countries.yml)!i) }

spec.add_runtime_dependency "jekyll", "~> 4.3.2"
spec.add_runtime_dependency "jekyll", ">= 4.1.0"
spec.add_runtime_dependency "elixir-toolkit-theme-plugins", ">= 0.1.9"

spec.add_development_dependency "bundler", ">= 2.2.16"
Expand Down
10 changes: 10 additions & 0 deletions pages/documentation/navigation_structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,16 @@ Column attributes:
* `url_text`: Title of a link.
* `url`: Absolute path of a page.

## Table of Contents (TOC)

### Configuration


Currently, 2 settings can be configured related to the TOC, `min_headings` and `headings`. Read more on how to configure them and what they do in the [Configuring theme page](configuring_theme).

### Usage

By default, toc is enabled and will appear once the minimum amount of headings is reached, of the correct type. Disable on site-level (using Jekyll defaults) or on page level, by adding the `toc: false` when you don't wan't the TOC to appear, or when there will never be a heading.


{% include callout.html type="tip" content="To prevent the main content from resizing, when no TOC is present, it is suggested to add `toc: false` to improve the loading of the page." %}