obsidian-plugin/mmomm-org_obsidian-newtab
1
0
Fork 0
mirror of https://github.com/mmomm-org/obsidian-newtab.git synced 2026-07-22 07:43:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mmomm-org_obsidian-newtab/docs/README.md
Marcus Breiden 20e954484d docs: add user-facing docs tree (install, config, usage, index) 
Scaffold and draft a docs/ tree via doc-product:
- installation: Community Plugins + BRAT, verify, updating
- configuration: all 29 settings generated from src/Settings/Settings.ts
- usage: first use, workflows, shortcuts
- README: docs index with map + quick links
- keep existing troubleshooting.md; remove internal roadmap/scaffolding notes
- root README: refresh Documentation section, fix dead link

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-11 18:59:50 +00:00

1.3 KiB
Raw Permalink Blame History

Documentation

New Tab replaces Obsidian's empty new-tab view with a customizable dashboard — a background image, a clock, a greeting, quick search, recent files, bookmarks, and a quote. This directory is the user-facing guide; for development and contribution notes, see the project README.

Overview

These pages take you from installing the plugin to tuning every widget:

Documentation map

  • Installation — prerequisites, Community Plugins and BRAT installs, verifying, updating.
  • Configuration — every setting, its default, and what it controls.
  • Usage — first use, common workflows, tips and shortcuts.
  • Troubleshooting — backgrounds or quotes not loading, debug logging, known issues.

Quick links