Repository navigation
Convert {docsify-ignore} and {docsify-ignore-all} to HTML comments - #1318
sy-records merged 3 commits into
Conversation
Sorry, something went wrong.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/n5ph96a7z |
Sorry, something went wrong.
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 936cab3:
|
Sorry, something went wrong.
sy-records
left a comment
There was a problem hiding this comment.
LGTM.
Should we be compatible with previous versions? @anikethsaha
Sorry, something went wrong.
If we want to solve #767 whit this PR, i think should not be compatible. |
Sorry, something went wrong.
|
I think it should be backward compatibility. we'd better keep current congratulation and allowed the new one. |
Sorry, something went wrong.
This is how dependencies work. If you don't specify a version you will get the last version, including any major releases that always include breaking changes. Users should know how how to use it. Who is using @4 will not get this fix since i think it will be shipped with v5 (?). Who is using docsify without a specified version will automatically get the v5 with their relative breaking changes, including this one (personally, i think this is not a good usage) Assuming this fix will shipped with v5: //cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js = No fix |
Sorry, something went wrong.
Koooooo-7
left a comment
There was a problem hiding this comment.
This is how dependencies work. If you don't specify a version you will get the last version, including any major releases that always include breaking changes. Users should know how how to use it.
Who is using @3 will not get this fix since i think it will be shipped with v4 (?). Who is using docsify without a specified version will automatically get the v4 with their relative breaking changes, including this one (personally, i think this is not a good usage)
make sense, LGTM.
Sorry, something went wrong.
anikethsaha
left a comment
There was a problem hiding this comment.
Thanks for the PR.
Can we have some test for this change ?
Sorry, something went wrong.
|
Done |
Sorry, something went wrong.
sy-records
left a comment
There was a problem hiding this comment.
cool 👍🏻
Sorry, something went wrong.
Ref and close #441
This should also close #767
Summary
This PR prevents {docsify-ignore} and {docsify-ignore-all} to be rendered inside other markdown engines like on Github.
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Tests
$ mocha ./test/**/*.test.js router/history/base ✓ toURL without relative path relativePath true ✓ toURL ✓ toURL with double dot ✓ toURL child path ✓ toURL absolute path Docsify public API ✓ global APIs are available (183ms) Docsify config function ✓ allows $docsify to be a function (201ms) ✓ provides the hooks and vm API to plugins render ✓ important content (tips) lists ✓ as unordered task list ✓ as ordered task list ✓ normal unordered ✓ unordered with custom start ✓ nested image ✓ regular ✓ class ✓ id ✓ no-zoom size ✓ width and height ✓ width heading ✓ h1 ✓ h2 ✓ h3 ✓ h4 ✓ h5 ✓ h6 link ✓ regular ✓ linkrel ✓ disabled ✓ target ✓ class ✓ id router/util ✓ resolvePath ✓ resolvePath with dot ✓ resolvePath with two dots 35 passing (1s)