search

ministryofjustice / mkdocs-tech-docs-template

Build flexible technical documentation with a GOV.UK style using MkDocs
https://ministryofjustice.github.io/mkdocs-tech-docs-template/
8 stars 4 forks source link

Consider integrating `termynal` #44

Closed adam-moss closed 1 year ago

adam-moss commented 1 year ago

tech-docs quite often have code snippets embedded. It can be useful to render this as an animated terminal.

termynal is a nice lightweight component that can provide this whilst failing gracefully for anyone with javascript disabled.

An example of it embedded within material-for-mkdocs is viewable throughout the typer-cli docs.

SoumayaMauthoorMOJ commented 1 year ago

Hey @adam-moss thanks for raising this. Could you clarify the ask?

adam-moss commented 1 year ago

To provide an interactive representation of the REPL on the terminal, repo rather than just static content, if js is enabled.

adam-moss commented 1 year ago

Actually there is a relatively new mkdocs plugin that can do this https://github.com/daxartio/termynal

SoumayaMauthoorMOJ commented 1 year ago

Cool in that case I'll close the ticket. Feel free to raise an idea https://github.com/ministryofjustice/mkdocs-tech-docs-template/discussions/categories/ideas as a suggestion for mkdocs plugins that can be helpful :-)

SoumayaMauthoorMOJ commented 1 year ago

I've reponed the issue and converted to discussion :-)