rspress-plugin-load-readme v0.1.1

Install

npm install rspress-plugin-load-readme -D

Usage

// rspress.config.ts
import { loadReadme } from 'rspress-plugin-load-readme';
import { defineConfig } from 'rspress/config';

export default defineConfig({
  plugins: [loadReadme({
    repo: 'ulivz/rspress-plugin-load-readme'
  })],
});

Options

repo

• Type: string
• Required: true

Specify the Github repository to load, in the format <username><repo>.

branch

• Type: string
• Default: master

Specify the branch.

route

• Type: string
• Default: /readme

Specify the generated route.

License

MIT © ULIVZ