qibogang / qibogang.github.io

The gang site :)
https://qibogang.github.io
0 stars 0 forks source link

Notebook Git storage #28

Open alecandido opened 1 year ago

alecandido commented 1 year ago

I'd like more not to store bloated barely-readable disguised JSONs in the repo, but something that is closer to the manually written code.

The main choices are:

  1. markdown with python code blocks
    • syntax highlighting for Python
    • no static analyzer, and possibly also other tools might not apply (like Black)
  2. python with markdown in comments
    • no syntax highlighting for markdown

An option is using JupyText or similar, at least for part of the work.

Moreover, I'd like this to transparently pass through Git, so:

So, we need to write the code to do it, and integrate as Git hooks.