# Sample Project README

A realistic Markdown test file for testing Markdown parsers, renderers,
static site generators, and documentation pipelines.

> This file covers the most common Markdown syntax elements so your
> renderer exercises headings, lists, tables, code blocks, and more.

## Features

- GFM-compatible tables and task lists
- Fenced code blocks with language tags
- Blockquotes, nested lists, and links

## Installation

```bash
git clone https://github.com/example/sample-project.git
cd sample-project
npm install
```

## Usage

```javascript
import { build } from 'sample-project';

const result = build({
  input: './src',
  output: './dist',
  minify: true,
});

console.log(result.summary);
```

## Configuration

| Option    | Type      | Default | Description                  |
| --------- | --------- | ------- | ---------------------------- |
| `input`   | `string`  | `./src` | Source directory             |
| `output`  | `string`  | `./dist`| Build output directory       |
| `minify`  | `boolean` | `false` | Minify the output            |
| `verbose` | `boolean` | `false` | Print detailed build logs    |

## Task List

- [x] Set up repository
- [x] Write documentation
- [ ] Add integration tests
- [ ] Publish v1.0.0

## Notes

1. Markdown files use the `.md` extension
2. This file is plain text — safe for any pipeline
3. See also `sample.md` for a syntax-focused sample

---

Licensed for testing and educational use. No attribution required.