-
Notifications
You must be signed in to change notification settings - Fork 4
research how we can use embedded godbolt support for beman website #56
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
base: main
Are you sure you want to change the base?
research how we can use embedded godbolt support for beman website #56
Conversation
✅ Deploy Preview for bemanproject ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
18d739f to
36f9a6c
Compare
36f9a6c to
7f4f8d7
Compare
|
So @mguludag I think I see what you're trying to do here -- but I don't see that optional page in the preview site. Is that because it's not linked from anywhere? |
It's under Docs > Beman Libraries (experimental page copy of the Libraries page) > beman.optional: |
oh cool. That looks like a resonable start. Have a look at cppreference though to see what they're doing (recently I noted they starting using godbolt). For example: https://www.cppreference.com/w/cpp/utility/basic_stacktrace.html The nice thing about theirs is you don't get the godbolt terms of service in your face. The downside I can see here is that the 'link to edit on godbolt' is less clear. Side note -- I like how docusarus is generating a right side quick link for the .md. That's a good omen for when we start generating library docs. |
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.
LGTM for POC phase. Looks like a good lead.
I found an example for hugo that using Compiler Explorer API also nice idea to generate godbolt links from the code snippet in the md page. |
73b1187 to
1463012
Compare
be8d720 to
df2308f
Compare
|
Hi @JeffGarland I think this feature is finalized from my side and now we have flexible options for embedding godbolt links/generating godbolt links from the markdown codeblock. I also checked the markdown rendering on github and there is no problem (link generation only works for website). |
|
Ok, thanks for all the effort on this. I wonder what to do next -- put this into some sort of guidance? |
|
Yes, I need to update the README.md to how to embed the code or godbolt links in the pages. |
…te example codeblock configuration
b1faf3c to
72b3e8d
Compare
Issue: #55
PR to how to embed godbolt links into pages, the newly added page content, path may change.
Usage of Godbolt embedding:
then build process of website automatically creates godbolt link on top of code block like this: