DocOps.io Extension Server
Flexible Visualizations to supplement AsciiDoctor documents.
Flexible Visualizations to supplement AsciiDoctor documents.
Create stunning charts, buttons, planners, timelines, roadmap, and other visualizations with just a few lines of code. Lightweight, flexible, and powerful.
Add the DocOps Extension Server to a project to create beautiful visualizations in an AsciiDoctor document. Follow these steps to get started:
<dependency>
<groupId>io.docops</groupId>
<artifactId>docops-extension-server</artifactId>
<version>2024.00</version>
</dependency>implementation 'io.docops:docops-extension-server:2024.00'After adding the dependency to a project, the project can use the DocOps extensions to add the dependencies to the AsciiDoctor documents:
// In your Java code
import org.asciidoctor.Asciidoctor;
import org.asciidoctor.jruby.extension.spi.ExtensionRegistry;
// Initialize AsciiDoctorJ with DocOps extensions
Asciidoctor asciidoctor = Asciidoctor.Factory.create();
ExtensionRegistry.registerExtension(asciidoctor);
// Process your AsciiDoc content
String html = asciidoctor.convert(asciiDocContent, options);Check out the examples below to see the various visualizations one can create with DocOps extensions.
Discover the powerful visualization tools available in DocOps
Document and track architecture decisions with visual context
Responsive bar charts with custom styling and animations
Multi-series line charts with smooth animations
Customizable status badges and shields for documentation
Interactive hexagonal buttons with connecting lines
Create flow diagrams and process visualizations
Organize content with visual placemats and project planners
Visualize release plans, roadmaps, and deployment strategies
Visual scorecards and metrics dashboards for tracking
Interactive timelines for project history and planning
Explore additional visualizations and components
Document and visualize architecture decisions with context, rationale, and status. (See adr.html for more examples)
[docops,adr,useDark=false,role=center]
----
title: Use Elasticsearch for Search Functionality
status: Accepted
date: 2024-05-15
context:
- Our application needs robust search capabilities across multiple data types
- We need to support full-text search with relevance ranking
- The search functionality must scale with growing data volumes
- We need to support faceted search and filtering
decision:
- We will use Elasticsearch as our search engine
- We will integrate it with our existing PostgreSQL database
- We will implement a synchronization mechanism to keep data in sync
consequences:
- Improved search performance and capabilities
- Additional infrastructure to maintain
- Need for expertise in Elasticsearch configuration and optimization
- Potential complexity in keeping data synchronized
participants:
Jane Smith (Architect), John Doe (Developer),Alice Johnson (Product Manager)
----Enhance your AsciiDoctor documents with powerful visualizations