Introduction
What is "example-code"?
example-code
is a set of modules and a system to help you easily add some helpful and impressive enhancements to the code blocks in your documentation sites and work in all the browsers.
Example:
(async () => {
const res = await fetch('https://api.ipify.org?format=json')
const { ip } = JSON.parse(await res.text())
alert(`Your IP: ${ip}`)
})()
The above code should execute in all environments, despite the es-next syntax. (Go ahead, try it in IE).
Polyfills must be loaded for this to work:
- babel-polyfill
- polyfills for whatever browser APIs you rely on, e.g. in this example I needed a polyfill for fetch
Packages
There are two main packages in this monorepo project:
- example-code-dom, the browser library for enhancing
<code>
elements - example-code-compile, optional, a node module for preprocessing your example code for execution in browsers
There are two packages that are adapters for example-code-compile
:
- remarkable-plugin-example-code, plugin for remarkable
- example-code-cli, command line interface note: I hesitate to even include this in documentation since it's largely incomplete