Improve docs embed files code fragment #2650
Conversation
|
@jacobsorme is attempting to deploy a commit to the Docsify Team on Vercel. A member of the Team first needs to authorize it. |
|
@trusktr Added example (kinda), do you think we need a full example for the |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
paulhibbitts
left a comment
paulhibbitts
left a comment
There was a problem hiding this comment.
Thanks for this PR @jacobsorme ! I've tested the PR build in codesandbox and it looks to work as described:
https://codesandbox.io/p/devbox/admiring-yonath-qgtfp5?workspaceId=ws_C7CBq2TzamwfU438Zxccyc
I think it would be clearer in the docs to display the file contents on the same page before the embedded fragment:
https://qgtfp5.csb.app/#/fragment-embed
What do you think?
|
Good idea I completely agree! Willfix |
New look! First the whole file, and then just below with the `:fragment=demo`
|
|
That looks good @jacobsorme , but do you know why an updated Preview is not available? |
|
Hmm, the Vercel bot preview? Not sure, but noticed in other PRs it seems to run only once. Maybe we can trigger it to run again here somehow? @vercel plz |
|
Thanks @jacobsorme! I wanted to confirm that the actual preview does match your screenshot? Otherwise this looks good! Once we see another preview, we should be ready for approval. |
|
Aight sure, makes sense. I'm pretty sure I've seen that emoji arrow in other places though, but that's for a separate discussion I guess - removing here! Wasn't completely sure how to best introduce the example to the reader either. Went for
Thought about this one also
|
|
@paulhibbitts Possible to trigger a re-Preview from here? https://github.com/docsifyjs/docsify/deployments/Preview |
|
How about something like this @jacobsorme? Just trying to fit it in a bit better with the overall style of the other items on the same page. I was able to build that test based on your docs too so that is a good sign 🙂 |
2 participants
Summary
Improve docs for embed files code fragment.
Related issue, if any:
#2626
What kind of change does this PR introduce?
For any code change,
Does this PR introduce a breaking change?
Tested in the following browsers: