Skip to content

Commit

Permalink
Prep 0.10.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mattxwang committed Sep 9, 2024
1 parent 8292f46 commit 3e6e3ab
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 7 deletions.
32 changes: 31 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,41 @@ This website is built from the `HEAD` of the `main` branch of the theme reposito

Code changes to `main` that are *not* in the latest release:

- N/A

Docs changes made since the latest release:

- N/A

## Release v0.10.0

Hi folks! This minor release adds one of our most-requested features: unlimited multi-level navigation (also known as recursive navigation). Huge thanks to [@pdmosses] for his wonderful work in implementing this feature!

This release should be a straightforward upgrade for all users of Just the Docs. Thank you for your continued support!

### Using Release `v0.10.0`

Users who have not pinned the theme version will be **automatically upgraded to `v0.9.0` the next time they build their site**.

To use this release explicitly as a remote theme:

```yml
remote_theme: just-the-docs/[email protected]
```
To use this version explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install` or `bundle update just-the-docs`:

```ruby
gem "just-the-docs", "0.10.0"
```

To use and pin a previous version of the theme, replace the `0.10.0` with the desired release tag.

### New Features

- Added: Allow unlimited multi-level navigation by [@pdmosses] in [#1431]

Docs changes made since the latest release:
### Documentation

- Added: Allow unlimited multi-level navigation by [@pdmosses] in [#1440]
- Added: sitemap (via `jekyll-sitemap` plugin) by [@mattxwang] in [#1530]
Expand Down
12 changes: 12 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ This document contains instructions on how to migrate and upgrade Just the Docs
[CHANGELOG]: {% link CHANGELOG.md %}

## v0.9.x - v0.10.0

There are no potentially-breaking changes in v0.10.0.

## v0.8.x - v0.9.0

There are no potentially-breaking changes in v0.9.0.

## v0.7.x - v0.8.0

There are no potentially-breaking changes in v0.8.0.

## v0.6.x - v0.7.0

### POTENTIALLY-BREAKING CHANGES in v0.7.0
Expand Down
10 changes: 5 additions & 5 deletions docs/navigation/main/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ nav_order: 1

# Main Navigation

The main navigation for your Just the Docs site is at the left side of the page on large screens, and at the top (behind a tap) on small screens.
The main navigation for your Just the Docs site is at the left side of the page on large screens, and at the top (behind a tap) on small screens.

You need to specify the `title` of each page in its front matter. Page titles are independent of file names and directory structure. The navigation uses the title of the page as an anchor for links to the page.

By default, links to all pages appear in the main navigation at the top level, ordered alphabetically by their titles. By adding further fields to the front matter of individual pages, you can [change their order]({% link docs/navigation/main/order.md %}), [exclude pages]({% link docs/navigation/main/exclude.md %}), and change their [parent pages]({% link docs/navigation/main/levels.md %}).

{: .new-title }
> New (Multi-level)
> New (v0.10.0)
>
> The main navigation can be structured as a multi-level menu of unlimited depth:
> pages can always have child pages.
Expand All @@ -25,16 +25,16 @@ For the construction of the navigation display to work (and to avoid potential c
* The title of each page must be different from the titles of all its child pages, and from the titles of their child pages, etc.

{: .new-title }
> New (Multi-level)
> New (v0.10.0)
>
> If *all* the pages of your site have different titles, you need only to specify the `title` of each page, and the `parent` title of each lower-level page.[^1]
[^1]: Previous versions of Just the Docs restricted the navigation to three levels. You also needed to specify `has_children: true` on all parent pages, and a `grand_parent` title on all grandchild pages. The `has_children` parameter is now redundant, and the `grand_parent` parameter can usually be omitted.

If your site has pages with the same title, you need to avoid confusion when you reference that title as `parent` on other pages. When the pages with the same title have different `parent` pages, you can distinguish between them using the `grand_parent` parameter.
If your site has pages with the same title, you need to avoid confusion when you reference that title as `parent` on other pages. When the pages with the same title have different `parent` pages, you can distinguish between them using the `grand_parent` parameter.

{: .new-title }
> New (Multi-level)
> New (v0.10.0)
>
> For deeper navigation structures, you can specify the title of a grandparent or higher level page as an `ancestor` title.
Expand Down
2 changes: 1 addition & 1 deletion docs/navigation/main/levels.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ nav_order: 2
The Buttons page appears as a child of UI Components and appears second in the UI Components pages.

{: .new-title }
> New (Multi-level)
> New (v0.10.0)
>
> The `has_children` field is now redundant (and ignored, except when significant for backwards compatibility).
Expand Down

0 comments on commit 3e6e3ab

Please sign in to comment.