Integrations
Integrations Overview
Connect Docsalot with your favorite documentation tools and frameworks
Overview
Docsalot integrates seamlessly with your existing documentation tools and static site generators. Whether you're just getting started with docs-as-code or are a seasoned pro, Docsalot works with almost any static site generator to automate your documentation workflow.
Our integrations allow you to continue using your preferred documentation framework while benefiting from Docsalot's AI-powered generation, automatic updates, and smart 404 recommendations.
Supported Integrations
Docsalot supports a wide range of documentation frameworks and static site generators. Here are some of the most popular integrations:
Mintlify
Integrate Mintlify with Docsalot for beautiful and functional documentation with modern UI components and interactive features.
Docusaurus
Easily integrate Docusaurus with Docsalot to ship documentation faster with React-powered static site generation.
Hugo
Easily integrate Hugo with Docsalot to ship documentation faster using the world's fastest static site generator.
Sphinx
Effortlessly combine Sphinx with Docsalot to improve user experience for Python documentation and API references.
MkDocs
Link MkDocs with Docsalot to enhance user experience effortlessly with Python-powered documentation generation.
React
Integrate React with Docsalot for an improved user experience with custom component documentation.
And Many More...
Docsalot integrates with almost any static site generator. If you don't see your preferred tool listed here, it likely still works with Docsalot. Our flexible architecture supports any tool that generates documentation from markdown or code.
How It Works
Integrating Docsalot with your documentation framework is straightforward:
1. Choose Your Hosting Option
When creating a workflow, select either Managed Docs for automatic hosting or Bring Your Own Docs to commit generated documentation to your repository where your static site generator can process it.
2. Configure Your Documentation Repository
If using your own repository, specify where Docsalot should commit the generated documentation. This can be the same repository as your code or a separate docs repository.
3. Let Your Tool Build
Once Docsalot commits the documentation, your static site generator (Docusaurus, Hugo, etc.) will automatically build and deploy the updated docs through your existing CI/CD pipeline.
4. Automatic Updates
From now on, whenever you merge a pull request, Docsalot will automatically update your documentation and your chosen framework will rebuild the site.
Example: Using Docusaurus
- 1.Create a Docsalot workflow pointing to your repository
- 2.Select "Bring Your Own Docs" and specify your docs folder (e.g.,
docs) - 3.Docsalot generates documentation and commits it to your
docsfolder - 4.Docusaurus automatically rebuilds your site with the new documentation
- 5.Your documentation is live with zero manual effort
Best Practices
- •Keep your
.docsalot.yamlconfiguration in sync with your documentation tool's ignore patterns - •Test your workflow with a small repository first before rolling it out to larger projects
- •Review the generated documentation after your first few PRs to ensure quality
- •Use branch protection rules to ensure documentation updates are reviewed alongside code changes
Need help with a specific integration? Contact our support team or check the documentation for your static site generator for specific setup instructions.