Run the Docs

Installation

$ npm install --save run-the-docs

props

| name | default | values | description | | :--------: | :-----: | :------: | :---------: | | packages | [] | Array: package names currently avalable in Pyodide | Uses Pyodide's loadPackage() to preload packages | | console | true | Boolean: true or false | false disables the HTML console which displays the results. | | edit | true | Boolean: true or false | false disables the textarea input while still allowing the embedded code to be run. | | scope | false | Boolean: true or false | true creates a new Repl() for the component with its own Python context. false shares the Repl() context between editors globally, i.e. one editor can reference variables from another. | | onResult | undefined | Function: function expression or reference | callback function that receives the results when the code is run. (res, err) => { ... } | | code | undefined | String or template literal | placeholder code that populates the editor component on initialization. |

Contributing/Requests

Open an issue or post a message in the chatroom. If you would like to contribute to the project (code, documentation, tutorials, etc.) see the contributing guide for how to get started 🙌

License

Run the Docs uses the Mozilla Public License Version 2.0.