Cheat Sheet

Every comark-content import, grouped by role.

Every entry point comark-content ships, grouped by role. Import only what you use: each piece is opt-in.

Content

import {
  comarkContent,
  defineContentPlugin,
  // code generation
  generateSourceTypes, writeSourceTypes,
  // decode an artifact (advanced, see Artifacts & Hydration)
  readArtifact,
} from 'comark-content'

Client

import { createContentClient, defineContentClientPlugin } from 'comark-content/client'

Sources

import fs from 'comark-content/sources/fs'
import github from 'comark-content/sources/github'
import unstorageSource from 'comark-content/sources/unstorage'

Databases

For the SQL query and full-text search plugins.

import sqlite from 'comark-content/database/sqlite-node'
import sqliteWasm from 'comark-content/database/sqlite-wasm'

Plugins

// server halves
import sqlQuery from 'comark-content/plugins/sql-query'
import sqliteFullTextSearch from 'comark-content/plugins/sqlite-full-text-search'
import media from 'comark-content/plugins/media'
import json from 'comark-content/plugins/json'
import yaml from 'comark-content/plugins/yaml'
import markdownFields from 'comark-content/plugins/markdown-fields'
import schemaValidation from 'comark-content/plugins/schema-validation'

// helpers (import from the plugin entry, not comark-content)
import { markdownField, isMarkdownDocument } from 'comark-content/plugins/markdown-fields'

// client halves
import sqlQueryClient from 'comark-content/plugins/sql-query/client'
import sqliteFullTextSearchClient from 'comark-content/plugins/sqlite-full-text-search/client'

Build-time integration

import comark from 'comark-content/vite'

Not using Vite? Run comark-content prepare to generate source types as a standalone script or CI step.