Japanese Novel Tools

pending

by satoshikokubo

Syntax highlighting and control character visualization for Japanese novel writing.

3 starsUpdated 1mo ago0BSDDiscovered via Obsidian Unofficial Plugins
View on GitHub

Japanese Novel Tools

An Obsidian plugin for Japanese novel writers.
日本語小説執筆者向けのObsidianプラグインです。


Features / 機能

Control character visualization / 制御文字の可視化

  • Full-width spaces ( ) are displayed as in the editor
  • Line breaks are displayed as in the editor
  • Visible only in editing mode — does not affect the actual text

Syntax highlighting / シンタックスハイライト

Color-coding in the editor for:

SyntaxDescriptionDefault color
「」Dialogue (single)Green
『』Dialogue (double)Yellow-green
漢字《ルビ》 |text《ルビ》Ruby / furiganaBlue
() ()ParenthesesRed
【】Bold bracketsOrange
〔〕Square brackets (annotation)Purple
〈〉Angle bracketsCyan
"" ""Double quotesYellow
[] []Square bracketsLight orange
'' ''Single quotesLime
  • Ruby notation supports both 漢字《よみ》 (kanji-only) and |text《よみ》 (pipe prefix)
  • When symbols overlap (e.g. quotes inside dialogue), inner symbols take priority

Preview highlighting / プレビューのハイライト(オプション)

Optionally apply the same color-coding to the reading preview.

Layout settings / レイアウト設定

Editor:

  • Adjustable line width for horizontal writing (px)

Preview:

  • Vertical writing (縦書き) mode with adjustable height (vh)
  • Toggle vertical / horizontal writing from the status bar button or command palette (hotkey assignable)
  • Adjustable line width for horizontal writing (px)
  • Adjustable column gap in vertical writing (em)
  • Intuitive mouse wheel scrolling in vertical mode (up = scroll right, down = scroll left)
  • Hide frontmatter properties in vertical mode (prevents layout breakage)

Blank line preservation / 連続空行の保持

Multiple consecutive blank lines in the source are preserved in preview mode (Markdown normally collapses them).


Installation / インストール

From Community Plugins / コミュニティプラグインから

  1. Open Obsidian Settings → Community plugins
  2. Disable Safe mode if prompted
  3. Select Browse and search for Japanese Novel Tools
  4. Select Install, then Enable

Manual installation / 手動インストール

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Copy the files to your vault: <Vault>/.obsidian/plugins/japanese-novel-tools/
  3. Reload Obsidian and enable the plugin under Settings → Community plugins

Settings / 設定

Open Settings → Japanese Novel Tools to configure:

  • Highlight features: Toggle each syntax highlight individually
  • Colors: Customize colors for each syntax type
  • Editor settings: Line width for horizontal writing
  • Preview settings: Toggle vertical writing, adjust height, line width, and column gap
  • Mouse wheel: Toggle intuitive wheel scrolling in vertical preview mode
  • Debug: Show colored borders around layout areas for troubleshooting
  • Reset: Restore all settings to defaults

Notes / 注意事項

  • Syntax highlighting applies to the editor (Live Preview / Source mode) only, unless preview highlighting is enabled in settings
  • The mouse wheel intercept applies only when vertical preview mode is ON
  • Half-width brackets () and [] may appear rotated in vertical writing mode — this is a browser/font limitation; use full-width () [] for best results

Compatibility / 動作環境

  • Obsidian v0.15.0 or later
  • Desktop and mobile

License / ライセンス

0-BSD

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.