1# GFM Spec Test Fixture 2 3`spec.txt` is the authoritative test document for GitHub Flavored Markdown 4(GFM). It combines CommonMark's test examples with GFM-specific extensions 5(tables, strikethrough, task lists, autolink extension, disallowed raw HTML) 6in a single fenced-example file. 7 8## Upstream 9 10- Project: https://github.com/github/cmark-gfm 11- Source path: `test/spec.txt` 12- Pinned commit: `587a12bb54d95ac37241377e6ddc93ea0e45439b` (2023-07-21) 13- Spec version: 0.29 (date: 2019-04-06, as recorded in the file header) 14- License: CC-BY-SA 4.0 (see `LICENSE` in this directory) 15 16## Re-syncing 17 18``` 19curl -fsSL -o spec.txt https://raw.githubusercontent.com/github/cmark-gfm/<COMMIT>/test/spec.txt 20``` 21 22Update this README's pinned-commit line and re-run the suite. Example numbers 23may shift between versions — adjust `skip.php` entries accordingly. 24 25## License note 26 27This fixture is included under CC-BY-SA 4.0 — a share-alike license separate 28from DokuWiki's GPLv2. The two coexist cleanly because this file lives in 29its own directory with its own `LICENSE`, is test data (not compiled into 30shipped binaries), and is preserved verbatim with attribution. Any 31modifications to the fixture itself would have to remain CC-BY-SA 4.0 — 32but modifications aren't expected; the file is treated as upstream-owned. 33 34## Usage 35 36`SpecReader` (`../../SpecReader.php`) parses this file's fenced-example blocks 37into individual test records. `GfmSpecTest` uses the reader as a data 38provider. Deliberately out-of-scope examples are listed in `skip.php` with a 39short reason each. 40