npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vue3-doxygen-xml

v0.3.0

Published

Vue 3 component for Doxygen XML content.

Downloads

55

Readme

logo

vue3-doxygen-xml

npm npm vue3

Vue component for displaying Doxygen XML content.

Project setup

npm install --save vue3-doxygen-xml

Module import

Install the module like so:

import { createApp } from 'vue'
import App from './App.vue'

import { installVue3DoxygenXml } from 'vue3-doxygen-xml'
import 'vue3-doxygen-xml/dist/style.css'

createApp(App)
  .use(installVue3DoxygenXml)
  .mount('#app')

Add the above to your main.js application file (this assumes that a standard layout is followed when creating your application). Importing the default style.css is optional, delete the import 'vue3-doxygen-xml/dist/style.css' line from the above code sample to apply your own style.

Module component

To use the vue3-doxygen-xml component import it in a view and set the baseURL for the source XML. Example view Help.vue:

<template>
  <div class="help">
    <doxygen-xml baseURL="/doxygen-xml-files" />
  </div>
</template>

<script setup>
import { DoxygenXml } from 'vue3-doxygen-xml'
</script>

Module routing

vue3-doxygen-xml requires that you use vue-router. To add a vue3-doxygen-xml route under help add the following to routes object for vue-router:

  {
    path: '/help/:pageName?',
    name: 'Help',
    // route level code-splitting
    // this generates a separate chunk (about.[hash].js) for this route
    // which is lazy-loaded when the route is visited.
    component: () => import(/* webpackChunkName: "help" */ '../views/Help.vue')
  }

Again assuming standard layout.

Examples

For a complete example of a Vue application using vue3-doxygen-xml look at https://github.com/hsorby/example-vue3-doxygen-xml. The main branch has a basic example of how vue3-doxygen-xml may be used and the multi_version branch has an example of how vue3-doxygen-xml may be used for different versions of Doxygen XML output.


License

Apache-2.0


Development setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.