Litos Companion

by zerokei
5
4
3
2
1
Score: 50/100

Description

Reviews

No reviews yet.

Stats

1
stars
75
downloads
0
forks
35
days
6
days
6
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
13
commits

Latest Version

7 days ago

Changelog

Features

  • Add theme compatibility status with Litos version/API detection and clear notices for unsupported or stale theme configurations.
  • Pause theme-specific heading controls and Litos style tokens when the loaded theme is incompatible, while keeping general Mermaid, Zen, and accent-color features available.
  • Adapt diagram node radius, label radius, and line width to optional compatible-theme variables, preserving the existing defaults when values are missing or invalid.

Fixes

  • Update sanitizer and source-map dependencies with security patches.

Compatibility and validation

  • Requires Obsidian 1.13.7 or later on desktop. Theme-specific controls support Litos 1.1.3 or later with Companion API 1. Litos and Companion retain independent releases.
  • Lint, 58 tests, TypeScript checks, production build, and release metadata validation passed. The theme/plugin combination was also checked in real Obsidian on macOS in Reading view and Live Preview with light and dark appearance.
  • Standard release assets are built and attested by the GitHub release workflow: main.js, manifest.json, and styles.css.

README file from

Github

Litos Companion — Read. Think. Make it yours.

Make the Litos workspace your own with optional display controls and Mermaid ELK support.

Litos provides the theme; Litos Companion adds controls and diagram capabilities. Install either independently. Heading controls require a compatible Litos theme.

Features

  • Zen mode: Hide workspace controls for a quieter view; toggle from settings or the command palette.
  • Heading controls: Adjust H2 alignment in Reading view and Live Preview.
  • Accent color: Adjust Obsidian’s native accent color from the plugin settings.
  • Mermaid ELK support: Use ELK automatic layout for Mermaid flowcharts.

Requirements

  • Obsidian 1.13.7 or later on desktop.
  • Heading controls require a Litos theme version that supports Companion API 1.
  • Mermaid ELK support also works with other themes. It is disabled by default and can be enabled in the plugin settings.

Download from GitHub Releases. See the user guide for installation and usage instructions.

Dependencies

Dependency Version Purpose
Mermaid 11.16.1 Diagram parsing and rendering
@mermaid-js/layout-elk 0.2.0 ELK layout integration
yaml ^2.9.1 Diagram configuration parsing

Built with TypeScript, esbuild, and Vitest. See package.json for the complete dependency list.

Documentation

License

MIT. Third-party components are distributed under their respective licenses; see third-party notices.