https://github.com/jasonandjay/typedoc-plugin-bitcoinjs-runcase
This is a Typedoc plugin that allows you to load BitcoinJS in a web page and run code online.
https://github.com/jasonandjay/typedoc-plugin-bitcoinjs-runcase
Last synced: about 2 months ago
JSON representation
This is a Typedoc plugin that allows you to load BitcoinJS in a web page and run code online.
- Host: GitHub
- URL: https://github.com/jasonandjay/typedoc-plugin-bitcoinjs-runcase
- Owner: jasonandjay
- Created: 2023-11-02T05:43:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-13T11:08:13.000Z (about 1 year ago)
- Last Synced: 2025-03-10T04:49:21.236Z (2 months ago)
- Language: JavaScript
- Size: 120 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Typedoc BitcoinJS RunCase Plugin
This is a Typedoc plugin that allows you to load BitcoinJS in a web page and run code online.
### Usage
1. Install the plugin:
```bash
npm install typedoc-plugin-bitcoinjs-runcase --save-dev
```
2. Add the plugin to your Typedoc configuration:
```json
{
"plugins": ["typedoc-plugin-bitcoinjs-runcase"]
}
```
3. In your code comments, use @case tag to mark code blocks that should be runnable:
```typescript
/**
* This is an example of using BitcoinJS.
*
* @case
* ```typescript
* console.log('address:toBech32:::');
* console.log(address.toBech32('751e76e8199196d454941c45d1b3a323', 2, 'bc'))
* ```
*/
```
4. Plugin build result
5. You can edit your case and run it!