https://github.com/egoist/docute-plugins

List of Docute Plugins.
https://github.com/egoist/docute-plugins

Last synced: 17 days ago
JSON representation

List of Docute Plugins.

• Host: GitHub
• URL: https://github.com/egoist/docute-plugins
• Owner: egoist
• Created: 2018-09-29T09:05:26.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-12-25T14:31:29.000Z (almost 3 years ago)
• Last Synced: 2024-10-04T12:02:46.448Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://docute.org
• Size: 188 KB
• Stars: 20
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - egoist/docute-plugins - List of Docute Plugins. (others)

README

        
# Docute Plugins

## Official Docute Plugins

- [docute-mermaid](./packages/mermaid)

- [docute-google-analytics](./packages/google-analytics)

- [docute-katex](./packages/katex)

- [docute-run-code](./packages/run-code)

## Community Plugins

- PR to add here..

## Add an Official Plugin

1. Create a folder inside `./packages`

2. Create a `package.json` with following contents:

```json

{

  "name": "docute-foo",

  "version": "0.0.0",

  "scripts": {

    "build": "bili",

    "prepublishOnly": "yarn build"

  },

  "main": "dist/index.min.js",

  "files": [

    "dist"

  ],

  "license": "MIT",

  "devDependencies": {

    "bili": "^4.7.2"

  }

}

```

3. Create a `bili.config.ts` with following contents:

```ts

import {Config} from 'bili'

const config: Config = {

  output: {

    fileName: 'index[min].js',

    format: ['umd', 'umd-min'],

    moduleName: '{{ replace this with moduleName }}'

  }

}

export default config

```

4. Create `src/index.js`