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.

Sign up for GitHub

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

Jump to bottom

CHANGELOG: add breaking change (tabbed panes, text display) #1298

Merged
merged 1 commit into from
Oct 29, 2022
Merged

CHANGELOG: add breaking change (tabbed panes, text display) #1298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ notes][0.5.1]. **BREAKING CHANGES** are documented below.

**Breaking changes**:

- **Tabbed panes, text display**. By default, the content of a tab inside a tabbed
pane is shown as code. As of version 0.4 of the shortcode, you can add the
parameter `code=false` to your `tabpane` or `tab` shortcode in order to render
tab content(s) as text (markdown or html). As of version 0.5 the name of this
parameter was changed, we now use `text=true` in order to mark content as text.
- **Display logo by default**. Most projects show their logo in the navbar. In
support of this majority, Docsy now displays a logo by default. For details on
how to hide the logo (or your brand name), see [Styling your project logo and
Expand Down