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.

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

Using in static website generators #4

Open
ChrisJefferson opened this issue May 29, 2019 · 3 comments
Open

Using in static website generators #4

ChrisJefferson opened this issue May 29, 2019 · 3 comments
Labels
question Further information is requested

Comments

@ChrisJefferson
Copy link
Contributor

This isn't really a codebraid issue, but do you know if any static website generator (pelican? jekyll? Hugo?) easily supports codebraid?

If anyone knows of integration it would be nice to add to the readme, and I'll switch to any system which let's me easily use it :)

@gpoore
Copy link
Owner

gpoore commented May 31, 2019

I'm not aware of anyone using Codebraid with a static site generator, but it's only been a little over 3 months since the first release.

I'm planning to create a proper documentation site over the summer using MkDocs, so that will give me some experience using Codebraid with a static site generator. For that, I expect that the worst-case scenario is just that I will have something like a raw_docs directory in addition to a docs directory, and then will have to run codebraid on everything in raw_docs, with output saved to docs, before running the standard mkdocs build on docs.

@gpoore gpoore added the question Further information is requested label Feb 6, 2020
@dsoto
Copy link

dsoto commented May 2, 2020

I put together a repo with minimal working examples of Codebraid working with MkDocs like what is described above and rendering a couple of outputs of graphs and figures. Works well for my use case of creating content with graphs and calculations for students.

https://github.com/dsoto/codebraid-mkdocs-mwe

@gpoore
Copy link
Owner

gpoore commented May 2, 2020

@dsoto That's a nice example! Thanks for the link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants