msoffice-addin/README.md

Microsoft office addin module for Nuxt abd vite

<!--
Get your module up and running quickly.

Find and replace all on all files (CMD+SHIFT+F):
- Name: msoffice-addin
- Package name: msoffice-addin
- Description: My new Nuxt module
-->

# msoffice-addin

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

MS Office addin for Nuxt and Vite

- [✨ &nbsp;Release Notes](/CHANGELOG.md)
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/msoffice-addin?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->

## Features

<!-- Highlight some of the features your module provide here -->
- 🌍 Supports both Nuxt & Vite
- ⚙️ ENV variables support in manifest files
- 🪝 Define dynamic env variables
- 🧬 Same manifest routes in dev and build
- 💉 Auto inject Office.js in routes

## Quick Setup

- [Nuxt](docs/nuxt-setup.md)
- [Vite](docs/vite-setup.md)

## [Configuration](docs/config.md)

## Contribution

<details>
  <summary>Local development</summary>

  ```bash
  # Install dependencies
  npm install

  # Generate type stubs
  npm run dev:prepare

  # Develop with the playground
  npm run dev

  # Build the playground
  npm run dev:build

  # Run ESLint
  npm run lint

  # Run Vitest
  npm run test
  npm run test:watch

  # Release new version
  npm run release
  ```

</details>

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/msoffice-addin/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/msoffice-addin

[npm-downloads-src]: https://img.shields.io/npm/dm/msoffice-addin.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/msoffice-addin

[license-src]: https://img.shields.io/npm/l/msoffice-addin.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/msoffice-addin

[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com