Skip to content

Commit

Permalink
Updated docs on navigation tabs (squidfunk#1561)
Browse files Browse the repository at this point in the history
* Update docs on navigation tabs (as discussed in squidfunk#1560)

* Drop "less inconvenient" wording.
  • Loading branch information
iBug authored Apr 3, 2020
1 parent dff96cb commit 51f2dd1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,14 @@ Note that all *top-level pages* (i.e. all top-level entries that directly refer
to an `*.md` file) defined inside the `nav` entry of `mkdocs.yml` will be
grouped under the first tab which will receive the title of the first page.

If you want to maintain absolute control over the navigation bar, you can opt
in to group all top-level pages under one entry (so all top-level entries have
subentries now). This way you can have nested navigation items in conjunction
with tabs, as nesting works as expected from the second level on when tabs are
enabled. Keep in mind that mobile navigation isn't affected by tabs, however,
which means that your top-level entries correspond to top-level mobile
navigation items.

### Language

> Default: `en`
Expand Down

0 comments on commit 51f2dd1

Please sign in to comment.