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.
feat: Vue components, mount options, global options, and v3 support #1409
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
feat: Vue components, mount options, global options, and v3 support #1409
Changes from 1 commit
35ad5c5
cd8f2d3
ecd053b
5fa79eb
a2386e5
bc2e091
1774ab8
6d152e2
758538c
0193659
8a56f72
5a2dde1
1a52e97
86dae61
2946c06
871e48f
131aae5
af7e713
25084f8
6a5e84b
febe7f8
b6d5407
8362ed0
f0a8d69
5ec2256
a9be6f2
3af1cfa
b33d750
cafdd62
d9e491a
a5a431f
4e5dae7
eae3ad8
421ef1d
52cce02
727ee8f
69efae3
51451a4
a10fcbd
9a1935a
43a73bb
7cf1e7c
7878c60
90b67e2
ffa7c90
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not clear on the last bullet point. I guess if it'll start to explain this magic part, it might just need to go into more detail.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I agree this description could use some work. To be honest, I debated about even adding it. I've updated the description to (hopefully) make it more clear. At the end of the day, this text exists to help explain why this edge case won't work:
Example 1: This will work
In this example, docsify first mounts the top-level
<p id="test">
fromvueMounts
. Docsify then iterates over the top-level child elements (<p>
), skips the ones that contain or are themselves Vue instances, detects Vue template syntax in the top-level<p>
element, and mounts it usingvueGlobalOptions
. Great.Example 2: This will not work
Like the previous example, docsify first mounts the top-level
<p id="test">
fromvueMounts
. Docsify then iterates over the top-level child elements (<div>
), detects that<div>
contains a Vue instance (<p id="test">
) and skips that element. This behavior is explained in the following "Technical Notes" bullet point:I think it is highly unlikely that this will be an issue, but I added the related technical notes in hopes of making life easier for everyone if it does. The trick is how to do this succinctly without going into the same level of detail above. Hopefully the changes I've put in place are good enough for now. We can always revisit if/when needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jhildenbiddle The example of what works vs what doesn't will be very helpful to some people. I think it'd be worth pasting what you wrote into the docs.