Markdown Indexer

pnpm add @moss-tools/md-indexer
# or
npm install @moss-tools/md-indexer

# .env
MOSS_PROJECT_ID=your-project-id
MOSS_PROJECT_KEY=your-project-key
MOSS_INDEX_NAME=your-index-name
MOSS_MODEL_NAME=moss-minilm   # optional, defaults to moss-minilm

import { sync } from '@moss-tools/md-indexer'

// Uses .env variables and the current directory
await sync()

// Custom config
await sync({
  root: './src/docs',
  creds: {
    projectId: 'your-project-id',
    projectKey: 'your-project-key',
    indexName: 'your-index-name',
    modelName: 'moss-minilm',  // optional
  },
})

import { buildJsonDocs } from '@moss-tools/md-indexer'

// Save to a file
await buildJsonDocs('./src/docs', { outputFile: './search-index.json' })

// Or get the array in memory
const documents = await buildJsonDocs('./src/docs')

import { createIndex } from '@moss-tools/md-indexer'

await createIndex('./search-index.json', {
  creds: {
    projectId: 'your-project-id',
    projectKey: 'your-project-key',
    indexName: 'your-index-name',
  },
})

- name: Sync docs to Moss
  run: npx tsx scripts/sync-index.ts
  env:
    MOSS_PROJECT_ID: ${{ secrets.MOSS_PROJECT_ID }}
    MOSS_PROJECT_KEY: ${{ secrets.MOSS_PROJECT_KEY }}
    MOSS_INDEX_NAME: docs

// scripts/sync-index.ts
import { sync } from '@moss-tools/md-indexer'
await sync({ root: './docs' })