[▲ Vercel Community](/) · [Categories](/categories) · [Latest](/latest) · [Top](/top) · [Live](/live)

[Help](/c/help/9)

# Deploying Mkdocs- and Doxygen-built static files

193 views · 0 likes · 3 posts


Mingo Blox (@mingo-blox) · 2024-08-19

<!-- Be sure to include all detail needed to let others see the same problem --> 
I want to deploy project documentation generated using Doxygen and Mkdocs (uses mkdoxy as a plugin).

I am unsure how to set up deployment especially the build commands since the documentation generation depends heavily on Doxygen and Mkdocs.
I can install the dependencies for Mkdocs but not oxygen.

Any help will be greatly appreciated.


Pauline P. Narvas (@pawlean) · 2024-08-19

Hi, @mingo-blox and welcome!

I'm not familiar with Doxygen and Mkdocs, but after some research, it seems like you can follow these rough steps:

* **Generate Doxygen documentation** locally and integrate it into your MkDocs site.
* **Build the documentation site** locally and deploy the generated `site/` directory to Vercel.
* Use Vercel’s configuration to specify the build command and output directory. See below:
* 
1. Since Vercel automatically detects and deploys from the `output` directory, you need to specify the build command and output directory.
2. In your project’s root, create or edit the `vercel.json` file to specify the build command and output directory:

```
{
  "builds": [
    {
      "src": "mkdocs.yml",
      "use": "@vercel/static-build",
      "config": {
        "distDir": "site"
      }
    }
  ],
  "scripts": {
    "build": "mkdocs build"
  }
}
```
3. Commit all your changes, including the pre-generated Doxygen documentation, and push them to your Git repository.
4. Vercel will automatically detect the configuration and deploy the MkDocs site.

Does this help?


nateland (@nateland) · 2024-08-21

Almost there - it seems `scripts` isnt' in the right place anymore:

```
Build Failed
The `vercel.json` schema validation failed with the following message: should NOT have additional property `scripts`
```