How gram-ax/gramax works
Gramax is a Markdown-based documentation editor and publishing platform. The main workflow is to create a workspace and catalog, edit articles, collaborate through Git synchronization, then publish documentation to a portal or static site. Its architecture also includes platform-specific app initialization, search, authentication, plugins, enterprise capabilities, and migration imports. The README supports the product workflow and capabilities; source excerpts show app initialization and selected internal services, but not most command-to-service wiring, so those relationships are not inferred.
Main entry points: app.ts Application initialization · article Article editing · workspace Workspaces and catalogs · storage Local Markdown storage
Components 21
Documentation authoring
- Workspaces and catalogs
app/commands/workspace - Article editing
app/commands/article - Markdown parsing and rendering
core/extensions/markdown - Rich content elements
app/commands/elements - Multilingual catalogs
app/commands/catalog/language - Catalog views and navigation
app/commands/catalog/views
Storage and collaboration
- Local Markdown storage
app/commands/storage - Git version control
app/commands/versionControl - Reviews and merge requests
app/commands/mergeRequests - Enterprise workspaces
app/commands/enterprise
Publishing and import
- Documentation portal
apps/docportal/server/handlers - Static site generation
apps/cli/src/logic/StaticSiteBuilder.ts - Content migration
apps/cli/src/features/import/yandex
Application platform
- Application initialization
app/web/app.ts - Application service model
app/types/Application.ts - Application configuration
app/config/AppConfig.ts - Search
app/commands/search - Authentication
core/extensions/security/logic/AuthManagerProvider.ts - Workspace plugins
core/plugins/bootstrap/WorkspacePluginBootstrap.ts - Core runtime modules
core
Other components
- Documentation author
Connections 17
- Documentation author → Workspaces and catalogs: creates workspace
- Workspaces and catalogs → Article editing: contains articles
- Documentation author → Article editing: edits articles
- Article editing → Local Markdown storage: stores Markdown
- Documentation author → Git version control: synchronizes changes
- Documentation author → Reviews and merge requests: collaborates
- Documentation author → Documentation portal: publishes catalog
- Documentation author → Static site generation: builds static site
- Documentation author → Content migration: imports content
- Application initialization → Application configuration: reads configuration
app/web/app.ts - Application initialization → Application service model: assembles services
app/web/app.ts - Application initialization → Local Markdown storage: initializes provider
app/web/app.ts - Application initialization → Search: creates search manager
app/web/app.ts - Application initialization → Markdown parsing and rendering: initializes parser
app/web/app.ts - Application initialization → Core runtime modules: registers file handlers
app/web/app.ts - Application initialization → Authentication: provides auth services
app/web/app.ts - Application initialization → Workspace plugins: enables workspace plugins