Home
@microsoft/api-documenter

Links

Read JSON files from api-extractor, generate documentation pages

Package: @microsoft/api-documenter

Created by: microsoft

Last modified: Wed, 10 Apr 2024 15:10:32 GMT

Version: 7.24.2

License: MIT

Downloads: 424,531

Repository: https://github.com/microsoft/rushstack

Install

npm install @microsoft/api-documenter

yarn add @microsoft/api-documenter

@microsoft/api-documenter

This tool can be used to generate an online API reference manual for your TypeScript library.
It reads the *.api.json data files produced by API Extractor,
and then generates files in Markdown or
DocFX format.

For usage information, see the
Generating Docs article from the API Extractor
documentation.

Dependencies

@microsoft/tsdoc: 0.14.2 js-yaml: ~3.13.1 resolve: ~1.22.1 @rushstack/node-core-library: 4.1.0 @rushstack/ts-command-line: 4.19.2 @microsoft/api-extractor-model: 7.28.14 @rushstack/terminal: 0.10.1

Dependencies

@types/js-yaml: 3.12.1 @types/resolve: 1.20.2 @rushstack/heft: 0.66.3 local-node-rig: 1.0.0

Enhancing Vue.js Development: Harnessing the Potential of Vue-Loader

Vue.js has gained immense popularity as a JavaScript framework for building user interfaces. Its simplicity, flexibility, and performance have made it a favorite among developers. However, to...

Simplify Data Validation in Vue.js: A Step-by-Step Guide to Using Regex

Data validation is a critical aspect of web development that ensures the accuracy and integrity of user input. Whether it's validating an email address, password, or phone number, implementing robust...

Troubleshooting Made Easy: Common Issues and Solutions with vue-loader Without vue-cli

Hey there, Vue.js enthusiasts! Are you ready to dive into the world of troubleshooting? In this blog post, we'll be discussing common issues and solutions with vue-loader without using vue-cli....

Optimizing Webpack 4 with Vue CLI 3: Disabling the Cache-Loader

Welcome to another blog post on optimizing Webpack 4 with Vue CLI 3! In this article, we'll explore how to disable the Cache-Loader in Webpack and discuss the importance of optimizing build times for...

Step-by-Step Guide: How to Add a Function to Your Vuex Plugin

In today's blog post, we are going to dive into the world of Vuex plugins and explore how to add a function to your plugin. Vuex is an essential part of managing state in Vue applications, and...

Introducing a blog that delves into the exciting world of Vue.js components. Stay tuned for insightful examples and valuable insights that will elevate your Vue.js development skills.

Links

Install

@microsoft/api-documenter

Links

Dependencies

Dependencies

RELATED POST

Enhancing Vue.js Development: Harnessing the Potential of Vue-Loader

Simplify Data Validation in Vue.js: A Step-by-Step Guide to Using Regex

Troubleshooting Made Easy: Common Issues and Solutions with vue-loader Without vue-cli

Optimizing Webpack 4 with Vue CLI 3: Disabling the Cache-Loader

Step-by-Step Guide: How to Add a Function to Your Vuex Plugin