Giter Club home page Giter Club logo

vuepress-plugin-custom-authors's Introduction

vuepress-plugin-custom-authors

Add custom authors to the VuePress.

Install

yarn add vuepress-plugin-custom-authors

Config

Add it to your Vuepress configuration's plugin list:

// .vuepress/config.ts
import { defineUserConfig } from 'vuepress';
import { customAuthorsPlugin } from 'vuepress-plugin-custom-authors';

export default defineUserConfig({
  plugins: [
    customAuthorsPlugin({
      label: 'Your Custom Label', // Custom label text, default: Authors
    }),
  ],
});

Usage

Add authors at the frontmatter of the markdown document:

---
authors: AuthorA, AuthorB
---

Display anywhere in the component:

<script setup lang="ts">
import { computed } from 'vue';
import { usePageData } from '@vuepress/client';

const page = usePageData();

const authors = computed(() => ({
  label: page.value.authorLabel,
  name: page.value.authors,
}));
</script>

<template>
  <p>
    <span>{{ authors.label }}: </span>
    <span>{{ authors.name }}</span>
  </p>
</template>

vuepress-plugin-custom-authors's People

Contributors

gookyn avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.