-
Notifications
You must be signed in to change notification settings - Fork 291
docs: support tabs #576
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
Merged
Merged
docs: support tabs #576
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a0abe34
docs: support tabs
henryiii 8d56893
Get superfences working
joerick 2df65cf
Use an 'admonition' as a tab, add some styling
joerick e6d042e
docs: reorder tabs and modernize
henryiii 3cd3423
docs: tabbed options settings
henryiii 96ac7d1
docs: reorder to match order in other places
henryiii cb80d69
docs: correct the example
henryiii 8f3ef76
Apply suggestions from code review (lazy edits in GH :) )
joerick f0cf71e
Update mkdocs-include-markdown-plugin and remove unneeded include option
joerick File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,49 @@ | ||
|
||
// add classes for code-block-filename styling | ||
$('.rst-content pre') | ||
.prev('blockquote') | ||
.addClass('code-block-filename'); | ||
|
||
var i=0 | ||
|
||
// convert tab admonition to tabs | ||
while (true) { | ||
const firstTab = $('.rst-content .admonition.tab').first() | ||
if (firstTab.length == 0) break; | ||
|
||
const otherTabs = firstTab.nextUntil(':not(.admonition.tab)'); | ||
const allTabs = $($.merge($.merge([], firstTab), otherTabs)); | ||
|
||
const tabContainer = $('<div>').addClass('tabs'); | ||
const headerContainer = $('<div>').addClass('tabs-header'); | ||
const contentContainer = $('<div>').addClass('tabs-content'); | ||
console.log(allTabs) | ||
joerick marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
tabContainer.insertBefore(firstTab); | ||
tabContainer.append(headerContainer, contentContainer) | ||
|
||
const selectTab = function (index) { | ||
headerContainer.children().removeClass('active') | ||
headerContainer.children().eq(index).addClass('active') | ||
contentContainer.children().hide() | ||
contentContainer.children().eq(index).show() | ||
} | ||
|
||
allTabs.each(function (i, el) { | ||
const $el = $(el) | ||
const titleElement = $el.children('.admonition-title') | ||
const title = titleElement.text() | ||
const button = $('<button>').text(title) | ||
button.click(function () { | ||
selectTab(i) | ||
}) | ||
joerick marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
headerContainer.append(button) | ||
|
||
titleElement.remove() | ||
$el.removeClass('admonition') | ||
contentContainer.append($el) | ||
}) | ||
|
||
selectTab(0) | ||
|
||
if (i++ > 1000) throw 'too many iterations' | ||
joerick marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.