Pom Generation
The Verdex Pom Generation allows you to create and edit documentation directly in your browser, with live preview and collaboration features.
Getting Started
The Pom Generation is available at https://pom.verdex.dev for all accounts. To get started:
- Log in with your Verdex account
- Select an existing project or create a new one
- Navigate to the documentation section
- Start editing your docs!
Key Features
Rich Markdown Editor
The editor supports full Markdown syntax with additional features:
- Real-time preview as you type
- Syntax highlighting for code blocks
- Drag-and-drop image uploads
- Table editor with formatting controls
- Math equation support using LaTeX syntax
Collaborative Editing
Multiple team members can work on the same document simultaneously:
- See who's currently editing
- View cursors and selections in real-time
- Comment and suggest changes
- Track document history with versioning
Live Preview
See how your documentation will look to users as you make changes:
- Side-by-side editing and preview
- Mobile view simulation
- Theme switching to test light and dark modes
- Accessibility checker for common issues
Pro Tip
Use keyboard shortcuts to speed up your workflow. Press Ctrl+/ or Cmd+/ to see all available shortcuts.
Integration with Your Codebase
Changes made in the Web Editor can be automatically synced with your Git repository:
# In your project directory
npm run verdex:syncThis will pull the latest documentation changes and merge them with your local files.
Next Steps
Ready to try some advanced features? Check out theComponentssection to learn about interactive elements you can add to your documentation.