onboarding

Scan markdown collections and generate an executable ImportPlan for TypeMD vaults.

9|2|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/typemd/typemd --skill onboarding-typemd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboarding
Source: https://github.com/typemd/typemd/tree/main/core/skills/onboarding
Command: npx skills add https://github.com/typemd/typemd --skill onboarding-typemd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps users migrate scattered markdown files into a structured TypeMD vault by scanning source directories, inferring types and properties from frontmatter, mapping relations, and creating proper TypeMD objects without modifying the original files.

Core Features & Use Cases

  • Four-phase guided workflow: Scan, Plan, Execute, Verify to ensure safe, reviewable imports.
  • Schema inference & mapping: Match files to existing types, suggest new types, and infer property types from frontmatter values.
  • Relation discovery & conflict handling: Detect cross-file references, wiki-links, and apply conflict policies (default skip) with an ordered import that respects dependencies.
  • Use Case: Migrate an exported personal notes folder or a team's markdown wiki into TypeMD while preserving links, tags, and metadata.

Quick Start

Scan my notes folder and generate a recommended ImportPlan that classifies files into types and maps frontmatter to TypeMD properties.

Frequently Asked Questions about onboarding

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I import existing markdown files into a structured vault without losing frontmatter and wiki-links?

To import markdown files into a structured vault without losing frontmatter, use a scan-to-plan-to-execute workflow that infers schemas, discovers cross-file relations, and generates an executable ImportPlan preserving your metadata and links.

What is schema inference and how does it work when migrating markdown collections?

Schema inference during markdown migration works by scanning frontmatter values in your source files to automatically map them to existing types, suggest new types, and infer property types, turning unstructured notes into structured objects.

How do I resolve conflicts when migrating a markdown wiki with cross-file references?

When migrating a markdown wiki with cross-file references, conflicts are resolved by applying a default skip policy and generating an ordered import sequence that respects file dependencies, ensuring no data is overwritten without review.

Does the markdown onboarding process modify my original source files during scanning?

No, the markdown onboarding process does not modify your original source files during scanning. It safely reads the directories, infers structures, and produces an ImportPlan JSON that defines how to create new structured objects in your vault.

What is the best way to migrate exported blog posts and team notes into TypeMD?

The best way to migrate exported blog posts and team notes into TypeMD is using a four-phase guided workflow: Scan, Plan, Execute, and Verify, which classifies files into types and maps frontmatter to properties for a safe, reviewable import.

What happens to unmapped or conflicting files during the markdown import process?

During the markdown import process, unmapped or conflicting files are skipped by default to ensure safe onboarding. The generated ImportPlan highlights these conflicts, allowing you to review dependencies and adjust the schema mapping before execution.