Skip to content

Commit

Permalink
Add readme for theme
Browse files Browse the repository at this point in the history
  • Loading branch information
sfoo-iohk committed Jan 2, 2024
1 parent 23cf1f2 commit e6121f5
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions theme/README.md
@@ -0,0 +1,17 @@
## Marlowe Typedoc Theme

Theme for typedoc is done through a plugin that expands upon the default theme and allows JSX hooks/overrides to modify DOM.

Configurations for running this can be found in the root `package.json` file where `npm run docs` will run typedoc with configurations found in `typedoc.json`.

Typedoc's [example demo theme](https://github.com/Gerrit0/typedoc-custom-theme-demo) shows how various hooks are called within `index.tsx`. This entrypoint also contains a sync script for processing files in `/assets`.

Elements that are replaced from the default theme can be found under `/templates`. Additional templates can be added for more granular control (See toolbar as an example).

To build the theme:

```
npm run build
```

This creates a `/dist` directory which is configured by `typedoc.json` as the plugin. Continue to build the docs `npm run docs` from the directory root, then preview any changes locally with `npm run serve`.

0 comments on commit e6121f5

Please sign in to comment.