Skip to content
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

Jump to bottom

Add Swift Documentation Preview Support #562

Open
Kyle-Ye opened this issue Jul 2, 2023 · 10 comments
Open

Add Swift Documentation Preview Support #562

Kyle-Ye opened this issue Jul 2, 2023 · 10 comments
Assignees
@matthewbastien
Labels
enhancement New feature or request

Comments

@Kyle-Ye
Copy link

Kyle-Ye commented Jul 2, 2023

Is your feature request related to a problem? Please describe.

When user actives documentation preview panel and is currently on a .swift, .h or .markdown file, preview the documentation on the right panel.

Describe the solution you'd like

It can be achieved by using the existing ConvertService API provided by DocC.

No Xcode magic is required.

https://twitter.com/franklinschrans/status/1666343700442628098

Benefits

Improve the doc-writing experience on non-Xcode IDE.

Additional context

Inspiration: Xcode 15's documentation preview feature

See more info https://developer.apple.com/videos/play/wwdc2023/10244/
@Kyle-Ye Kyle-Ye added the enhancement New feature or request label Jul 2, 2023
@Kyle-Ye Kyle-Ye changed the title Add DocC Preview Support Add Swift Documentation Preview Support Jul 2, 2023
@adam-fowler
Copy link
Contributor

You can use the command Markdown: Open preview to the side to give a markdown preview. This won't give you the full docc preview obviously but it is a start.

@Kyle-Ye
Copy link
Author

Kyle-Ye commented Aug 3, 2023 •
edited
Loading

You can use the command Markdown: Open preview to the side to give a markdown preview. This won't give you the full docc preview obviously but it is a start.

Yeah. VSCode has a build-in Markdown preview panel.

But I'd like to know if it was possible to render a HTML directly in a associated-panel(The same as Markdown file and Markdown-Preview panel) via the VSCode plugin SDK.

@adam-fowler
Copy link
Contributor

You can do it. But managing the preview server, associating the current page with the correct page on the server isn't simple. It is all possible, just complex.

I have looked into to it a bit and got it displaying a page served by preview server I was running separately. But it is far away from a finished feature.

@roydbt
Copy link

roydbt commented Apr 1, 2024

Any updates on this issue?

@adam-fowler
Copy link
Contributor

No update on this. I haven't had anymore time to look into it.

@daveyc123
Copy link

@adam-fowler Can we grab this one? If so, do you have your prototype changes in a fork somewhere?

@adam-fowler
Copy link
Contributor

@daveyc123 its all yours. I had some basic code setup to display the documentation but there was a loads of issues managing the preview server and updating the documentation. Don't think I kept any of the code around though.

@adam-fowler
Copy link
Contributor

@daveyc123 I found this https://github.com/adam-fowler/vscode-swift/tree/documentation-preview

@daveyc123
Copy link

Thanks for digging that up @adam-fowler

@award999 award999 moved this from Backlog to Todo in Visual Code Swift Extension Jun 12, 2024
@award999 award999 moved this from Todo to Backlog in Visual Code Swift Extension Jun 12, 2024
@award999 award999 moved this from Backlog to Todo in Visual Code Swift Extension Jun 14, 2024
@award999 award999 moved this from Todo to In Progress in Visual Code Swift Extension Jun 19, 2024
@matthewbastien
Copy link
Member

I just posted a general overview of how this feature could be implemented on the Swift forums: https://forums.swift.org/t/rfc-swift-docc-integration/75537

Please check it out and leave any feedback/suggestions that you might have!

This was referenced Nov 7, 2024
Merged
Merged
matthewbastien added a commit to swiftlang/swift-package-manager that referenced this issue Nov 8, 2024
@matthewbastien
Expose all target files to SourceKit-LSP (#8107)
42aaad6 
Add `resources`, `ignored`, and `other` files to `BuildTarget` for use
by SourceKit-LSP.

This is tracked by rdar://139431738 as part of
swiftlang/vscode-swift#562

### Motivation:

SourceKit-LSP needs to be able to determine which target contains a
given DocC catalog in order to fulfill documentation related requests.
However, the catalog is not listed as one of the `sources` or `headers`.
Rather, it is part of `other` files in most cases. Expose all file types
to SourceKit-LSP so that it can properly determine which target a given
file belongs to.

### Modifications:

Added three new properties to `BuildTarget`: `resources`, `ignored`, and
`other` which are arrays of `URL` pointing to the given file types in
the target.

### Result:

SourceKit-LSP will be able to see all files contained within a given
target.
This was referenced Nov 12, 2024
Closed
Merged
Draft
This was referenced Nov 22, 2024
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewbastien matthewbastien

Labels
enhancement New feature or request
Projects
Swift Extension for Visual Studio Code
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
5 participants
@daveyc123 @adam-fowler @roydbt @Kyle-Ye @matthewbastien