Skip to content

fix : add patch for {docsify-ignore} and {docsify-ignore-all} #1351

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

Merged
merged 5 commits into from
Aug 22, 2020
Merged

fix : add patch for {docsify-ignore} and {docsify-ignore-all} #1351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8b7dbaa
revert: Convert {docsify-ignore} and {docsify-ignore-all} to HTML com…
sy-records Aug 22, 2020
193d941
fix: patch for docsify-ignore
sy-records Aug 22, 2020
3b8bbd2
fix test
sy-records Aug 22, 2020
175bb0b
fix test
sy-records Aug 22, 2020
204bfbb
Merge branch 'develop' into reset-1318
sy-records Aug 22, 2020
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
12 changes: 12 additions & 0 deletions src/core/render/compiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,12 +214,24 @@ export class Compiler {
nextToc.ignoreSubHeading = true;
}

if (/{docsify-ignore}/g.test(str)) {
str = str.replace('{docsify-ignore}', '');
nextToc.title = str;
nextToc.ignoreSubHeading = true;
}

if (/<!-- {docsify-ignore-all} -->/g.test(str)) {
str = str.replace('<!-- {docsify-ignore-all} -->', '');
nextToc.title = str;
nextToc.ignoreAllSubs = true;
}

if (/{docsify-ignore-all}/g.test(str)) {
str = str.replace('{docsify-ignore-all}', '');
nextToc.title = str;
nextToc.ignoreAllSubs = true;
}

const slug = slugify(config.id || str);
const url = router.toURL(router.getCurrentPath(), { id: slug });
nextToc.slug = url;
Expand Down
12 changes: 12 additions & 0 deletions src/core/render/compiler/headline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,24 @@ export const headingCompiler = ({ renderer, router, _self }) =>
nextToc.ignoreSubHeading = true;
}

if (/{docsify-ignore}/g.test(str)) {
str = str.replace('{docsify-ignore}', '');
nextToc.title = str;
nextToc.ignoreSubHeading = true;
}

if (/<!-- {docsify-ignore-all} -->/g.test(str)) {
str = str.replace('<!-- {docsify-ignore-all} -->', '');
nextToc.title = str;
nextToc.ignoreAllSubs = true;
}

if (/{docsify-ignore-all}/g.test(str)) {
str = str.replace('{docsify-ignore-all}', '');
nextToc.title = str;
nextToc.ignoreAllSubs = true;
}

const slug = slugify(config.id || str);
const url = router.toURL(router.getCurrentPath(), { id: slug });
nextToc.slug = url;
Expand Down
43 changes: 39 additions & 4 deletions test/unit/render.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,9 +254,7 @@ describe('render', function() {

it('ignore', async function() {
const { docsify } = await init();
const output = docsify.compiler.compile(
'## h2 tag <!-- {docsify-ignore} -->'
);
const output = docsify.compiler.compile('## h2 tag {docsify-ignore}');
expectSameDom(
output,
`
Expand All @@ -268,10 +266,26 @@ describe('render', function() {
);
});

it('ignore-html-comments', async function() {
const { docsify } = await init();
const output = docsify.compiler.compile(
'## h2 tag ignore <!-- {docsify-ignore} -->'
);
expectSameDom(
output,
`
<h2 id="h2-tag-ignore">
<a href="#/?id=h2-tag-ignore" data-id="h2-tag-ignore" class="anchor">
<span>h2 tag ignore </span>
</a>
</h2>`
);
});

it('ignore-all', async function() {
const { docsify } = await init();
const output = docsify.compiler.compile(
`# h1 tag <!-- {docsify-ignore-all} -->` + `\n## h2 tag`
`# h1 tag {docsify-ignore-all}` + `\n## h2 tag`
);
expectSameDom(
output,
Expand All @@ -288,6 +302,27 @@ describe('render', function() {
</h2>`
);
});

it('ignore-all-html-comments', async function() {
const { docsify } = await init();
const output = docsify.compiler.compile(
`# h1 tag ignore <!-- {docsify-ignore-all} -->` + `\n## h2 tag`
);
expectSameDom(
output,
`
<h1 id="h1-tag-ignore">
<a href="#/?id=h1-tag-ignore" data-id="h1-tag-ignore" class="anchor">
<span>h1 tag ignore </span>
</a>
</h1>
<h2 id="h2-tag">
<a href="#/?id=h2-tag" data-id="h2-tag" class="anchor">
<span>h2 tag</span>
</a>
</h2>`
);
});
});

describe('link', function() {
Expand Down