Skip to content

tutorial.md

Latest commit

 

History

History
43 lines (27 loc) · 761 Bytes

tutorial.md

File metadata and controls

43 lines (27 loc) · 761 Bytes
Raw

Getting Started with mdschema

Prerequisites

Before you begin, you need to install Go 1.21 or later.

Steps

Step 1: Install mdschema

Install mdschema using Go:

go install github.com/jackchuka/mdschema/cmd/mdschema@latest

Step 2: Create a Schema

Create a .mdschema.yml file:

structure:
  - heading: "# My Project"
    children:
      - heading: "## Features"
      - heading: "## Installation"

Step 3: Validate a Markdown File

Run mdschema to validate your Markdown file:

mdschema validate path/to/yourfile.md --schema path/to/.mdschema.yml

Troubleshooting

If you encounter issues, check that Go is in your PATH.

Next Steps

Explore more advanced schema features in the documentation.