Italic

Publish your digital garden to the Atmosphere

Transform your Markdown notes or Obsidian Vault into blogs, wikis, and websites that you can publish to Bluesky and the web. Think in public, build your audience, own your data.

• Blog-aware: custom taxonomies, theming, archives, rss and more
• Obsidian-compatible: Wikilinks, backlinks, block references and support for Obsidian-flavored Markdown.
• ATProto-enabled: publish to Bluesky and ATProto, with support for bsky and standard.site records.

Features

• Markup
  • Github-flavored Markdown
  • Multiple formats: publish content from Markdown, HTML, and YAML files
  • Math (LaTeX/KaTeX): inline/display math for technical gardens
  • Components (shortcodes): define custom components you can use in your Markdown for YouTube embeds, UI widgets, and more.
  • Code fences with syntax highlighting
  • Callouts: info, warnings, etc.
• Digital gardens
  • Wikilinks: fuzzy link matching using the same algorithm as Obsidian
  • Backlinks: see everything that links back to a page.
  • Block references: deep link to headings and blocks with Obsidian-style purple links.
  • Hashtags: lifted up to tag taxonomy
  • Obsidian Markdown extensions: supports lots of long-tail Obsidian Markdown features.
  • Obsidian Vaults: seamlessly transform your Vault into a website.
• Blogs
  • Draft posts
  • Tags
  • Archives: paginated archival posts
  • RSS: syndicate your posts, including multiple custom feeds
  • Publish multiple blogs on the same site (custom collections)
• Content websites
  • Custom permalinks: customizable per-collection and per-page
  • Redirects
  • Custom taxonomies: organize posts by tag, category, artist, label, phase of the moon — no problem.
  • Custom collections: glob-match files to define custom page collections you can use in templates
  • Related pages: Surface related posts with a customizable algorithm
  • Page trees: organize pages into a tree for menus
  • Collection defaults: add custom metadata to groups of pages
  • Data files: bulk-add custom template data via the data/ folder
• Theming
  • Themes
  • Theme overrides
  • Tera templates: blazingly fast Jinja-like templates in Rust with support for template functions, filters, components, template extension, and more.
  • Lots of built-in custom filters and functions
• SEO
  • Social cards: automatically add metadata for Twitter Cards, Facebook Open Graph, schema.org and more.
  • sitemap.xml support
• Development
  • Built-in local dev server
  • Super-fast hot reload
• ATProto integration
  • PDS integration: publish and check your website's sync status
  • Bluesky microblogging
  • standard.site records

Install

cargo install italic

This puts italic on your PATH (typically ~/.cargo/bin/italic).

Quick start

italic new my-site
cd my-site
echo '# Hello, world' > content/index.md
italic serve

Congrats! You have a website at http://localhost:3000.

To dress it up, grab a starter theme:

git clone --depth 1 https://github.com/gordonbrander/italic_themes.git themes/

# config.yaml
theme: "themes/obsidian"

Then italic build outputs plain static files to public/, ready for any host. The quickstart covers all of this in more detail.

Documentation

Full documentation lives in docs/:

• Quickstart — zero to website in four commands
• Tutorial — publish your Obsidian vault, with backlinks, tags, and feeds
• Concepts — project layout, content model, the build pipeline
• Guides — wikilinks, related pages, collections, taxonomies, templates, archives & feeds, themes, deployment, migration, and more
• Reference — CLI, configuration, frontmatter, templates

License

AGPL — see LICENSE-AGPL.