Skip to content

feat: GitHub style callouts #2487

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

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
Open

feat: GitHub style callouts #2487

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f9950e0
Add support for GitHub style callouts
jhildenbiddle Aug 8, 2024
f9a9869
Update docs and migrate to new syntax
jhildenbiddle Aug 8, 2024
db423b6
Update test snapshot
jhildenbiddle Aug 8, 2024
6cf5f36
Add tests for new callout syntax
jhildenbiddle Aug 8, 2024
72627ed
Merge branch 'develop' into github-callouts
Koooooo-7 Aug 15, 2024
ee73d59
Merge branch 'develop' into github-callouts
Koooooo-7 Aug 15, 2024
81c1dd0
Merge branch 'develop' into github-callouts
Koooooo-7 Aug 18, 2024
26240d3
update: sync the callout
Koooooo-7 Aug 18, 2024
3501b04
Merge branch 'develop' into github-callouts
Koooooo-7 Sep 10, 2024
64f5a92
Merge branch 'develop' into github-callouts
Koooooo-7 Sep 12, 2024
543e35d
Merge branch 'develop' into github-callouts
Koooooo-7 Sep 16, 2024
fea3b1b
Merge branch 'develop' into github-callouts
Koooooo-7 Sep 16, 2024
88e32ff
Merge branch 'develop' into github-callouts
Koooooo-7 Sep 21, 2024
9a27faa
Merge branch 'develop' into github-callouts
Koooooo-7 Sep 21, 2024
3607c8a
Merge branch 'develop' into github-callouts
Koooooo-7 Oct 12, 2024
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
Prev Previous commit
Next Next commit
Add tests for new callout syntax
  • Loading branch information
@jhildenbiddle @sy-records
jhildenbiddle authored and sy-records committed Aug 11, 2024
commit 6cf5f36943214a527f648937fb8db424d8ec51e1
46 changes: 43 additions & 3 deletions test/integration/render.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,60 @@ import { waitForText } from '../helpers/wait-for.js';
describe('render', function () {
// Helpers
// ---------------------------------------------------------------------------
describe('helpers', () => {
describe('callouts', () => {
beforeEach(async () => {
await docsifyInit();
});

test('important content', () => {
test('caution', () => {
const output = window.marked('> [!CAUTION]\n> Text');

expect(output).toMatchInlineSnapshot(
`"<div class="callout caution"><p>Text</p></div>"`,
);
});

test('important', () => {
const output = window.marked('> [!IMPORTANT]\n> Text');

expect(output).toMatchInlineSnapshot(
`"<div class="callout important"><p>Text</p></div>"`,
);
});

test('note', () => {
const output = window.marked('> [!NOTE]\n> Text');

expect(output).toMatchInlineSnapshot(
`"<div class="callout note"><p>Text</p></div>"`,
);
});

test('tip', () => {
const output = window.marked('> [!TIP]\n> Text');

expect(output).toMatchInlineSnapshot(
`"<div class="callout tip"><p>Text</p></div>"`,
);
});

test('warning', () => {
const output = window.marked('> [!WARNING]\n> Text');

expect(output).toMatchInlineSnapshot(
`"<div class="callout warning"><p>Text</p></div>"`,
);
});

test('important (legacy)', () => {
const output = window.marked('!> Important content');

expect(output).toMatchInlineSnapshot(
`"<p class="callout important">Important content</p>"`,
);
});

test('general tip', () => {
test('tip (legacy)', () => {
const output = window.marked('?> General tip');

expect(output).toMatchInlineSnapshot(
Expand Down
Loading