flask-round-potionBeta

Tags

Tags are reusable labels you can add to pages and update blocks — this page tells you how to create, add and manage tags

You can use tags to group related content, convey release states, mark outdated content, or in any other way that helps your readers scan your documentation.

circle-info

Note: Tags are currently in beta as we consider adding more features — including search functionality and color support. If there are specific features you want to see for tags, please let us know in our GitHub communityarrow-up-right!

Tag a page

Open the page, then open Page options — accessible by hovering over the page title — and add one or more tags. You can drag tags around to change the order in which they appear on the page.

Show or hide tags on a page

By default, tags will be displayed at the top of the page. To hide a page’s tags while keeping the associated metadata:

  • Open Page options

  • Turn off Show tags on page to keep tags as metadata only

Display a tag in the table of contents

For each page, you can pick one tag to display in the table of contentsarrow-up-right — as you can see with this page. To choose which tag displays:

  • Open Page options

  • Under Tags, use the Display in table of contents dropdown to choose your tag.

Tag an update block

Each individual update block can also have its own tags.

To add a tag to an update block, navigate to the update and click Add tag below the date. You can then use the tag picker to add, remove, or reorder tags.

Manage tags in the Library

To view, create and manage tags for your space, open the Library from the table of contents and choose Tags.

Each tag has:

  • A label — what readers see

  • A slug — a stable identifier

  • An optional icon or emoji

Tags in Markdown

If you use Git Sync, tags appear in the page frontmatter.

Use a string for a standard tag.

Use primary: true on one tag to make it the page’s primary tag. GitBook can show that tag in the table of contents.

GitBook keeps the tag order from the list.

Last updated

Was this helpful?