search

gpoore / codebraid

Live code in Pandoc Markdown
BSD 3-Clause "New" or "Revised" License
376 stars 13 forks source link

Using in static website generators #4

Open ChrisJefferson opened 5 years ago

ChrisJefferson commented 5 years ago

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 commented 5 years ago

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.

dsoto commented 4 years ago

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 commented 4 years ago

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