ApexDocs
<div align="center" <bCLI and Node library to generate documentation for Salesforce Apex classes.</b
</div
ApexDocs is a non-opinionated documentation generator for Salesforce Apex classes. It can output documentation in Markdown format, which allows you to use the Static Site Generator of your choice to create a documentation site that fits your needs, hosted in any static web hosting service.
Table of Contents
- 👀 Examples
- 🚀 Features
- 💿 Installation
- ⚡ Quick Start
- CLI
- Markdown
- OpenApi
- Changelog
- ▶️ Available Commands
- Markdown
- OpenApi
- Changelog
- 🔬 Defining a configuration file
- 🌐 Translation
- ⤵︎ Importing to your project
- 📖 Documentation Guide
- 📄 Generating OpenApi REST Definitions
👀 Examples
ApexDocs generates Markdown files, which can be integrated into any Static Site Generation (SSG) engine, (e.g. Jekyll, Vitepress, Hugo, Docosaurus, etc.) to create a documentation site that fits your needs.
This gives you the flexibility to create beautiful sites by leveraging your preferred SSG engine, which usually provides a wide range of themes, dark mode support, and other features out of the box.
<div align="center" <img src="imgs/vitepress-light.png" alt="Vitepress Light" width="45%" / <img src="imgs/vitepress-dark.png" alt="Vitepress Dark" width="45%" / </div
These are examples of documentation sites generated using Vitepress. Head over to the examples/vitepress folder to see the code.
The extra flexibility also lets you integrate the output documentation with your existing documentation site, allowing you to match the look and feel of your existing site.
<div align="center" <img src="imgs/integration.png" alt="Integration" width="70%" / </div
OpenApi REST definitions can be visualized using a tool like ReDoc, Swagger UI, or any other OpenApi viewer.
<div align="center" <img src="imgs/redocly.png" alt="OpenApi" width="70%" / </div
This repo contains several other example implementations in the examples directory, showcasing how to integrate with different tools.