deathbeds / pidgy

Interactive computing in Markdown
https://pidgy.rtfd.io
BSD 3-Clause "New" or "Revised" License
44 stars 7 forks source link
documentation ipython jupyter literate-computing literate-programming markdown notebook testing

pidgy literate computing interface

pidgy logo

pidgy is a fun, literate and interactive style of programming in markdown & python. together, these languages offer an exciting new experience to rapidly co-develop of code and narrative in Jupyter computational notebooks.

writing with pidgy

```bash pip install pidgy ```
install pidgy with `pip`
```ipython %reload_ext pidgy ```
1. πŸͺ open a jupyter notebook 2. πŸ”Œ activate the pidgy extension 3. ✏️ program in markdown
[πŸ’‘ try `pidgy` in jupyterlite without any installation][pidgy lite][^lite]

programming in markdown

markdown is inclusive AF![^a11y] it is a plain-text format that never fails [^violate]. further markdown can include any programming language within its contents. effectively, markdown files are literate programs that really on code and narrative to cooperate. markdown is a global minimum for teams of people with different language literacies.

a Tab separates markdown code and narrative, pidgy uses this nearness to create python representations of the markdown. with code and narrative so close, an author can fluidly switch between the writing modes capturing more of their process.

learn more

development

[^a11y]: there are techniques for improving accessibility of markdown and abiding best practices. [^violate]: markdown WILL violate expectation through implementation inconsistencies. over time we learn to navigate the nuances across products. [^lite]: jupyterlite is a new in-the-browser jupyter experience that requires zero installation.