# docsify-edit-link

> A docsify plugin to add an `Edit that page` link

Latest version **1.0.1** (published 2019-04-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install docsify-edit-link
pnpm add docsify-edit-link
yarn add docsify-edit-link
bun add docsify-edit-link
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-04-06 |
| First published | 2019-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | cyrilf |
| Maintainers | cyrilf |
| Keywords | docsify, plugin, edit |

## Links

- npm: https://www.npmjs.com/package/docsify-edit-link
- Repository: https://github.com/cyrilf/docsify-edit-link
- Homepage: https://github.com/cyrilf/docsify-edit-link#readme
- Issues: https://github.com/cyrilf/docsify-edit-link/issues
- npm.io page: https://npm.io/package/docsify-edit-link

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.0.1 (latest) — 2019-04-06
- 1.0.0 — 2019-04-06

## README

# docsify-edit-link

A [docsify](https://github.com/docsifyjs/docsify) plugin to add an `Edit that page` link at the top of every pages. Clicking this link will automatically open the correponding page on Github/Gitlab/Bitbucket.

## Usage

```html
<script>
  window.$docsify = {
    // your config
    // ...
    editLink: {
      text: 'Edit this document',
      // text: '<span style="color: limegreen;">Edit this document</span>',
      repo: 'cyrilf/docsify-edit-link',
      // repo: 'https://github.com/cyrilf/docsify-edit-link/edit/master/docs/',
      cssClass: 'docsify-edit-link m-0'
    }
  }
</script>
<script src="//unpkg.com/docsify-edit-link@1"></script>
```

## Configuration

These are the options you can configure under `window.$docsify = { editLink: { ... }}`

| option | description | default value |
|-|-|-|
| text | the button text (can also be html) | Edit this page |
| repo | your github alias [userName]/[project] or full `edit url` | uses the `repo` from your docsify config if set |
| cssClass | a specific class to apply | edit-link |


## Customization

You can use the CSS class `edit-link` (or the one you specified via the `cssClass` option) if you want to apply any specific style to your link.

Also, remember that the `text` option also accept html. So you are very flexible in what you want to render.

## Q/A

- Where do I find the `edit url` of my project?

It's simple, open your project on Github/GitLab ... copy the `url` of where docsify is installed. Simply replace the word `blob` or `tree` by `edit`. For instance:

```diff
-https://github.com/cyrilf/docsify-edit-link/tree/master/docs/
+https://github.com/cyrilf/docsify-edit-link/edit/master/docs/
```
The first line is the root of your project.
The second line is the same but `tree` is now `edit`.
This is your `edit url` (and yes, it's a 404. This plugin will automaticaly add the file name at the end to make it work)
Use this only if you don't host your code on Github or if your docsify root location is not `./docs`.

----

Inspired by [njleonzhang/docsify-edit-on-github](https://github.com/njleonzhang/docsify-edit-on-github)

---
_Source: https://npm.io/package/docsify-edit-link · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._