Advanced

Plugins

Extend the core functionality with powerful third-party integrations.

The plugin architecture allows you to hook into the build process. Whether you need Algolia Search, Google Analytics, or a custom Markdown parser, the plugin system has you covered.

import { AnalyticsPlugin } from 'devdocs-plugins';

docs.use(AnalyticsPlugin({
  trackingId: 'UA-XXXXX-Y'
}));

Deployment

DevDocs generates a static site that can be hosted on any web server. Follow these steps to prepare your project for production:

# Create a production build
npm run docs:build

# Preview the production build locally
npm run docs:preview

Once built, you can simply upload the /dist folder to platforms like Netlify, Vercel, or AWS S3.

Note
Remember to set your BASE_URL environment variable if you are hosting the site in a subdirectory.

Troubleshooting

Encountering issues? Here are the most common problems and how to fix them quickly.

IssuePossible CauseSolution
Build FailedIncompatible Node.js version.Ensure you are using Node.js 18 or higher.
Styles not loadingIncorrect BASE_URL.Check your configuration if hosting in a subdirectory.
Plugin ErrorMissing peer dependencies.Run npm install to ensure all dependencies are met.
Still need help?
If you can't find the answer here, please open an issue on our GitHub repository or join our Discord community.