linked-docs

0.1.14 • Public • Published

Linked Docs

Demo

Fast automatics top links to make documentations more friendly.

https://linked-docs.netlify.app/

Install

$ npm i --save-dev linked-docs

Usage

*Add component to your VitePress / VuePress configurations *

// At your .vitepress/theme/index.ts:
import {LinkedItems} from 'linked-docs';
import 'linked-docs/dist/style.css'

export default {
	// ... other config
	enhanceApp({app}) {
		// some other code

		app.component('LinkedItems', LinkedItems);
	}
}

use it at the top of your markdown files, e.g.:

---
title: Linked DOCS
editLink: true
---
<LinkedItems/>

Lorem ipsum dolor sit emet

Enjoy!

Package Sidebar

Install

npm i linked-docs

Weekly Downloads

0

Version

0.1.14

License

MIT

Unpacked Size

9.66 kB

Total Files

5

Last publish

Collaborators

  • davidmeirlevy