pipalacademy / mkdocs-feather

Mkdocs plugin to enable live code examples in the documentation using feather
https://pipalacademy.github.io/mkdocs-feather/
MIT License
1 stars 0 forks source link

Add support for code examples #1

Open anandology opened 2 years ago

anandology commented 2 years ago

It should support including code examples using the following syntax.

```{.feather .python}
print("hello, world!")
```

The following things need to be added to the mkdocs.yml to enable this plugin.

plugins:
  - mkdocs-feather:
        server_url: https://feather.pipal.in/

Tasks

anandology commented 2 years ago

We may want to support extended configuration. for example:

When there are multiple servers for each runtime:

plugins:
  - mkdocs-feather:
        server_url: 
            default: https://feather.pipal.in/
            python: https://python-feather.pipal.in/
            go: https://go-feather.pipal.in/
        modes:
            c-joy: 
                runtime: cjoy
                syntax: c

This need not be part of this issue, but leaving as note so that it is tracked.

anandology commented 2 years ago

Done. currently supported config:

site_name: Python Tutorial

plugins:
  - feather:
      modes:
        - python
        - ruby
        - htmlmixed
      server_url: http://127.0.0.1:5000/
theme:
  name: material