Properties3
4Lithos is built on Nuxt Content and Docus. Your primary authoring syntax is always Obsidian (see Writing Content). MDC (Markdown Components) syntax is available for features that have no Obsidian equivalent -- interactive tabs, landing page grids, code groups, and other web-specific components.
::u-page-hero and ::u-page-card components because Obsidian has no concept of hero sections or card grids. For everything else -- links, embeds, callouts, math, diagrams -- use standard Obsidian syntax.MDC Syntax Basics
MDC allows you to use Vue components directly in your Markdown.
Attributes and Props
You can pass props to components using {} syntax:
- String:
key="value" - Number:
key=123 - Boolean:
key(implies true) or:key="false" - Array/Object:
:key="[1, 2]"
::alert{type="info" :dismissible="true"}
This is an info alert.
::
Slots
Components can have named slots invoked with #slot-name.
::card
#title
My Card Title
#default
This is the main content of the card.
#footer
Optional footer content.
::
Built-in Components
Lithos inherits Docus's rich component library.
Alert / Callout
Badge
v1.0.0Code Groups
Display multiple code blocks in a tabbed interface:
npm install lithos
yarn add lithos
Steps
Great for tutorials or workflows:
- Install Run the installation command.
- Configure
Update
nuxt.config.ts. - Deploy Push to production.
Layout Slots
You can insert content into specific layout slots using the :: syntax.
Page Hero (::block-hero)
Overrides the header area of the page.
Custom Hero
Card Grid (::card-grid)
Creates a responsive grid for keys features or navigation.
Feature A
Feature B
Frontmatter
Lithos supports both Obsidian-style YAML frontmatter and Nuxt Content's extended frontmatter.
---
title: My Page
description: Page description
icon: i-lucide-home
navigation:
title: Sidebar Title
head:
meta:
- name: 'keywords'
content: 'nuxt, obsidian, docs'
---
Mixing with Obsidian
You can use MDC components inside Obsidian callouts, or Obsidian links inside MDC components.
This text contains a Wikilink inside a hybrid structure.