Skip to content

Added obsidian use cases#1179

Draft
KarolaKirsanow wants to merge 5 commits into
DiscourseGraphs:mainfrom
KarolaKirsanow:workflows01
Draft

Added obsidian use cases#1179
KarolaKirsanow wants to merge 5 commits into
DiscourseGraphs:mainfrom
KarolaKirsanow:workflows01

Conversation

@KarolaKirsanow

@KarolaKirsanow KarolaKirsanow commented Jun 30, 2026

Copy link
Copy Markdown

This PR updates the navigation in the roam & obsidian docs pages & adds 5 use cases: project tracking, experiment tracking, literature synthesis, building a pkm base, and sharing your research

Additional changes:

  • placed docs in content/obsidian/use-cases/
  • Images placed in /docs/guides/obsidian/image.png to avoid multiple naming collisions with the rest of the doc images

Image borders

  • Border (1px solid #cbcbcb) applied to use-case docs only, not all docs
  • Implemented via isUseCasePage prop (mdxPath[0] === "use-cases") passed from [[...mdxPath]]/page.tsxDocsPageTemplate, which wraps content in <div className="use-case-content">
  • CSS rule in nextra-css.css: .use-case-content img { border: 1px solid #cbcbcb; }

Image sizing

  • Use | width in alt text: ![description | 400](image.png) — sets width in px, stripped from rendered alt
  • Implemented in mdx-components.tsx via DocImage wrapping the theme's BaseImg (not a plain <img>) to preserve Nextra's path resolution

Node tag component

  • Added <nodetag type="hyp" /> MDX shortcode to render colored pill tags in docs matching app node type colors
  • Colors sourced from app's colorUtils.ts palette; color prop available for per-instance overrides
  • Must use lowercase name (nodetag) — MDX in .md files only routes lowercase JSX elements through _components

Callouts

  • Added blockquote MDX component override in mdx-components.tsx that renders Obsidian-style callouts
  • Syntax: > [!type] Title (static), > [!type]+ Title (foldable open), > [!type]- Title (foldable closed)
  • Foldable callouts use native <details>/<summary> — no JS required
  • Implemented as a render-time component (not a rehype plugin) to avoid Turbopack's serialization constraint on function-valued loader options
  • Supported types: info, tip, note, warning, caution, check, done, question, fail, error, danger, abstract, summary

@vercel

vercel Bot commented Jun 30, 2026

Copy link
Copy Markdown

@KarolaKirsanow is attempting to deploy a commit to the Discourse Graphs Team on Vercel.

A member of the Team first needs to authorize it.

@KarolaKirsanow KarolaKirsanow added the documentation Improvements or additions to documentation label Jun 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant