docusaurus/packages/docusaurus-theme-live-codeblock
Joshua Chen 68aaf9201f
feat(core): allow plugin lifecycles to return relative paths (#6921)
* feat(core): resolve plugin lifecycles returning relative paths

* fix typo

* fix tests

* revert

* rename path -> entryPath
2022-03-16 20:47:15 +08:00
..
src feat(core): allow plugin lifecycles to return relative paths (#6921) 2022-03-16 20:47:15 +08:00
.npmignore misc: convert all internal scripts to ESM (#6286) 2022-01-08 12:59:28 +08:00
copyUntypedFiles.mjs misc: convert all internal scripts to ESM (#6286) 2022-01-08 12:59:28 +08:00
package.json chore: prepare v2.0.0-beta.17 release (#6829) 2022-03-03 18:44:41 +01:00
README.md docs(v2): Add READMEs to v2 packages (#4034) 2021-01-14 17:16:26 +01:00
tsconfig.client.json refactor(live-codeblock): migrate theme to TS (#6583) 2022-02-02 17:48:06 +08:00
tsconfig.json refactor(live-codeblock): migrate package to TS (#5851) 2021-11-02 12:28:41 +08:00
tsconfig.server.json refactor(live-codeblock): migrate theme to TS (#6583) 2022-02-02 17:48:06 +08:00

Docusaurus Live Codeblock

You can create live code editors with a code block live meta string.

Install

npm i @docusaurus/theme-live-codeblock # or yarn add @docusaurus/theme-live-codeblock

Modify your docusaurus.config.js

module.exports = {
  ...
+ themes: ['@docusaurus/theme-live-codeblock'],
  presets: ['@docusaurus/preset-classic']
  ...
}

Example:

```jsx live
function Clock(props) {
  const [date, setDate] = useState(new Date());
  useEffect(() => {
    var timerID = setInterval(() => tick(), 1000);

    return function cleanup() {
      clearInterval(timerID);
    };
  });

  function tick() {
    setDate(new Date());
  }

  return (
    <div>
      <h2>It is {date.toLocaleTimeString()}.</h2>
    </div>
  );
}
```