research how we can use embedded godbolt support for beman website

[mguludag]

Issue: #55

PR to how to embed godbolt links into pages, the newly added page content, path may change.

Usage of Godbolt embedding:

```cpp { "compilers": ["compiler compiler_flags",...], "libs": ["lib@version",...], "filters": {"execute":true} }
// some cpp code

then build process of website automatically creates godbolt link on top of code block like this:

[netlify]

✅ Deploy Preview for bemanproject ready!

Name	Link
🔨 Latest commit	254be68
🔍 Latest deploy log	https://app.netlify.com/projects/bemanproject/deploys/6962e65d9c3f230008fd0f46
😎 Deploy Preview	https://deploy-preview-56--bemanproject.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[JeffGarland]

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?

[mguludag]

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:
https://deploy-preview-56--bemanproject.netlify.app/docs/libs/beman.optional/

[JeffGarland]

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: https://deploy-preview-56--bemanproject.netlify.app/docs/libs/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.

[neatudarius]

LGTM for POC phase. Looks like a good lead.

[mguludag]

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: https://deploy-preview-56--bemanproject.netlify.app/docs/libs/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.

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.

[mguludag]

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).

[JeffGarland]

Ok, thanks for all the effort on this. I wonder what to do next -- put this into some sort of guidance?

[mguludag]

Yes, I need to update the README.md to how to embed the code or godbolt links in the pages.

[JeffGarland]

With the release of optional 1.0 we have a candidate to actually deploy to the site now. We should do that under a different PR, but do we need some of the elements in this PR for the site building aspect?

bemanproject/optional#120

Also is there an easy way to regen the preview? The link for netfly seems dead now.

[JeffGarland]

Thanks @neatudarius the netfly is live again. Just for posterity here's what the prototype looks like. @tzlaine @steve-downey you maybe interested in this. Note that optional now has a dedicated docs directory, which isn't what was used here -- it was just the top level markdown. The menu on the right hand side is a live link to the sections.

I'd also note that I still think we need to change the exemplar readme outline (although I think it has evolved since optional started). The top thing should be the Examples -- the license can go to the end. Also for the website, once we have more docs in the system I think that should be at the top instead of the bottom -- because people coming will be interested in libraries first and foremost. At first I was thinking we'd only put production-ready stuff on the site, but maybe we could separate into two blocks -- production ready and preliminary.

Note that the intent here is that libraries still have their own github pages rendering outside of the main site.