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
VS Code doc hosting integration #10
Comments
Yes, this is definitely part of the goals for the package, so I think it should be possible to make it work. A JSON+MD output would be a viable option I think. There's the need to process and "expand" the |
Cool, that sounds very promising! Do you think we could start with a simple copy-version, even if it doesn't resolve Do you think you could maybe start with that functionality? I think if you could just start with a very rough JSON write and file copy story, that would give me probably enough starting points that I could then down the road improve and refine things. But right now I wouldn't know where to start, really :) |
I think if we can spec what's needed in the toc.json file then the rest should be relatively straight forward to cook up in a basic form. My understanding is that we would want the nested structure of the output markdown pages included in the project as well as page metadata such as title. There's also some project level metadata we can include as well that comes from the Project.toml [publish] section such as keywords, authors, etc. Another thing to consider is what markdown parser will be used on vscode side for viewing, the default one I assume? Would be good to know what subset of CommonMark.jl it actually supports. |
Yeah, exactly! I think for the JSON, we literally could start with just the TOC hierarchy, something like this:
Essentially just one element per node in the tree, and then for each node a For the rendering we're going to use |
@MichaelHatherly Bump, just wondering whether you might have some cycles to push this forward? I think if we were to move just to the next step here on the generation side, I might be able to implement enough of it on the VS Code side of things that we could showcase this as one of the new features in the VS Code extension at this year's Juliacon, which would be neat. But I think I would need some help on this side of things :) |
Yeah, I'll see if I can hack something together today, it's unlikely to be very pretty for now, and will likely need heavy refactoring at a later stage, but this has been waiting for quite a while now 🤣 |
Tada, this is very cool! I left some specific comments on the PR, but have one generic question: how difficult do you think it would be to generate this output (i.e. |
I've been thinking a fair bit about a more comprehensive documentation viewer inside VS Code, and I think Publish.jl seems to be the ideal starting point for that.
For the design I have in mind, how difficult would it be to add another output option to Publish.jl (maybe named "vscode") that does the following:
My guess is that this might be fairly straightforward?
If Publish.jl supported that, here is how I would take it from there:
The text was updated successfully, but these errors were encountered: