pax_global_header00006660000000000000000000000064151771000520014510gustar00rootroot0000000000000052 comment=36c5f547144df2d01970a5792d68c71a3380b227 markdown-it-py-4.2.0/000077500000000000000000000000001517710005200143755ustar00rootroot00000000000000markdown-it-py-4.2.0/.github/000077500000000000000000000000001517710005200157355ustar00rootroot00000000000000markdown-it-py-4.2.0/.github/ISSUE_TEMPLATE/000077500000000000000000000000001517710005200201205ustar00rootroot00000000000000markdown-it-py-4.2.0/.github/ISSUE_TEMPLATE/bug_report.yml000066400000000000000000000032051517710005200230130ustar00rootroot00000000000000name: Report a problem 🐛 description: Problem reports are for when something behaves incorrectly, or differently from how you'd expect. labels: [bug] body: - type: textarea id: describe attributes: label: Describe the bug description: | Provide a short description (one or two sentences) about the problem. What did you expect to happen, and what is actually happening? If possible, provide screenshots or error messages that you've encountered. value: | **context** When I do ___. **expectation** I expected ___ to occur. **bug** But instead ___ happens Here's an error message I ran into... **problem** This is a problem for people doing ___ because ___. validations: required: true - type: textarea id: reproduce attributes: label: Reproduce the bug description: | Provide information that others may use to re-produce this behavior. For example: - Step-by-step instructions that others can follow. - Links to a website that demonstrates the bug. - Information about certain conditions that the bug pops up. placeholder: | 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error validations: required: true - type: textarea id: environment attributes: label: List your environment description: | List the environment needed to reproduce the error. Here are a few ideas: - Version of markdown-it-py - Versions of mdit-py-plugins - The version of Python you're using. - Your operating system validations: required: false markdown-it-py-4.2.0/.github/ISSUE_TEMPLATE/config.yml000066400000000000000000000003501517710005200221060ustar00rootroot00000000000000contact_links: - name: Questions or general discussion ❓🗣️ url: https://github.com/executablebooks/markdown-it-py/discussions about: Use Disussions for general conversations that aren't meant for actionable Issues. markdown-it-py-4.2.0/.github/ISSUE_TEMPLATE/enhancement.yml000066400000000000000000000022001517710005200231220ustar00rootroot00000000000000name: Request an enhancement 💡 description: Suggest an idea for this project labels: [enhancement] body: - type: textarea id: context attributes: label: Context description: | - Provide background to help others understand this issue. - Describe the problem or need you'd like to address. validations: required: true - type: textarea id: proposal attributes: label: Proposal description: | - A simple and clear description of what you're proposing. - Ideas or constraints for how to implement this proposal - Important considerations to think about or discuss validations: required: false - type: textarea id: tasks attributes: label: Tasks and updates description: | Use this area to track ongoing work and to-do items. The more specific the better. _If you can't think of anything then just leave this blank and we can fill it in later! This can be filled in as we understand more about an issue._ placeholder: | - [ ] Discuss and decide on what to do... - [ ] Implement partial feature A... validations: required: false markdown-it-py-4.2.0/.github/dependabot.yml000066400000000000000000000011261517710005200205650ustar00rootroot00000000000000# To get started with Dependabot version updates, you'll need to specify which # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates version: 2 updates: - package-ecosystem: github-actions directory: / commit-message: prefix: ⬆️ schedule: interval: weekly - package-ecosystem: pip directory: / commit-message: prefix: ⬆️ schedule: interval: weekly markdown-it-py-4.2.0/.github/workflows/000077500000000000000000000000001517710005200177725ustar00rootroot00000000000000markdown-it-py-4.2.0/.github/workflows/benchmark.yml000066400000000000000000000022221517710005200224450ustar00rootroot00000000000000name: benchmark on: push: branches: [master] jobs: benchmark-packages: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v5 with: python-version: "3.10" - name: install pandoc uses: r-lib/actions/setup-pandoc@v2 with: pandoc-version: '2.6' - name: Install tox run: | python -m pip install --upgrade pip pip install tox - name: Run package benchmarks run: tox -e py310-bench-packages -- --benchmark-min-rounds 20 --benchmark-json bench-packages.json # - name: Upload package data # uses: actions/upload-artifact@v3 # with: # name: bench-packages # path: bench-packages.json # if-no-files-found: error - name: Store benchmark result uses: aiidateam/github-action-benchmark@v3 with: name: Parsing Benchmarks output-file-path: bench-packages.json github-token: ${{ secrets.GITHUB_TOKEN }} auto-push: true commit-msg-append: "[ci skip]" one-chart-groups: packages,plugins fail-on-alert: false markdown-it-py-4.2.0/.github/workflows/copilot-setup-steps.yml000066400000000000000000000013031517710005200244550ustar00rootroot00000000000000name: Copilot Setup Steps on: workflow_dispatch: push: paths: - .github/workflows/copilot-setup-steps.yml pull_request: paths: - .github/workflows/copilot-setup-steps.yml jobs: copilot-setup-steps: runs-on: ubuntu-latest permissions: contents: read steps: - name: Checkout code uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v5 with: python-version: "3.11" cache: pip - name: Install uv run: pip install uv - name: Install pre-commit and pre-commit-uv run: pip install pre-commit pre-commit-uv - name: Install tox and tox-uv run: pip install tox tox-uv markdown-it-py-4.2.0/.github/workflows/fuzz.yml000066400000000000000000000022301517710005200215100ustar00rootroot00000000000000name: fuzzing # This action runs fuzzing for a brief period of time, # only aginst the actual code added in the PR. # It is intended a relatively quick check, # to guard against code introducing crashes in the Markdown parsing, # which should in principle always run against any text input. # See: https://google.github.io/oss-fuzz/getting-started/continuous-integration/#how-it-works # Note, to reproduce a crash locally, copy to `testcase` file` and run: `tox -e fuzz` on: pull_request: paths-ignore: ['docs/**', 'tests/**'] jobs: Fuzzing: runs-on: ubuntu-latest steps: - name: Build Fuzzers id: build uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master with: oss-fuzz-project-name: 'markdown-it-py' language: python - name: Run Fuzzers uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master with: oss-fuzz-project-name: 'markdown-it-py' language: python fuzz-seconds: 60 - name: Upload Crash uses: actions/upload-artifact@v4 if: failure() && steps.build.outcome == 'success' with: name: artifacts path: ./out/artifacts markdown-it-py-4.2.0/.github/workflows/tests.yml000066400000000000000000000071601517710005200216630ustar00rootroot00000000000000# This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: continuous-integration on: push: branches: [master] tags: - "v[0-9]+.[0-9]+.[0-9]+*" pull_request: schedule: - cron: '0 0 * * 0' # every week jobs: pre-commit: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v5 with: python-version: '3.10' - uses: pre-commit/action@v3.0.1 tests: runs-on: ubuntu-latest strategy: fail-fast: false matrix: python-version: ['pypy-3.10', '3.10', '3.11', '3.12', '3.13'] steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} allow-prereleases: true - name: Install dependencies run: | python -m pip install --upgrade pip pip install -e .[testing,linkify] - name: Check spec file is up to date run: | python tests/test_cmark_spec/get_cmark_spec.py - name: Run pytest run: | pytest tests/ --cov=markdown_it --cov-report=xml --cov-report=term-missing - name: Upload to Codecov if: matrix.python-version == '3.10' && github.repository == 'executablebooks/markdown-it-py' uses: codecov/codecov-action@v5 with: name: markdown-it-py-pytests flags: pytests files: ./coverage.xml fail_ci_if_error: true token: ${{ secrets.CODECOV_TOKEN }} test-plugins: runs-on: ubuntu-latest strategy: matrix: python-version: ['3.10'] steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install markdown-it-py run: | python -m pip install --upgrade pip pip install .[testing] - name: clone and install mdit-py-plugins run: | git clone https://github.com/executablebooks/mdit-py-plugins.git pip install --no-deps -e mdit-py-plugins - name: Run pytest for unit tests of mdit-py-plugins run: cd mdit-py-plugins; pytest benchmark: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v5 with: python-version: '3.10' - name: Install tox run: | python -m pip install --upgrade pip pip install tox - name: Run benchmark run: tox -e py310-bench-core -- --benchmark-json bench-core.json - name: Upload data uses: actions/upload-artifact@v4 with: name: bench-core path: bench-core.json if-no-files-found: error publish: name: Publish to PyPi needs: [pre-commit, tests] if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') runs-on: ubuntu-latest steps: - name: Checkout source uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v5 with: python-version: '3.10' - name: install flit run: | pip install flit~=3.4 - name: Build and publish run: | flit publish env: FLIT_USERNAME: __token__ FLIT_PASSWORD: ${{ secrets.PYPI_KEY }} allgood: runs-on: ubuntu-latest needs: - pre-commit - tests steps: - run: echo "Great success!" markdown-it-py-4.2.0/.gitignore000066400000000000000000000036231517710005200163710ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ pip-wheel-metadata/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json # Pyre type checker .pyre/ benchmark/extra/ node_modules/ coverage/ demo/ apidoc/ *.log __pycache__/ .ropeproject/ *.egg-info/ .vscode/ .DS_Store docs/api/ uv.lock markdown-it-py-4.2.0/.pre-commit-config.yaml000066400000000000000000000015461517710005200206640ustar00rootroot00000000000000# Install pre-commit hooks via # pre-commit install exclude: > (?x)^( \.vscode/settings\.json| test.*\.md| test.*\.txt| test.*\.html| test.*\.xml| .*commonmark\.json| benchmark/.*\.md| .*/spec\.md )$ repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v6.0.0 hooks: - id: check-json - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.15.12 hooks: - id: ruff args: [--fix] - id: ruff-format - repo: https://github.com/pre-commit/mirrors-mypy rev: v1.20.2 hooks: - id: mypy additional_dependencies: [mdurl, typing-extensions] exclude: > (?x)^( benchmarking/.*\.py| docs/.*\.py| scripts/.*\.py| )$ markdown-it-py-4.2.0/.readthedocs.yml000066400000000000000000000004651517710005200174700ustar00rootroot00000000000000version: 2 build: os: ubuntu-22.04 tools: python: "3.10" python: install: - requirements: docs/requirements.txt - method: pip path: . extra_requirements: - linkify - rtd sphinx: configuration: docs/conf.py builder: html fail_on_warning: true markdown-it-py-4.2.0/AGENTS.md000066400000000000000000000341621517710005200157060ustar00rootroot00000000000000# AGENTS.md This file provides guidance for AI coding agents working on the **markdown-it-py** repository. ## Project Overview markdown-it-py is a Python port of [markdown-it](https://github.com/markdown-it/markdown-it), the JavaScript Markdown parser. It provides: - A Markdown parser following the [CommonMark spec](https://commonmark.org/) - Configurable syntax: you can add new rules and even replace existing ones - Pluggable architecture with support for syntax extensions (see [mdit-py-plugins](https://github.com/executablebooks/mdit-py-plugins)) - High performance with efficient parsing algorithms - Safe by default with configurable HTML handling markdown-it-py is designed as a foundation for projects requiring robust Markdown parsing in Python, with the same design principles as the original JavaScript implementation. ## Repository Structure ``` pyproject.toml # Project configuration and dependencies (flit) tox.ini # Tox test environment configuration (use with tox-uv for faster env creation) markdown_it/ # Main source code ├── __init__.py # Package init ├── main.py # MarkdownIt main class ├── token.py # Token dataclass ├── ruler.py # Ruler class for managing rules ├── tree.py # SyntaxTreeNode for AST representation ├── renderer.py # RendererHTML and RendererProtocol ├── parser_core.py # ParserCore - top-level rules executor ├── parser_block.py # ParserBlock - block-level tokenizer ├── parser_inline.py # ParserInline - inline tokenizer ├── utils.py # Utility types (OptionsType, PresetType, etc.) ├── common/ # Common utilities ├── helpers/ # Helper functions ├── presets/ # Configuration presets (commonmark, gfm-like, zero, etc.) ├── rules_core/ # Core parsing rules ├── rules_block/ # Block-level parsing rules ├── rules_inline/ # Inline parsing rules ├── cli/ # Command-line interface └── py.typed # PEP 561 marker tests/ # Test suite ├── test_api/ # API tests ├── test_cmark_spec/ # CommonMark spec compliance tests ├── test_port/ # Port-specific tests ├── test_tree/ # SyntaxTreeNode tests ├── fuzz/ # Fuzzing tests for OSS-Fuzz ├── test_cli.py # CLI tests ├── test_linkify.py # Linkify tests └── test_tree.py # Tree tests docs/ # Documentation source ├── conf.py # Sphinx configuration ├── index.md # Documentation index ├── architecture.md # Design principles ├── using.md # Usage guide ├── plugins.md # Plugin documentation ├── contributing.md # Contributing guide ├── performance.md # Performance benchmarks └── security.md # Security considerations benchmarking/ # Performance benchmarking scripts/ # Utility scripts ``` ## Development Commands All commands should be run via [`tox`](https://tox.wiki) for consistency. The project uses `tox-uv` for faster environment creation. ### Testing ```bash # Run all tests tox # Run tests with specific Python version tox -e py311 # Run tests with plugins tox -e py311-plugins # Run a specific test file tox -- tests/test_api/test_main.py # Run a specific test function tox -- tests/test_api/test_main.py::test_get_rules # Run tests with coverage tox -- --cov=markdown_it --cov-report=html ``` ### Documentation ```bash # Build docs (clean) tox -e docs-clean # Build docs (incremental) tox -e docs-update # Specific builder (e.g., linkcheck) BUILDER=linkcheck tox -e docs-update ``` ### Benchmarking and Profiling ```bash # Run core benchmarks tox -e py311-bench-core # Run package comparison benchmarks tox -e py311-bench-packages # Run profiler tox -e profile ``` ### Fuzzing ```bash # Run fuzzer on testcase file tox -e fuzz path/to/testcase ``` ### Code Quality ```bash # Run pre-commit hooks on all files pre-commit run --all-files # Type checking (via pre-commit) pre-commit run mypy --all-files # Linting and formatting (via pre-commit) pre-commit run ruff --all-files pre-commit run ruff-format --all-files ``` ## Code Style Guidelines - **Formatter/Linter**: Ruff (configured in `pyproject.toml`) - **Type Checking**: Mypy with strict settings (configured in `pyproject.toml`) - **Pre-commit**: Use pre-commit hooks for consistent code style (`.pre-commit-config.yaml`) ### Best Practices - **Type annotations**: Use complete type annotations for all function signatures. The codebase uses strict mypy settings. - **Docstrings**: Use Google-style or Sphinx-style docstrings. Types are not required in docstrings as they should be in type hints. - **Pure functions**: Where possible, write pure functions without side effects. - **Immutability**: Prefer immutable data structures. The `Token` class uses dataclass with appropriate mutability. - **Testing**: Write tests for all new functionality. Use `pytest-regressions` for output comparison tests. ### Type Annotation Example ```python from __future__ import annotations from typing import Sequence def parse_blocks( state: StateBlock, start_line: int, end_line: int, silent: bool = False ) -> bool: """Parse block-level content. :param state: The parser state object :param start_line: Starting line number :param end_line: Ending line number :param silent: If True, only validate without generating tokens :return: True if parsing succeeded """ ... ``` ## Architecture Overview ### Parsing Pipeline markdown-it-py follows a multi-stage parsing pipeline: ``` Markdown → Tokens → HTML ``` The parsing happens through three nested chains: 1. **Core Chain** (`parser_core.py`): Top-level rules that orchestrate the parsing 2. **Block Chain** (`parser_block.py`): Parse block-level content (headings, lists, code blocks, etc.) 3. **Inline Chain** (`parser_inline.py`): Parse inline content (emphasis, links, code spans, etc.) ### Token Stream Instead of a traditional AST, markdown-it-py uses a **token stream** representation: - Tokens are a simple sequence (list) - Opening and closing tags are separate tokens - Inline containers have nested tokens in their `.children` property - This design follows the KISS principle and allows easy manipulation ### Key Components #### MarkdownIt Class (`main.py`) The main entry point for parsing: - `parse()`: Parse markdown and return token stream - `render()`: Parse and render to HTML - `use()`: Add plugins - `enable()` / `disable()`: Control rules - `set()`: Set options #### Ruler Class (`ruler.py`) Manages parsing rules: - Rules can be enabled/disabled by name - Rules can be inserted at specific positions - Each parser (core/block/inline) has its own Ruler instance #### Token Class (`token.py`) Represents a single token in the stream: - `type`: Token type (e.g., "paragraph_open", "text", "heading_close") - `tag`: HTML tag to use for rendering - `attrs`: Attributes for the HTML tag - `content`: Raw content - `children`: Nested tokens for inline containers - `level`: Nesting level #### Renderer (`renderer.py`) Converts token stream to HTML: - `render()`: Convert full token stream to HTML - `renderToken()`: Render a single token - Custom render rules can be added via `add_render_rule()` ### Data Flow ``` Input Markdown ↓ Core Rules (normalize, etc.) ↓ Block Parser → Block Tokens ↓ Core Rules (intermediate) ↓ Inline Parser → Inline Tokens (for each block token with "inline" type) ↓ Core Rules (final: abbreviations, footnotes, linkify, etc.) ↓ Token Stream ↓ Renderer ↓ HTML Output ``` ## Testing Guidelines ### Test Structure - Tests use `pytest` with fixtures from `conftest.py` files - CommonMark spec tests are in `tests/test_cmark_spec/` - Port-specific tests verify JavaScript markdown-it parity - Regression testing uses `pytest-regressions` for output comparison - Fuzzing tests are in `tests/fuzz/` for integration with OSS-Fuzz ### Writing Tests 1. For API tests, add to appropriate file in `tests/test_api/` 2. For new syntax/rules, add test cases to `tests/test_port/` 3. For CommonMark compliance, run the spec test updater 4. Use `file_regression` fixture for comparing output against stored fixtures 5. Use parameterization for multiple test scenarios ### Test Best Practices - **Test coverage**: Write tests for all new functionality and bug fixes - **Isolation**: Each test should be independent - **Descriptive names**: Test function names should describe what is being tested - **Regression testing**: Use `file_regression.check()` for complex output comparisons - **Parametrization**: Use `@pytest.mark.parametrize` for multiple test scenarios ### Example Test Pattern ```python import pytest from markdown_it import MarkdownIt def test_basic_parsing(): md = MarkdownIt() result = md.render("# Heading\n\nParagraph") assert "

Heading

" in result assert "

Paragraph

" in result @pytest.mark.parametrize( "input_text,expected", [ ("**bold**", "bold"), ("*italic*", "italic"), ] ) def test_emphasis(input_text, expected): md = MarkdownIt() result = md.render(input_text) assert expected in result ``` ## Commit Message Format Use this format: ``` : Summarize in 72 chars or less (#) Optional detailed explanation. ``` Keywords: - `✨ NEW:` – New feature - `🐛 FIX:` – Bug fix - `👌 IMPROVE:` – Improvement (no breaking changes) - `‼️ BREAKING:` – Breaking change - `📚 DOCS:` – Documentation - `🔧 MAINTAIN:` – Maintenance changes only (typos, etc.) - `🧪 TEST:` – Tests or CI changes only - `♻️ REFACTOR:` – Refactoring ## PR Title and Description Format Use the same as for the commit message format, but for the title you can omit the `KEYWORD` and only use `EMOJI`. ## Pull Request Requirements When submitting changes: 1. **Description**: Include a meaningful description or link explaining the change 2. **Tests**: Include test cases for new functionality or bug fixes 3. **Documentation**: Update docs if behavior changes or new features are added 4. **Changelog**: Update `CHANGELOG.md` under the appropriate section 5. **Code Quality**: Ensure `pre-commit run --all-files` passes 6. **Type Checking**: Ensure mypy passes with strict settings 7. **CommonMark Compliance**: Don't break existing CommonMark spec tests unless intentional ## Key Files - `pyproject.toml` - Project configuration, dependencies, and tool settings (Ruff, Mypy) - `tox.ini` - Test environment configuration - `markdown_it/main.py` - `MarkdownIt` main class - `markdown_it/token.py` - `Token` dataclass - `markdown_it/renderer.py` - HTML renderer - `markdown_it/parser_core.py` - Core parsing rules - `markdown_it/parser_block.py` - Block-level parser - `markdown_it/parser_inline.py` - Inline parser - `markdown_it/ruler.py` - `Ruler` class for managing rules - `markdown_it/utils.py` - Type definitions and utilities - `markdown_it/presets/` - Configuration presets (commonmark, gfm-like, zero) ## Debugging - Use the CLI with `markdown-it` command to test parsing interactively - Check token stream with `md.parse(text)` to see tokens before rendering - Use `md.render(text)` to see final HTML output - Enable specific rules with `md.enable(['rule_name'])` - Disable rules with `md.disable(['rule_name'])` - Use `tox -- -v --tb=long` for verbose test output with full tracebacks - Check the [Live demo](https://markdown-it.github.io/) (JavaScript version) to compare behavior ### Debugging Tips ```python from markdown_it import MarkdownIt md = MarkdownIt() # See the token stream tokens = md.parse("# Heading\n\nParagraph") for token in tokens: print(f"{token.type} | {token.tag} | {token.content}") # See available rules print(md.get_all_rules()) # Enable/disable specific rules md.disable(['emphasis']) result = md.render("*text*") # Won't be emphasized ``` ## Common Patterns ### Adding a New Parsing Rule 1. Determine which parser the rule belongs to (core/block/inline) 2. Create rule function in appropriate `rules_*/` directory 3. Rule signature for block rules: ```python def rule_name(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool: ... ``` 4. Rule signature for inline rules: ```python def rule_name(state: StateInline, silent: bool) -> bool: ... ``` 5. Register the rule in the appropriate parser's `__init__` method 6. Add tests for the new rule 7. Update documentation if it's a user-facing feature ### Creating a Plugin 1. Create a plugin function that receives the `MarkdownIt` instance: ```python def my_plugin(md: MarkdownIt, **options): """My custom plugin.""" # Add rules md.block.ruler.before("fence", "my_block_rule", my_block_rule) md.inline.ruler.after("emphasis", "my_inline_rule", my_inline_rule) # Add render rules md.add_render_rule("my_token_type", render_my_token) ``` 2. Use the plugin with `md.use(my_plugin, option1=value1)` 3. See existing plugins in [mdit-py-plugins](https://github.com/executablebooks/mdit-py-plugins) for examples ### Customizing Rendering ```python from markdown_it import MarkdownIt def render_custom_link(self, tokens, idx, options, env): tokens[idx].attrSet("target", "_blank") tokens[idx].attrSet("rel", "noopener noreferrer") return self.renderToken(tokens, idx, options, env) md = MarkdownIt() md.add_render_rule("link_open", render_custom_link) ``` ## Reference Documentation - [markdown-it-py Documentation](https://markdown-it-py.readthedocs.io/) - [markdown-it-py Repository](https://github.com/executablebooks/markdown-it-py) - [Original markdown-it (JavaScript)](https://github.com/markdown-it/markdown-it) - [markdown-it Live Demo](https://markdown-it.github.io/) - Useful for comparing behavior - [CommonMark Spec](https://spec.commonmark.org/) - [mdit-py-plugins Repository](https://github.com/executablebooks/mdit-py-plugins) - [Python Type Hints (PEP 484)](https://peps.python.org/pep-0484/) markdown-it-py-4.2.0/CHANGELOG.md000066400000000000000000000456061517710005200162210ustar00rootroot00000000000000# Change Log ## 4.2.0 - 2026-05-07 * ✨ Add `make_fence_rule()` factory for configurable fence markers in [#394](https://github.com/executablebooks/markdown-it-py/pull/394) ## 4.1.0 - 2025-05-06 * ✨ Add `gfm-like2` preset with task lists, alerts, and single-tilde strikethrough core plugins in [#388](https://github.com/executablebooks/markdown-it-py/pull/388) * ✨ Allow plugins to register inline terminator characters in [#391](https://github.com/executablebooks/markdown-it-py/pull/391) * 👌 Fix quadratic complexity in `fragments_join` / `text_join` in [#389](https://github.com/executablebooks/markdown-it-py/pull/389), thanks to [@petricevich](https://github.com/petricevich) * 👌 Add `--stdin` option to CLI for reading Markdown from standard input in [#379](https://github.com/executablebooks/markdown-it-py/pull/379), thanks to [@mcepl](https://github.com/mcepl) * 🔧 Add typing to Scanner in [#382](https://github.com/executablebooks/markdown-it-py/pull/382), thanks to [@Alunderin](https://github.com/Alunderin) **Full Changelog**: ## 4.0.0 - 2024-08-10 This primarily drops support for Python 3.9, adds support for Python 3.13, and updates the parser to comply with Commonmark 0.31.2 and Markdown-It v14.1.0. * ⬆️ Drop support for Python 3.9 in [#360](https://github.com/executablebooks/markdown-it-py/pull/360) * ⬆️ Comply with Commonmark 0.31.2 in [#362](https://github.com/executablebooks/markdown-it-py/pull/362) * 👌 Improve performance of "text" inline rule in [#347](https://github.com/executablebooks/markdown-it-py/pull/347) * 👌 Use `str.removesuffix` in [#348](https://github.com/executablebooks/markdown-it-py/pull/348) * 👌 limit the number of autocompleted cells in a table in [#364](https://github.com/executablebooks/markdown-it-py/pull/364) * 👌 fix quadratic complexity in reference parser in [#367](https://github.com/executablebooks/markdown-it-py/pull/367) * 🐛 Fix emphasis inside raw links bugs in [#320](https://github.com/executablebooks/markdown-it-py/pull/320) **Full Changelog**: ## 3.0.0 - 2023-06-03 ⚠️ This release contains some minor breaking changes in the internal API and improvements to the parsing strictness. **Full Changelog**: ### ⬆️ UPGRADE: Drop support for Python 3.7 Also add testing for Python 3.11 ### ⬆️ UPGRADE: Update from upstream markdown-it `12.2.0` to `13.0.0` A key change is the addition of a new `Token` type, `text_special`, which is used to represent HTML entities and backslash escaped characters. This ensures that (core) typographic transformation rules are not incorrectly applied to these texts. The final core rule is now the new `text_join` rule, which joins adjacent `text`/`text_special` tokens, and so no `text_special` tokens should be present in the final token stream. Any custom typographic rules should be inserted before `text_join`. A new `linkify` rule has also been added to the inline chain, which will linkify full URLs (e.g. `https://example.com`), and fixes collision of emphasis and linkifier (so `http://example.org/foo._bar_-_baz` is now a single link, not emphasized). Emails and fuzzy links are not affected by this. * ♻️ Refactor backslash escape logic, add `text_special` [#276](https://github.com/executablebooks/markdown-it-py/pull/276) * ♻️ Parse entities to `text_special` token [#280](https://github.com/executablebooks/markdown-it-py/pull/280) * ♻️ Refactor: Add linkifier rule to inline chain for full links [#279](https://github.com/executablebooks/markdown-it-py/pull/279) * ‼️ Remove `(p)` => `§` replacement in typographer [#281](https://github.com/executablebooks/markdown-it-py/pull/281) * ‼️ Remove unused `silent` arg in `ParserBlock.tokenize` [#284](https://github.com/executablebooks/markdown-it-py/pull/284) * 🐛 FIX: numeric character reference passing [#272](https://github.com/executablebooks/markdown-it-py/pull/272) * 🐛 Fix: tab preventing paragraph continuation in lists [#274](https://github.com/executablebooks/markdown-it-py/pull/274) * 👌 Improve nested emphasis parsing [#273](https://github.com/executablebooks/markdown-it-py/pull/273) * 👌 fix possible ReDOS in newline rule [#275](https://github.com/executablebooks/markdown-it-py/pull/275) * 👌 Improve performance of `skipSpaces`/`skipChars` [#271](https://github.com/executablebooks/markdown-it-py/pull/271) * 👌 Show text of `text_special` in `tree.pretty` [#282](https://github.com/executablebooks/markdown-it-py/pull/282) ### ♻️ REFACTOR: Replace most character code use with strings The use of `StateBase.srcCharCode` is deprecated (with backward-compatibility), and all core uses are replaced by `StateBase.src`. Conversion of source string characters to an integer representing the Unicode character is prevalent in the upstream JavaScript implementation, to improve performance. However, it is unnecessary in Python and leads to harder to read code and performance deprecations (during the conversion in the `StateBase` initialisation). See [#270](https://github.com/executablebooks/markdown-it-py/pull/270), thanks to [@hukkinj1](https://github.com/hukkinj1). ### ♻️ Centralise indented code block tests For CommonMark, the presence of indented code blocks prevent any other block element from having an indent of greater than 4 spaces. Certain Markdown flavors and derivatives, such as mdx and djot, disable these code blocks though, since it is more common to use code fences and/or arbitrary indenting is desirable. Previously, disabling code blocks did not remove the indent limitation, since most block elements had the 3 space limitation hard-coded. This change centralised the logic of applying this limitation (in `StateBlock.is_code_block`), and only applies it when indented code blocks are enabled. This allows for e.g. ```md
I can indent as much as I want here.
``` See [#260](https://github.com/executablebooks/markdown-it-py/pull/260) ### 🔧 Maintenance changes Strict type annotation checking has been applied to the whole code base, [ruff](https://github.com/charliermarsh/ruff) is now used for linting, and fuzzing tests have been added to the CI, to integrate with Google [OSS-Fuzz](https://github.com/google/oss-fuzz/tree/master/projects/markdown-it-py) testing, thanks to [@DavidKorczynski](https://github.com/DavidKorczynski). * 🔧 MAINTAIN: Make type checking strict [#](https://github.com/executablebooks/markdown-it-py/pull/267) * 🔧 Add typing of rule functions [#283](https://github.com/executablebooks/markdown-it-py/pull/283) * 🔧 Move linting from flake8 to ruff [#268](https://github.com/executablebooks/markdown-it-py/pull/268) * 🧪 CI: Add fuzzing workflow for PRs [#262](https://github.com/executablebooks/markdown-it-py/pull/262) * 🔧 Add tox env for fuzz testcase run [#263](https://github.com/executablebooks/markdown-it-py/pull/263) * 🧪 Add OSS-Fuzz set up by @DavidKorczynski in [#255](https://github.com/executablebooks/markdown-it-py/pull/255) * 🧪 Fix fuzzing test failures [#254](https://github.com/executablebooks/markdown-it-py/pull/254) ## 2.2.0 - 2023-02-22 ### What's Changed * ⬆️ UPGRADE: Allow linkify-it-py v2 by @hukkin in [#218](https://github.com/executablebooks/markdown-it-py/pull/218) * 🐛 FIX: CVE-2023-26303 by @chrisjsewell in [#246](https://github.com/executablebooks/markdown-it-py/pull/246) * 🐛 FIX: CLI crash on non-utf8 character by @chrisjsewell in [#247](https://github.com/executablebooks/markdown-it-py/pull/247) * 📚 DOCS: Update the example by @redstoneleo in [#229](https://github.com/executablebooks/markdown-it-py/pull/229) * 📚 DOCS: Add section about markdown renderer by @holamgadol in [#227](https://github.com/executablebooks/markdown-it-py/pull/227) * 🔧 Create SECURITY.md by @chrisjsewell in [#248](https://github.com/executablebooks/markdown-it-py/pull/248) * 🔧 MAINTAIN: Update mypy's additional dependencies by @hukkin in [#217](https://github.com/executablebooks/markdown-it-py/pull/217) * Fix typo by @jwilk in [#230](https://github.com/executablebooks/markdown-it-py/pull/230) * 🔧 Bump GH actions by @chrisjsewell in [#244](https://github.com/executablebooks/markdown-it-py/pull/244) * 🔧 Update benchmark pkg versions by @chrisjsewell in [#245](https://github.com/executablebooks/markdown-it-py/pull/245) ### New Contributors Thanks to 🎉 * @jwilk made their first contribution in [#230](https://github.com/executablebooks/markdown-it-py/pull/230) * @holamgadol made their first contribution in [#227](https://github.com/executablebooks/markdown-it-py/pull/227) * @redstoneleo made their first contribution in [#229](https://github.com/executablebooks/markdown-it-py/pull/229) **Full Changelog**: ## 2.1.0 - 2022-04-15 This release is primarily to replace the `attrs` package dependency, with the built-in Python `dataclasses` package. This should not be a breaking change, for most use cases. - ⬆️ UPGRADE: Drop support for EOL Python 3.6 (#194) - ♻️ REFACTOR: Move `Rule`/`Delimiter` classes from `attrs` to `dataclass` (#211) - ♻️ REFACTOR: Move `Token` class from `attrs` to `dataclass` (#211) - ‼️ Remove deprecated `NestedTokens` and `nest_tokens` - ✨ NEW: Save ordered list numbering (#192) - 🐛 FIX: Combination of blockquotes, list and newlines causes `IndexError` (#207) ## 2.0.1 - 2022-24-01 - 🐛 FIX: Crash when file ends with empty blockquote line. - ✨ NEW: Add `inline_definitions` option. This option allows for `definition` token to be inserted into the token stream, at the point where the definition is located in the source text. It is useful for cases where one wishes to capture a "loseless" syntax tree of the parsed Markdown (in conjunction with the `store_labels` option). ## 2.0.0 - 2021-12-03 - ⬆️ Update: Sync with markdown-it v12.1.0 and CommonMark v0.30 - ♻️ REFACTOR: Port `mdurl` and `punycode` for URL normalisation (thanks to @hukkin!). This port fixes the outstanding CommonMark compliance tests. - ♻️ REFACTOR: Remove `AttrDict`. This is no longer used is core or mdit-py-plugins, instead standard dictionaries are used. - 👌 IMPROVE: Use `__all__` to signal re-exports ## 1.1.0 - 2021-05-08 ⬆️ UPGRADE: `attrs` -> v21 (#165) This release has no breaking changes (see: ) ## 1.0.0 - 2021-05-02 [Full commit log](https://github.com/executablebooks/markdown-it-py/compare/v0.6.2...v1.0.0) The first stable release of markdown-it-py 🎉 See the changes in the beta releases below, thanks to all the [contributors](https://github.com/executablebooks/markdown-it-py/graphs/contributors?from=2020-03-22&to=2021-05-02&type=c) in the last year! ## 1.0.0b3 - 2021-05-01 - 👌 IMPROVE: Add `RendererProtocol` type, for typing renderers (thanks to [@hukkinj1](https://github.com/hukkinj1)) - 🔧 MAINTAIN: `None` is no longer allowed as a valid `src` input for `StateBase` subclasses ## 1.0.0b2 - 2021-04-25 ‼️ BREAKING: Move `mdit-py-plugins` out of the core install requirements and into a `plugins` extra. Synchronised code with the upstream Markdown-It `v12.0.6`: - 🐛 FIX: Raise HTML blocks priority to resolve conflict with headings - 🐛 FIX: Newline not rendered in image alt attribute ## 1.0.0b1 - 2021-03-31 [Full commit log](https://github.com/executablebooks/markdown-it-py/compare/v0.6.2...9ecda04) This is the first beta release of the stable v1.x series. There are four notable (and breaking) changes: 1. The code has been synchronised with the upstream Markdown-It `v12.0.4`. In particular, this update alters the parsing of tables to be consistent with the GFM specification: A number of parsing performance and validation improvements are also included. 2. `Token.attrs` are now stored as dictionaries, rather than a list of lists. This is a departure from upstream Markdown-It, allowed by Pythons guarantee of ordered dictionaries (see [#142](https://github.com/markdown-it/markdown-it/issues/142)), and is the more natural representation. Note `attrGet`, `attrSet`, `attrPush` and `attrJoin` methods remain identical to those upstream, and `Token.as_dict(as_upstream=True)` will convert the token back to a directly comparable dict. 3. The use of `AttrDict` has been replaced: For `env` any Python mutable mapping is now allowed, and so attribute access to keys is not (differing from the Javascript dictionary). For `MarkdownIt.options` it is now set as an `OptionsDict`, which is a dictionary sub-class, with attribute access only for core MarkdownIt configuration keys. 4. Introduction of the `SyntaxTreeNode`. This is a more comprehensive replacement for `nest_tokens` and `NestedTokens` (which are now deprecated). It allows for the `Token` stream to be converted to/from a nested tree structure, with opening/closing tokens collapsed into a single `SyntaxTreeNode` and the intermediate tokens set as children. See [Creating a syntax tree](https://markdown-it-py.readthedocs.io/en/latest/using.html#creating-a-syntax-tree) documentation for details. ### Additional Fixes 🐛 - Fix exception due to empty lines after blockquote+footnote - Fix linkify link nesting levels - Fix the use of `Ruler.at` for plugins - Avoid fenced token mutations during rendering - Fix CLI version info and correct return of exit codes ## 0.6.2 - 2021-02-07 This release brings Markdown-It-Py inline with Markdown-It v11.0.1 (2020-09-14), applying two fixes: - Fix blockquote lazy newlines, [[#696](https://github.com/markdown-it/markdown-it/issues/696)]. - Fix missed mappings for table rows, [[#705](https://github.com/markdown-it/markdown-it/issues/705)]. Thanks to [@hukkinj1](https://github.com/hukkinj1)! ## 0.6.1 - 2021-01-01 This release provides some improvements to the code base: - 🐛 FIX: Do not resolve backslash escapes inside auto-links - 🐛 FIX: Add content to image tokens - 👌 IMPROVE: Add more type annotations, thanks to [@hukkinj1](https://github.com/hukkinj1) ## 0.6.0 - 2020-12-15 🗑 DEPRECATE: Move plugins to `mdit_py_plugins` Plugins (in `markdown_it.extensions`) have now been moved to [executablebooks/mdit-py-plugins](https://github.com/executablebooks/mdit-py-plugins). This will allow for their maintenance to occur on a different cycle to the core code, facilitating the release of a v1.0.0 for this package 🔧 MAINTAIN: Add [mypy](https://mypy.readthedocs.io) type-checking, thanks to [@hukkinj1](https://github.com/hukkinj1). ## 0.5.8 - 2020-12-13 ✨ NEW: Add linkify, thanks to [@tsutsu3](https://github.com/tsutsu3). This extension uses [linkify-it-py](https://github.com/tsutsu3/linkify-it-py) to identify URL links within text: - `github.com` -> `github.com` **Important:** To use this extension you must install linkify-it-py; `pip install markdown-it-py[linkify]` It can then be activated by: ```python from markdown_it import MarkdownIt md = MarkdownIt().enable("linkify") md.options["linkify"] = True ``` ## 0.5.7 - 2020-12-13 ✨ NEW: Add smartquotes, thanks to [@tsutsu3](https://github.com/tsutsu3). This extension will convert basic quote marks to their opening and closing variants: - 'single quotes' -> ‘single quotes’ - "double quotes" -> “double quotes” It can be activated by: ```python from markdown_it import MarkdownIt md = MarkdownIt().enable("smartquotes") md.options["typographer"] = True ``` ✨ NEW: Add markdown-it-task-lists plugin, thanks to [@wna-se](https://github.com/wna-se). This is a port of the JS [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists), for building task/todo lists out of markdown lists with items starting with `[ ]` or `[x]`. For example: ```markdown - [ ] An item that needs doing - [x] An item that is complete ``` This plugin can be activated by: ```python from markdown_it import MarkdownIt from markdown_it.extensions.tasklists import tasklists_plugin md = MarkdownIt().use(tasklists_plugin) ``` 🐛 Various bug fixes, thanks to [@hukkinj1](https://github.com/hukkinj1): - Do not copy empty `env` arg in `MarkdownIt.render` - `_Entities.__contains__` fix return data - Parsing of unicode ordinals - Handling of final character in `skipSpacesBack` and `skipCharsBack` methods - Avoid exception when document ends in heading/blockquote marker 🧪 TESTS: Add CI for Python 3.9 and PyPy3 ## 0.5.6 - 2020-10-21 - ✨ NEW: Add simple typographic replacements, thanks to [@tsutsu3](https://github.com/tsutsu3): This allows you to add the `typographer` option to the parser, to replace particular text constructs: - ``(c)``, ``(C)`` → © - ``(tm)``, ``(TM)`` → ™ - ``(r)``, ``(R)`` → ® - ``(p)``, ``(P)`` → § - ``+-`` → ± - ``...`` → … - ``?....`` → ?.. - ``!....`` → !.. - ``????????`` → ??? - ``!!!!!`` → !!! - ``,,,`` → , - ``--`` → &ndash - ``---`` → &mdash ```python md = MarkdownIt().enable("replacements") md.options["typographer"] = True ``` - 📚 DOCS: Improve documentation for CLI, thanks to [@westurner](https://github.com/westurner) - 👌 IMPROVE: Use `re.sub()` instead of `re.subn()[0]`, thanks to [@hukkinj1](https://github.com/hukkinj1) - 🐛 FIX: An exception raised by having multiple blank lines at the end of some files ## 0.5.5 - 2020-09-27 👌 IMPROVE: Add `store_labels` option. This allows for storage of original reference label in link/image token's metadata, which can be useful for renderers. ## 0.5.4 - 2020-09-08 ✨ NEW: Add `anchors_plugin` for headers, which can produce: ```html

Title String

``` ## 0.5.3 - 2020-09-04 🐛 Fixed an undefined variable in the reference block. ## 0.5.2 - 2020-08-22 🐛 Fixed an `IndexError` in `container_plugin`, when there is no newline on the closing tag line. ## 0.5.1 - 2020-08-21 ⬆️ UPGRADE: attrs -> v20 This is not breaking, since it only deprecates Python 3.4 (see [CHANGELOG.rst](https://github.com/python-attrs/attrs/blob/master/CHANGELOG.rst)) ## 0.5.0 - 2020-08-18 ### Added ✨ - `deflist` and `dollarmath` plugins (see [plugins list](https://markdown-it-py.readthedocs.io/en/latest/plugins.html)). ### Improved 👌 - Added benchmarking tests and CI (see ) - Improved performance of computing ordinals (=> 10-15% parsing speed increase). Thanks to [@sildar](https://github.com/sildar)! ### Fixed 🐛 - Stopped empty lines at the end of the document, after certain list blocks, raising an exception (#36). - Allow myst-role to accept names containing digits (0-9). ## 0.4.9 - 2020-08-11 ### Added ✨ - `containers` plugin (see [plugins list](https://markdown-it-py.readthedocs.io/en/latest/plugins.html)) ### Documented 📚 - Plugins and improved contributing section markdown-it-py-4.2.0/LICENSE000066400000000000000000000020661517710005200154060ustar00rootroot00000000000000MIT License Copyright (c) 2020 ExecutableBookProject Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. markdown-it-py-4.2.0/LICENSE.markdown-it000066400000000000000000000020611517710005200176340ustar00rootroot00000000000000Copyright (c) 2014 Vitaly Puzrin, Alex Kocharin. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. markdown-it-py-4.2.0/README.md000066400000000000000000000111701517710005200156540ustar00rootroot00000000000000# markdown-it-py [![Github-CI][github-ci]][github-link] [![Coverage Status][codecov-badge]][codecov-link] [![PyPI][pypi-badge]][pypi-link] [![Conda][conda-badge]][conda-link] [![PyPI - Downloads][install-badge]][install-link]

markdown-it-py icon

> Markdown parser done right. - Follows the __[CommonMark spec](http://spec.commonmark.org/)__ for baseline parsing - Configurable syntax: you can add new rules and even replace existing ones. - Pluggable: Adds syntax extensions to extend the parser (see the [plugin list][md-plugins]). - High speed (see our [benchmarking tests][md-performance]) - Easy to configure for [security][md-security] - Member of [Google's Assured Open Source Software](https://cloud.google.com/assured-open-source-software/docs/supported-packages) This is a Python port of [markdown-it], and some of its associated plugins. For more details see: . For details on [markdown-it] itself, see: - The __[Live demo](https://markdown-it.github.io)__ - [The markdown-it README][markdown-it-readme] **See also:** [markdown-it-pyrs](https://github.com/chrisjsewell/markdown-it-pyrs) for an experimental Rust binding, for even more speed! ## Installation ### PIP ```bash pip install markdown-it-py[plugins] ``` or with extras ```bash pip install markdown-it-py[linkify,plugins] ``` ### Conda ```bash conda install -c conda-forge markdown-it-py ``` or with extras ```bash conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins ``` ## Usage ### Python API Usage Render markdown to HTML with markdown-it-py and a custom configuration with and without plugins and features: ```python from markdown_it import MarkdownIt from mdit_py_plugins.front_matter import front_matter_plugin from mdit_py_plugins.footnote import footnote_plugin md = ( MarkdownIt('commonmark', {'breaks':True,'html':True}) .use(front_matter_plugin) .use(footnote_plugin) .enable('table') ) text = (""" --- a: 1 --- a | b - | - 1 | 2 A footnote [^1] [^1]: some details """) tokens = md.parse(text) html_text = md.render(text) ## To export the html to a file, uncomment the lines below: # from pathlib import Path # Path("output.html").write_text(html_text) ``` ### Command-line Usage Render markdown to HTML with markdown-it-py from the command-line: ```console usage: markdown-it [-h] [-v] [--stdin|filenames [filenames ...]] Parse one or more markdown files, convert each to HTML, and print to stdout positional arguments: --stdin read source Markdown file from standard input filenames specify an optional list of files to convert optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit Interactive: $ markdown-it markdown-it-py [version 0.0.0] (interactive) Type Ctrl-D to complete input, or Ctrl-C to exit. >>> # Example ... > markdown *input* ...

Example

markdown input

Batch: $ markdown-it README.md README.footer.md > index.html ``` ## References / Thanks Big thanks to the authors of [markdown-it]: - Alex Kocharin [github/rlidwka](https://github.com/rlidwka) - Vitaly Puzrin [github/puzrin](https://github.com/puzrin) Also [John MacFarlane](https://github.com/jgm) for his work on the CommonMark spec and reference implementations. [github-ci]: https://github.com/executablebooks/markdown-it-py/actions/workflows/tests.yml/badge.svg?branch=master [github-link]: https://github.com/executablebooks/markdown-it-py [pypi-badge]: https://img.shields.io/pypi/v/markdown-it-py.svg [pypi-link]: https://pypi.org/project/markdown-it-py [conda-badge]: https://anaconda.org/conda-forge/markdown-it-py/badges/version.svg [conda-link]: https://anaconda.org/conda-forge/markdown-it-py [codecov-badge]: https://codecov.io/gh/executablebooks/markdown-it-py/branch/master/graph/badge.svg [codecov-link]: https://codecov.io/gh/executablebooks/markdown-it-py [install-badge]: https://img.shields.io/pypi/dw/markdown-it-py?label=pypi%20installs [install-link]: https://pypistats.org/packages/markdown-it-py [CommonMark spec]: http://spec.commonmark.org/ [markdown-it]: https://github.com/markdown-it/markdown-it [markdown-it-readme]: https://github.com/markdown-it/markdown-it/blob/master/README.md [md-security]: https://markdown-it-py.readthedocs.io/en/latest/security.html [md-performance]: https://markdown-it-py.readthedocs.io/en/latest/performance.html [md-plugins]: https://markdown-it-py.readthedocs.io/en/latest/plugins.html markdown-it-py-4.2.0/SECURITY.md000066400000000000000000000011061517710005200161640ustar00rootroot00000000000000# Security Policy ## Supported Versions We generally only support the latest major release, although critical bug fixes can be released for older versions. ## Reporting a Vulnerability To report a security issue, please email with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. Our team will respond within 3 working days of your email. If the issue is confirmed as a vulnerability, we will open a Security Advisory. This project follows a 90 day disclosure timeline. markdown-it-py-4.2.0/benchmarking/000077500000000000000000000000001517710005200170255ustar00rootroot00000000000000markdown-it-py-4.2.0/benchmarking/bench_core.py000066400000000000000000000005671517710005200214760ustar00rootroot00000000000000from pathlib import Path import pytest import markdown_it @pytest.fixture def spec_text(): return Path(__file__).parent.joinpath("samples", "spec.md").read_text() @pytest.fixture def parser(): return markdown_it.MarkdownIt("commonmark") @pytest.mark.benchmark(group="core") def test_spec(benchmark, parser, spec_text): benchmark(parser.render, spec_text) markdown-it-py-4.2.0/benchmarking/bench_packages.py000066400000000000000000000041471517710005200223220ustar00rootroot00000000000000from pathlib import Path from shutil import which import pytest @pytest.fixture def spec_text(): return Path(__file__).parent.joinpath("samples", "spec.md").read_text() @pytest.mark.benchmark(group="packages") def test_markdown_it_py(benchmark, spec_text): import markdown_it parser = markdown_it.MarkdownIt("commonmark") benchmark.extra_info["version"] = markdown_it.__version__ benchmark(parser.render, spec_text) @pytest.mark.benchmark(group="packages") def test_markdown_it_pyrs(benchmark, spec_text): import markdown_it_pyrs parser = markdown_it_pyrs.MarkdownIt("commonmark") benchmark.extra_info["version"] = markdown_it_pyrs.__version__ benchmark(parser.render, spec_text) @pytest.mark.benchmark(group="packages") def test_mistune(benchmark, spec_text): import mistune benchmark.extra_info["version"] = mistune.__version__ benchmark(mistune.markdown, spec_text) @pytest.mark.benchmark(group="packages") def test_commonmark_py(benchmark, spec_text): import commonmark benchmark.extra_info["version"] = "0.9.1" benchmark(commonmark.commonmark, spec_text) @pytest.mark.benchmark(group="packages") def test_pymarkdown(benchmark, spec_text): import markdown benchmark.extra_info["version"] = markdown.__version__ benchmark(markdown.markdown, spec_text) @pytest.mark.benchmark(group="packages") def test_pymarkdown_extra(benchmark, spec_text): import markdown benchmark.extra_info["version"] = markdown.__version__ benchmark(markdown.markdown, spec_text, extensions=["extra"]) @pytest.mark.benchmark(group="packages") def test_mistletoe(benchmark, spec_text): import mistletoe benchmark.extra_info["version"] = mistletoe.__version__ benchmark(mistletoe.markdown, spec_text) @pytest.mark.skipif(which("pandoc") is None, reason="pandoc executable not found") @pytest.mark.benchmark(group="packages") def test_panflute(benchmark, spec_text): import panflute benchmark.extra_info["version"] = panflute.__version__ benchmark( panflute.convert_text, spec_text, input_format="markdown", output_format="html" ) markdown-it-py-4.2.0/benchmarking/conftest.py000066400000000000000000000006431517710005200212270ustar00rootroot00000000000000def pytest_benchmark_update_machine_info(config, machine_info): import psutil freq = psutil.cpu_freq() machine_info["psutil"] = { "cpu_count": psutil.cpu_count(logical=False), "cpu_count_logical": psutil.cpu_count(logical=True), "cpu_percent": psutil.cpu_percent(), "cpu_freq_min": freq.min, "cpu_freq_max": freq.max, "cpu_freq_current": freq.current, } markdown-it-py-4.2.0/benchmarking/samples/000077500000000000000000000000001517710005200204715ustar00rootroot00000000000000markdown-it-py-4.2.0/benchmarking/samples/block-bq-flat.md000066400000000000000000000003641517710005200234340ustar00rootroot00000000000000> the simple example of a blockquote > the simple example of a blockquote > the simple example of a blockquote > the simple example of a blockquote ... continuation ... continuation ... continuation ... continuation empty blockquote: > > > > markdown-it-py-4.2.0/benchmarking/samples/block-bq-nested.md000066400000000000000000000005431517710005200237670ustar00rootroot00000000000000>>>>>> deeply nested blockquote >>>>> deeply nested blockquote >>>> deeply nested blockquote >>> deeply nested blockquote >> deeply nested blockquote > deeply nested blockquote > deeply nested blockquote >> deeply nested blockquote >>> deeply nested blockquote >>>> deeply nested blockquote >>>>> deeply nested blockquote >>>>>> deeply nested blockquote markdown-it-py-4.2.0/benchmarking/samples/block-code.md000066400000000000000000000001101517710005200230050ustar00rootroot00000000000000 an example of a code block markdown-it-py-4.2.0/benchmarking/samples/block-fences.md000066400000000000000000000001071517710005200233440ustar00rootroot00000000000000 ``````````text an example ``` of a fenced ``` code block `````````` markdown-it-py-4.2.0/benchmarking/samples/block-heading.md000066400000000000000000000001731517710005200235030ustar00rootroot00000000000000# heading ### heading ##### heading # heading # ### heading ### ##### heading \#\#\#\#\###### ############ not a heading markdown-it-py-4.2.0/benchmarking/samples/block-hr.md000066400000000000000000000001111517710005200225050ustar00rootroot00000000000000 * * * * * - - - - - ________ ************************* text markdown-it-py-4.2.0/benchmarking/samples/block-html.md000066400000000000000000000004321517710005200230460ustar00rootroot00000000000000
blah blah
**test**
test
markdown-it-py-4.2.0/benchmarking/samples/block-lheading.md000066400000000000000000000001611517710005200236540ustar00rootroot00000000000000heading --- heading =================================== not a heading ----------------------------------- text markdown-it-py-4.2.0/benchmarking/samples/block-list-flat.md000066400000000000000000000010131517710005200237750ustar00rootroot00000000000000 - tidy - bullet - list - loose - bullet - list 0. ordered 1. list 2. example - - - - 1. 2. 3. - an example of a list item with a continuation this part is inside the list this part is just a paragraph 1. test - test 1. test - test 111111111111111111111111111111111111111111. is this a valid bullet? - _________________________ - this - is a long - loose - list - with - some tidy - list - items - in - between - _________________________ markdown-it-py-4.2.0/benchmarking/samples/block-list-nested.md000066400000000000000000000006031517710005200243350ustar00rootroot00000000000000 - this - is - a - deeply - nested - bullet - list 1. this 2. is 3. a 4. deeply 5. nested 6. unordered 7. list - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 6 - 5 - 4 - 3 - 2 - 1 - - - - - - - - - deeply-nested one-element item markdown-it-py-4.2.0/benchmarking/samples/block-ref-flat.md000066400000000000000000000007321517710005200236050ustar00rootroot00000000000000[1] [2] [3] [1] [2] [3] [looooooooooooooooooooooooooooooooooooooooooooooooooong label] [1]: [2]: http://something.example.com/foo/bar 'test' [3]: http://foo/bar [ looooooooooooooooooooooooooooooooooooooooooooooooooong label ]: 111 'test' [[[[[[[[[[[[[[[[[[[[ this should not slow down anything ]]]]]]]]]]]]]]]]]]]]: q (as long as it is not referenced anywhere) [[[[[[[[[[[[[[[[[[[[]: this is not a valid reference markdown-it-py-4.2.0/benchmarking/samples/block-ref-list.md000066400000000000000000000014161517710005200236320ustar00rootroot00000000000000[item 1]: <1> [item 2]: <2> [item 3]: <3> [item 4]: <4> [item 5]: <5> [item 6]: <6> [item 7]: <7> [item 8]: <8> [item 9]: <9> [item 10]: <10> [item 11]: <11> [item 12]: <12> [item 13]: <13> [item 14]: <14> [item 15]: <15> [item 16]: <16> [item 17]: <17> [item 18]: <18> [item 19]: <19> [item 20]: <20> [item 21]: <21> [item 22]: <22> [item 23]: <23> [item 24]: <24> [item 25]: <25> [item 26]: <26> [item 27]: <27> [item 28]: <28> [item 29]: <29> [item 30]: <30> [item 31]: <31> [item 32]: <32> [item 33]: <33> [item 34]: <34> [item 35]: <35> [item 36]: <36> [item 37]: <37> [item 38]: <38> [item 39]: <39> [item 40]: <40> [item 41]: <41> [item 42]: <42> [item 43]: <43> [item 44]: <44> [item 45]: <45> [item 46]: <46> [item 47]: <47> [item 48]: <48> [item 49]: <49> [item 50]: <50> markdown-it-py-4.2.0/benchmarking/samples/block-ref-nested.md000066400000000000000000000004011517710005200241320ustar00rootroot00000000000000[[[[[[[foo]]]]]]] [[[[[[[foo]]]]]]]: bar [[[[[[foo]]]]]]: bar [[[[[foo]]]]]: bar [[[[foo]]]]: bar [[[foo]]]: bar [[foo]]: bar [foo]: bar [*[*[*[*[foo]*]*]*]*] [*[*[*[*[foo]*]*]*]*]: bar [*[*[*[foo]*]*]*]: bar [*[*[foo]*]*]: bar [*[foo]*]: bar [foo]: bar markdown-it-py-4.2.0/benchmarking/samples/block-tables.md000066400000000000000000000007741517710005200233650ustar00rootroot00000000000000| Heading 1 | Heading 2 | --------- | --------- | Cell 1 | Cell 2 | Cell 3 | Cell 4 | Header 1 | Header 2 | Header 3 | Header 4 | | :------: | -------: | :------- | -------- | | Cell 1 | Cell 2 | Cell 3 | Cell 4 | | Cell 5 | Cell 6 | Cell 7 | Cell 8 | Test code Header 1 | Header 2 -------- | -------- Cell 1 | Cell 2 Cell 3 | Cell 4 Header 1|Header 2|Header 3|Header 4 :-------|:------:|-------:|-------- Cell 1 |Cell 2 |Cell 3 |Cell 4 *Cell 5*|Cell 6 |Cell 7 |Cell 8 markdown-it-py-4.2.0/benchmarking/samples/inline-autolink.md000066400000000000000000000010551517710005200241160ustar00rootroot00000000000000closed (valid) autolinks: these are not autolinks: markdown-it-py-4.2.0/benchmarking/samples/inline-backticks.md000066400000000000000000000001001517710005200242140ustar00rootroot00000000000000`lots`of`backticks` ``i``wonder``how``this``will``be``parsed`` markdown-it-py-4.2.0/benchmarking/samples/inline-em-flat.md000066400000000000000000000002331517710005200236120ustar00rootroot00000000000000*this* *is* *your* *basic* *boring* *emphasis* _this_ _is_ _your_ _basic_ _boring_ _emphasis_ **this** **is** **your** **basic** **boring** **emphasis** markdown-it-py-4.2.0/benchmarking/samples/inline-em-nested.md000066400000000000000000000002331517710005200241460ustar00rootroot00000000000000*this *is *a *bunch* of* nested* emphases* __this __is __a __bunch__ of__ nested__ emphases__ ***this ***is ***a ***bunch*** of*** nested*** emphases*** markdown-it-py-4.2.0/benchmarking/samples/inline-em-worst.md000066400000000000000000000002551517710005200240460ustar00rootroot00000000000000*this *is *a *worst *case *for *em *backtracking __this __is __a __worst __case __for __em __backtracking ***this ***is ***a ***worst ***case ***for ***em ***backtracking markdown-it-py-4.2.0/benchmarking/samples/inline-entity.md000066400000000000000000000005101517710005200235770ustar00rootroot00000000000000entities:   & © Æ Ď ¾ ℋ ⅆ ∲ # Ӓ Ϡ � non-entities: &18900987654321234567890; &1234567890098765432123456789009876543212345678987654; &qwertyuioppoiuytrewqwer; &oiuytrewqwertyuioiuytrewqwertyuioytrewqwertyuiiuytri; markdown-it-py-4.2.0/benchmarking/samples/inline-escape.md000066400000000000000000000002701517710005200235260ustar00rootroot00000000000000 \t\e\s\t\i\n\g \e\s\c\a\p\e \s\e\q\u\e\n\c\e\s \!\\\"\#\$\%\&\'\(\)\*\+\,\.\/\:\;\<\=\>\? \@ \[ \] \^ \_ \` \{ \| \} \~ \- \' \ \\ \\\ \\\\ \\\\\ \ \ \ \ markdown-it-py-4.2.0/benchmarking/samples/inline-html.md000066400000000000000000000010041517710005200232260ustar00rootroot00000000000000Taking commonmark tests from the spec for benchmarking here: <33> <__> foo foo foo foo foo &<]]> markdown-it-py-4.2.0/benchmarking/samples/inline-links-flat.md000066400000000000000000000013271517710005200243360ustar00rootroot00000000000000Valid links: [this is a link]() [this is a link]() [this is a link](http://something.example.com/foo/bar 'test') ![this is an image]() ![this is an image]() ![this is an image](http://something.example.com/foo/bar 'test') [escape test](<\>\>\>\>\>\>\>\>\>\>\>\>\>\>> '\'\'\'\'\'\'\'\'\'\'\'\'\'\'') [escape test \]\]\]\]\]\]\]\]\]\]\]\]\]\]\]\]](\)\)\)\)\)\)\)\)\)\)\)\)\)\)) Invalid links: [this is not a link [this is not a link]( [this is not a link](http://something.example.com/foo/bar 'test' [this is not a link]((((((((((((((((((((((((((((((((((((((((((((((( [this is not a link]((((((((((()))))))))) (((((((((())))))))))) markdown-it-py-4.2.0/benchmarking/samples/inline-links-nested.md000066400000000000000000000004711517710005200246710ustar00rootroot00000000000000Valid links: [[[[[[[[](test)](test)](test)](test)](test)](test)](test)] [ [[[[[[[[[[[[[[[[[[ [](test) ]]]]]]]]]]]]]]]]]] ](test) Invalid links: [[[[[[[[[ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ [ ![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![![ markdown-it-py-4.2.0/benchmarking/samples/inline-newlines.md000066400000000000000000000001771517710005200241200ustar00rootroot00000000000000 this\ should\ be\ separated\ by\ newlines this should be separated by newlines too this should not be separated by newlines markdown-it-py-4.2.0/benchmarking/samples/lorem1.txt000066400000000000000000000073151517710005200224370ustar00rootroot00000000000000Lorem ipsum dolor sit amet, __consectetur__ adipiscing elit. Cras imperdiet nec erat ac condimentum. Nulla vel rutrum ligula. Sed hendrerit interdum orci a posuere. Vivamus ut velit aliquet, mollis purus eget, iaculis nisl. Proin posuere malesuada ante. Proin auctor orci eros, ac molestie lorem dictum nec. Vestibulum sit amet erat est. Morbi luctus sed elit ac luctus. Proin blandit, enim vitae egestas posuere, neque elit ultricies dui, vel mattis nibh enim ac lorem. Maecenas molestie nisl sit amet velit dictum lobortis. Aliquam erat volutpat. Vivamus sagittis, diam in [vehicula](https://github.com/markdown-it/markdown-it) lobortis, sapien arcu mattis erat, vel aliquet sem urna et risus. Ut feugiat sapien vitae mi elementum laoreet. Suspendisse potenti. Aliquam erat nisl, aliquam pretium libero aliquet, sagittis eleifend nunc. In hac habitasse platea dictumst. Integer turpis augue, tincidunt dignissim mauris id, rhoncus dapibus purus. Maecenas et enim odio. Nullam massa metus, varius quis vehicula sed, pharetra mollis erat. In quis viverra velit. Vivamus placerat, est nec hendrerit varius, enim dui hendrerit magna, ut pulvinar nibh lorem vel lacus. Mauris a orci iaculis, hendrerit eros sed, gravida leo. In dictum mauris vel augue varius, ac ullamcorper nisl ornare. In eu posuere velit, ac fermentum arcu. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nullam sed malesuada leo, at interdum elit. Nullam ut tincidunt nunc. [Pellentesque][1] metus lacus, commodo eget justo ut, rutrum varius nunc. Sed non rhoncus risus. Morbi sodales gravida pulvinar. Duis malesuada, odio volutpat elementum vulputate, massa magna scelerisque ante, et accumsan tellus nunc in sem. Donec mattis arcu et velit aliquet, non sagittis justo vestibulum. Suspendisse volutpat felis lectus, nec consequat ipsum mattis id. Donec dapibus vehicula facilisis. In tincidunt mi nisi, nec faucibus tortor euismod nec. Suspendisse ante ligula, aliquet vitae libero eu, vulputate dapibus libero. Sed bibendum, sapien at posuere interdum, libero est sollicitudin magna, ac gravida tellus purus eu ipsum. Proin ut quam arcu. Suspendisse potenti. Donec ante velit, ornare at augue quis, tristique laoreet sem. Etiam in ipsum elit. Nullam cursus dolor sit amet nulla feugiat tristique. Phasellus ac tellus tincidunt, imperdiet purus eget, ullamcorper ipsum. Cras eu tincidunt sem. Nullam sed dapibus magna. Lorem ipsum dolor sit amet, consectetur adipiscing elit. In id venenatis tortor. In consectetur sollicitudin pharetra. Etiam convallis nisi nunc, et aliquam turpis viverra sit amet. Maecenas faucibus sodales tortor. Suspendisse lobortis mi eu leo viverra volutpat. Pellentesque velit ante, vehicula sodales congue ut, elementum a urna. Cras tempor, ipsum eget luctus rhoncus, arcu ligula fermentum urna, vulputate pharetra enim enim non libero. Proin diam quam, elementum in eleifend id, elementum et metus. Cras in justo consequat justo semper ultrices. Sed dignissim lectus a ante mollis, nec vulputate ante molestie. Proin in porta nunc. Etiam pulvinar turpis sed velit porttitor, vel adipiscing velit fringilla. Cras ac tellus vitae purus pharetra tincidunt. Sed cursus aliquet aliquet. Cras eleifend commodo malesuada. In turpis turpis, ullamcorper ut tincidunt a, ullamcorper a nunc. Etiam luctus tellus ac dapibus gravida. Ut nec lacus laoreet neque ullamcorper volutpat. Nunc et leo erat. Aenean mattis ultrices lorem, eget adipiscing dolor ultricies eu. In hac habitasse platea dictumst. Vivamus cursus feugiat sapien quis aliquam. Mauris quam libero, porta vel volutpat ut, blandit a purus. Vivamus vestibulum dui vel tortor molestie, sit amet feugiat sem commodo. Nulla facilisi. Sed molestie arcu eget tellus vestibulum tristique. [1]: https://github.com/markdown-it markdown-it-py-4.2.0/benchmarking/samples/rawtabs.md000066400000000000000000000004461517710005200224620ustar00rootroot00000000000000 this is a test for tab expansion, be careful not to replace them with spaces 1 4444 22 333 333 22 4444 1 tab-indented line space-indented line tab-indented line a lot of spaces in between here a lot of tabs in between here markdown-it-py-4.2.0/benchmarking/samples/spec.md000066400000000000000000006141131517710005200217530ustar00rootroot00000000000000--- title: CommonMark Spec author: John MacFarlane version: 0.29 date: '2019-04-06' license: '[CC-BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)' ... # Introduction ## What is Markdown? Markdown is a plain text format for writing structured documents, based on conventions for indicating formatting in email and usenet posts. It was developed by John Gruber (with help from Aaron Swartz) and released in 2004 in the form of a [syntax description](http://daringfireball.net/projects/markdown/syntax) and a Perl script (`Markdown.pl`) for converting Markdown to HTML. In the next decade, dozens of implementations were developed in many languages. Some extended the original Markdown syntax with conventions for footnotes, tables, and other document elements. Some allowed Markdown documents to be rendered in formats other than HTML. Websites like Reddit, StackOverflow, and GitHub had millions of people using Markdown. And Markdown started to be used beyond the web, to author books, articles, slide shows, letters, and lecture notes. What distinguishes Markdown from many other lightweight markup syntaxes, which are often easier to write, is its readability. As Gruber writes: > The overriding design goal for Markdown's formatting syntax is > to make it as readable as possible. The idea is that a > Markdown-formatted document should be publishable as-is, as > plain text, without looking like it's been marked up with tags > or formatting instructions. > () The point can be illustrated by comparing a sample of [AsciiDoc](http://www.methods.co.nz/asciidoc/) with an equivalent sample of Markdown. Here is a sample of AsciiDoc from the AsciiDoc manual: ``` 1. List item one. + List item one continued with a second paragraph followed by an Indented block. + ................. $ ls *.sh $ mv *.sh ~/tmp ................. + List item continued with a third paragraph. 2. List item two continued with an open block. + -- This paragraph is part of the preceding list item. a. This list is nested and does not require explicit item continuation. + This paragraph is part of the preceding list item. b. List item b. This paragraph belongs to item two of the outer list. -- ``` And here is the equivalent in Markdown: ``` 1. List item one. List item one continued with a second paragraph followed by an Indented block. $ ls *.sh $ mv *.sh ~/tmp List item continued with a third paragraph. 2. List item two continued with an open block. This paragraph is part of the preceding list item. 1. This list is nested and does not require explicit item continuation. This paragraph is part of the preceding list item. 2. List item b. This paragraph belongs to item two of the outer list. ``` The AsciiDoc version is, arguably, easier to write. You don't need to worry about indentation. But the Markdown version is much easier to read. The nesting of list items is apparent to the eye in the source, not just in the processed document. ## Why is a spec needed? John Gruber's [canonical description of Markdown's syntax](http://daringfireball.net/projects/markdown/syntax) does not specify the syntax unambiguously. Here are some examples of questions it does not answer: 1. How much indentation is needed for a sublist? The spec says that continuation paragraphs need to be indented four spaces, but is not fully explicit about sublists. It is natural to think that they, too, must be indented four spaces, but `Markdown.pl` does not require that. This is hardly a "corner case," and divergences between implementations on this issue often lead to surprises for users in real documents. (See [this comment by John Gruber](http://article.gmane.org/gmane.text.markdown.general/1997).) 2. Is a blank line needed before a block quote or heading? Most implementations do not require the blank line. However, this can lead to unexpected results in hard-wrapped text, and also to ambiguities in parsing (note that some implementations put the heading inside the blockquote, while others do not). (John Gruber has also spoken [in favor of requiring the blank lines](http://article.gmane.org/gmane.text.markdown.general/2146).) 3. Is a blank line needed before an indented code block? (`Markdown.pl` requires it, but this is not mentioned in the documentation, and some implementations do not require it.) ``` markdown paragraph code? ``` 4. What is the exact rule for determining when list items get wrapped in `

` tags? Can a list be partially "loose" and partially "tight"? What should we do with a list like this? ``` markdown 1. one 2. two 3. three ``` Or this? ``` markdown 1. one - a - b 2. two ``` (There are some relevant comments by John Gruber [here](http://article.gmane.org/gmane.text.markdown.general/2554).) 5. Can list markers be indented? Can ordered list markers be right-aligned? ``` markdown 8. item 1 9. item 2 10. item 2a ``` 6. Is this one list with a thematic break in its second item, or two lists separated by a thematic break? ``` markdown * a * * * * * * b ``` 7. When list markers change from numbers to bullets, do we have two lists or one? (The Markdown syntax description suggests two, but the perl scripts and many other implementations produce one.) ``` markdown 1. fee 2. fie - foe - fum ``` 8. What are the precedence rules for the markers of inline structure? For example, is the following a valid link, or does the code span take precedence ? ``` markdown [a backtick (`)](/url) and [another backtick (`)](/url). ``` 9. What are the precedence rules for markers of emphasis and strong emphasis? For example, how should the following be parsed? ``` markdown *foo *bar* baz* ``` 10. What are the precedence rules between block-level and inline-level structure? For example, how should the following be parsed? ``` markdown - `a long code span can contain a hyphen like this - and it can screw things up` ``` 11. Can list items include section headings? (`Markdown.pl` does not allow this, but does allow blockquotes to include headings.) ``` markdown - # Heading ``` 12. Can list items be empty? ``` markdown * a * * b ``` 13. Can link references be defined inside block quotes or list items? ``` markdown > Blockquote [foo]. > > [foo]: /url ``` 14. If there are multiple definitions for the same reference, which takes precedence? ``` markdown [foo]: /url1 [foo]: /url2 [foo][] ``` In the absence of a spec, early implementers consulted `Markdown.pl` to resolve these ambiguities. But `Markdown.pl` was quite buggy, and gave manifestly bad results in many cases, so it was not a satisfactory replacement for a spec. Because there is no unambiguous spec, implementations have diverged considerably. As a result, users are often surprised to find that a document that renders one way on one system (say, a GitHub wiki) renders differently on another (say, converting to docbook using pandoc). To make matters worse, because nothing in Markdown counts as a "syntax error," the divergence often isn't discovered right away. ## About this document This document attempts to specify Markdown syntax unambiguously. It contains many examples with side-by-side Markdown and HTML. These are intended to double as conformance tests. An accompanying script `spec_tests.py` can be used to run the tests against any Markdown program: python test/spec_tests.py --spec spec.txt --program PROGRAM Since this document describes how Markdown is to be parsed into an abstract syntax tree, it would have made sense to use an abstract representation of the syntax tree instead of HTML. But HTML is capable of representing the structural distinctions we need to make, and the choice of HTML for the tests makes it possible to run the tests against an implementation without writing an abstract syntax tree renderer. This document is generated from a text file, `spec.txt`, written in Markdown with a small extension for the side-by-side tests. The script `tools/makespec.py` can be used to convert `spec.txt` into HTML or CommonMark (which can then be converted into other formats). In the examples, the `→` character is used to represent tabs. # Preliminaries ## Characters and lines Any sequence of [characters] is a valid CommonMark document. A [character](@) is a Unicode code point. Although some code points (for example, combining accents) do not correspond to characters in an intuitive sense, all code points count as characters for purposes of this spec. This spec does not specify an encoding; it thinks of lines as composed of [characters] rather than bytes. A conforming parser may be limited to a certain encoding. A [line](@) is a sequence of zero or more [characters] other than newline (`U+000A`) or carriage return (`U+000D`), followed by a [line ending] or by the end of file. A [line ending](@) is a newline (`U+000A`), a carriage return (`U+000D`) not followed by a newline, or a carriage return and a following newline. A line containing no characters, or a line containing only spaces (`U+0020`) or tabs (`U+0009`), is called a [blank line](@). The following definitions of character classes will be used in this spec: A [whitespace character](@) is a space (`U+0020`), tab (`U+0009`), newline (`U+000A`), line tabulation (`U+000B`), form feed (`U+000C`), or carriage return (`U+000D`). [Whitespace](@) is a sequence of one or more [whitespace characters]. A [Unicode whitespace character](@) is any code point in the Unicode `Zs` general category, or a tab (`U+0009`), carriage return (`U+000D`), newline (`U+000A`), or form feed (`U+000C`). [Unicode whitespace](@) is a sequence of one or more [Unicode whitespace characters]. A [space](@) is `U+0020`. A [non-whitespace character](@) is any character that is not a [whitespace character]. An [ASCII punctuation character](@) is `!`, `"`, `#`, `$`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `-`, `.`, `/` (U+0021–2F), `:`, `;`, `<`, `=`, `>`, `?`, `@` (U+003A–0040), `[`, `\`, `]`, `^`, `_`, `` ` `` (U+005B–0060), `{`, `|`, `}`, or `~` (U+007B–007E). A [punctuation character](@) is an [ASCII punctuation character] or anything in the general Unicode categories `Pc`, `Pd`, `Pe`, `Pf`, `Pi`, `Po`, or `Ps`. ## Tabs Tabs in lines are not expanded to [spaces]. However, in contexts where whitespace helps to define block structure, tabs behave as if they were replaced by spaces with a tab stop of 4 characters. Thus, for example, a tab can be used instead of four spaces in an indented code block. (Note, however, that internal tabs are passed through as literal tabs, not expanded to spaces.) ```````````````````````````````` example →foo→baz→→bim . 

foo→baz→→bim
```````````````````````````````` ```````````````````````````````` example →foo→baz→→bim . 
foo→baz→→bim
```````````````````````````````` ```````````````````````````````` example a→a ὐ→a . 
a→a
ὐ→a
```````````````````````````````` In the following example, a continuation paragraph of a list item is indented with a tab; this has exactly the same effect as indentation with four spaces would: ```````````````````````````````` example - foo →bar .

  • foo

    bar

```````````````````````````````` ```````````````````````````````` example - foo →→bar .

  • foo

      bar
```````````````````````````````` Normally the `>` that begins a block quote may be followed optionally by a space, which is not considered part of the content. In the following case `>` is followed by a tab, which is treated as if it were expanded into three spaces. Since one of these spaces is considered part of the delimiter, `foo` is considered to be indented six spaces inside the block quote context, so we get an indented code block starting with two spaces. ```````````````````````````````` example >→→foo . 
  foo
```````````````````````````````` ```````````````````````````````` example -→→foo . 
  •   foo
```````````````````````````````` ```````````````````````````````` example foo →bar . 
foo
bar
```````````````````````````````` ```````````````````````````````` example - foo - bar → - baz .
  • foo
    • bar
      • baz
```````````````````````````````` ```````````````````````````````` example #→Foo .

Foo

```````````````````````````````` ```````````````````````````````` example *→*→*→ .
```````````````````````````````` ## Insecure characters For security reasons, the Unicode character `U+0000` must be replaced with the REPLACEMENT CHARACTER (`U+FFFD`). # Blocks and inlines We can think of a document as a sequence of [blocks](@)---structural elements like paragraphs, block quotations, lists, headings, rules, and code blocks. Some blocks (like block quotes and list items) contain other blocks; others (like headings and paragraphs) contain [inline](@) content---text, links, emphasized text, images, code spans, and so on. ## Precedence Indicators of block structure always take precedence over indicators of inline structure. So, for example, the following is a list with two items, not a list with one item containing a code span: ```````````````````````````````` example - `one - two` .
  • `one
  • two`
```````````````````````````````` This means that parsing can proceed in two steps: first, the block structure of the document can be discerned; second, text lines inside paragraphs, headings, and other block constructs can be parsed for inline structure. The second step requires information about link reference definitions that will be available only at the end of the first step. Note that the first step requires processing lines in sequence, but the second can be parallelized, since the inline parsing of one block element does not affect the inline parsing of any other. ## Container blocks and leaf blocks We can divide blocks into two types: [container blocks](@), which can contain other blocks, and [leaf blocks](@), which cannot. # Leaf blocks This section describes the different kinds of leaf block that make up a Markdown document. ## Thematic breaks A line consisting of 0-3 spaces of indentation, followed by a sequence of three or more matching `-`, `_`, or `*` characters, each followed optionally by any number of spaces or tabs, forms a [thematic break](@). ```````````````````````````````` example *** --- ___ .
```````````````````````````````` Wrong characters: ```````````````````````````````` example +++ .

+++

```````````````````````````````` ```````````````````````````````` example === .

===

```````````````````````````````` Not enough characters: ```````````````````````````````` example -- ** __ .

-- ** __

```````````````````````````````` One to three spaces indent are allowed: ```````````````````````````````` example *** *** *** .
```````````````````````````````` Four spaces is too many: ```````````````````````````````` example *** . 
***
```````````````````````````````` ```````````````````````````````` example Foo *** .

Foo ***

```````````````````````````````` More than three characters may be used: ```````````````````````````````` example _____________________________________ .
```````````````````````````````` Spaces are allowed between the characters: ```````````````````````````````` example - - - .
```````````````````````````````` ```````````````````````````````` example ** * ** * ** * ** .
```````````````````````````````` ```````````````````````````````` example - - - - .
```````````````````````````````` Spaces are allowed at the end: ```````````````````````````````` example - - - - .
```````````````````````````````` However, no other characters may occur in the line: ```````````````````````````````` example _ _ _ _ a a------ ---a--- .

_ _ _ _ a

a------

---a---

```````````````````````````````` It is required that all of the [non-whitespace characters] be the same. So, this is not a thematic break: ```````````````````````````````` example *-* .

-

```````````````````````````````` Thematic breaks do not need blank lines before or after: ```````````````````````````````` example - foo *** - bar .
  • foo
  • bar
```````````````````````````````` Thematic breaks can interrupt a paragraph: ```````````````````````````````` example Foo *** bar .

Foo

bar

```````````````````````````````` If a line of dashes that meets the above conditions for being a thematic break could also be interpreted as the underline of a [setext heading], the interpretation as a [setext heading] takes precedence. Thus, for example, this is a setext heading, not a paragraph followed by a thematic break: ```````````````````````````````` example Foo --- bar .

Foo

bar

```````````````````````````````` When both a thematic break and a list item are possible interpretations of a line, the thematic break takes precedence: ```````````````````````````````` example * Foo * * * * Bar .
  • Foo
  • Bar
```````````````````````````````` If you want a thematic break in a list item, use a different bullet: ```````````````````````````````` example - Foo - * * * .
  • Foo
```````````````````````````````` ## ATX headings An [ATX heading](@) consists of a string of characters, parsed as inline content, between an opening sequence of 1--6 unescaped `#` characters and an optional closing sequence of any number of unescaped `#` characters. The opening sequence of `#` characters must be followed by a [space] or by the end of line. The optional closing sequence of `#`s must be preceded by a [space] and may be followed by spaces only. The opening `#` character may be indented 0-3 spaces. The raw contents of the heading are stripped of leading and trailing spaces before being parsed as inline content. The heading level is equal to the number of `#` characters in the opening sequence. Simple headings: ```````````````````````````````` example # foo ## foo ### foo #### foo ##### foo ###### foo .

foo

foo

foo

foo

foo
foo
```````````````````````````````` More than six `#` characters is not a heading: ```````````````````````````````` example ####### foo .

####### foo

```````````````````````````````` At least one space is required between the `#` characters and the heading's contents, unless the heading is empty. Note that many implementations currently do not require the space. However, the space was required by the [original ATX implementation](http://www.aaronsw.com/2002/atx/atx.py), and it helps prevent things like the following from being parsed as headings: ```````````````````````````````` example #5 bolt #hashtag .

#5 bolt

#hashtag

```````````````````````````````` This is not a heading, because the first `#` is escaped: ```````````````````````````````` example \## foo .

## foo

```````````````````````````````` Contents are parsed as inlines: ```````````````````````````````` example # foo *bar* \*baz\* .

foo bar *baz*

```````````````````````````````` Leading and trailing [whitespace] is ignored in parsing inline content: ```````````````````````````````` example # foo .

foo

```````````````````````````````` One to three spaces indentation are allowed: ```````````````````````````````` example ### foo ## foo # foo .

foo

foo

foo

```````````````````````````````` Four spaces are too much: ```````````````````````````````` example # foo . 
# foo
```````````````````````````````` ```````````````````````````````` example foo # bar .

foo # bar

```````````````````````````````` A closing sequence of `#` characters is optional: ```````````````````````````````` example ## foo ## ### bar ### .

foo

bar

```````````````````````````````` It need not be the same length as the opening sequence: ```````````````````````````````` example # foo ################################## ##### foo ## .

foo

foo
```````````````````````````````` Spaces are allowed after the closing sequence: ```````````````````````````````` example ### foo ### .

foo

```````````````````````````````` A sequence of `#` characters with anything but [spaces] following it is not a closing sequence, but counts as part of the contents of the heading: ```````````````````````````````` example ### foo ### b .

foo ### b

```````````````````````````````` The closing sequence must be preceded by a space: ```````````````````````````````` example # foo# .

foo#

```````````````````````````````` Backslash-escaped `#` characters do not count as part of the closing sequence: ```````````````````````````````` example ### foo \### ## foo #\## # foo \# .

foo ###

foo ###

foo #

```````````````````````````````` ATX headings need not be separated from surrounding content by blank lines, and they can interrupt paragraphs: ```````````````````````````````` example **** ## foo **** .

foo

```````````````````````````````` ```````````````````````````````` example Foo bar # baz Bar foo .

Foo bar

baz

Bar foo

```````````````````````````````` ATX headings can be empty: ```````````````````````````````` example ## # ### ### .

```````````````````````````````` ## Setext headings A [setext heading](@) consists of one or more lines of text, each containing at least one [non-whitespace character], with no more than 3 spaces indentation, followed by a [setext heading underline]. The lines of text must be such that, were they not followed by the setext heading underline, they would be interpreted as a paragraph: they cannot be interpretable as a [code fence], [ATX heading][ATX headings], [block quote][block quotes], [thematic break][thematic breaks], [list item][list items], or [HTML block][HTML blocks]. A [setext heading underline](@) is a sequence of `=` characters or a sequence of `-` characters, with no more than 3 spaces indentation and any number of trailing spaces. If a line containing a single `-` can be interpreted as an empty [list items], it should be interpreted this way and not as a [setext heading underline]. The heading is a level 1 heading if `=` characters are used in the [setext heading underline], and a level 2 heading if `-` characters are used. The contents of the heading are the result of parsing the preceding lines of text as CommonMark inline content. In general, a setext heading need not be preceded or followed by a blank line. However, it cannot interrupt a paragraph, so when a setext heading comes after a paragraph, a blank line is needed between them. Simple examples: ```````````````````````````````` example Foo *bar* ========= Foo *bar* --------- .

Foo bar

Foo bar

```````````````````````````````` The content of the header may span more than one line: ```````````````````````````````` example Foo *bar baz* ==== .

Foo bar baz

```````````````````````````````` The contents are the result of parsing the headings's raw content as inlines. The heading's raw content is formed by concatenating the lines and removing initial and final [whitespace]. ```````````````````````````````` example Foo *bar baz*→ ==== .

Foo bar baz

```````````````````````````````` The underlining can be any length: ```````````````````````````````` example Foo ------------------------- Foo = .

Foo

Foo

```````````````````````````````` The heading content can be indented up to three spaces, and need not line up with the underlining: ```````````````````````````````` example Foo --- Foo ----- Foo === .

Foo

Foo

Foo

```````````````````````````````` Four spaces indent is too much: ```````````````````````````````` example Foo --- Foo --- . 
Foo
---

Foo
```````````````````````````````` The setext heading underline can be indented up to three spaces, and may have trailing spaces: ```````````````````````````````` example Foo ---- .

Foo

```````````````````````````````` Four spaces is too much: ```````````````````````````````` example Foo --- .

Foo ---

```````````````````````````````` The setext heading underline cannot contain internal spaces: ```````````````````````````````` example Foo = = Foo --- - .

Foo = =

Foo

```````````````````````````````` Trailing spaces in the content line do not cause a line break: ```````````````````````````````` example Foo ----- .

Foo

```````````````````````````````` Nor does a backslash at the end: ```````````````````````````````` example Foo\ ---- .

Foo\

```````````````````````````````` Since indicators of block structure take precedence over indicators of inline structure, the following are setext headings: ```````````````````````````````` example `Foo ---- ` .

`Foo

`

<a title="a lot

of dashes"/>

```````````````````````````````` The setext heading underline cannot be a [lazy continuation line] in a list item or block quote: ```````````````````````````````` example > Foo --- .

Foo

```````````````````````````````` ```````````````````````````````` example > foo bar === .

foo bar ===

```````````````````````````````` ```````````````````````````````` example - Foo --- .
  • Foo
```````````````````````````````` A blank line is needed between a paragraph and a following setext heading, since otherwise the paragraph becomes part of the heading's content: ```````````````````````````````` example Foo Bar --- .

Foo Bar

```````````````````````````````` But in general a blank line is not required before or after setext headings: ```````````````````````````````` example --- Foo --- Bar --- Baz .

Foo

Bar

Baz

```````````````````````````````` Setext headings cannot be empty: ```````````````````````````````` example ==== .

====

```````````````````````````````` Setext heading text lines must not be interpretable as block constructs other than paragraphs. So, the line of dashes in these examples gets interpreted as a thematic break: ```````````````````````````````` example --- --- .
```````````````````````````````` ```````````````````````````````` example - foo ----- .
  • foo
```````````````````````````````` ```````````````````````````````` example foo --- . 
foo
```````````````````````````````` ```````````````````````````````` example > foo ----- .

foo

```````````````````````````````` If you want a heading with `> foo` as its literal text, you can use backslash escapes: ```````````````````````````````` example \> foo ------ .

> foo

```````````````````````````````` **Compatibility note:** Most existing Markdown implementations do not allow the text of setext headings to span multiple lines. But there is no consensus about how to interpret ``` markdown Foo bar --- baz ``` One can find four different interpretations: 1. paragraph "Foo", heading "bar", paragraph "baz" 2. paragraph "Foo bar", thematic break, paragraph "baz" 3. paragraph "Foo bar --- baz" 4. heading "Foo bar", paragraph "baz" We find interpretation 4 most natural, and interpretation 4 increases the expressive power of CommonMark, by allowing multiline headings. Authors who want interpretation 1 can put a blank line after the first paragraph: ```````````````````````````````` example Foo bar --- baz .

Foo

bar

baz

```````````````````````````````` Authors who want interpretation 2 can put blank lines around the thematic break, ```````````````````````````````` example Foo bar --- baz .

Foo bar

baz

```````````````````````````````` or use a thematic break that cannot count as a [setext heading underline], such as ```````````````````````````````` example Foo bar * * * baz .

Foo bar

baz

```````````````````````````````` Authors who want interpretation 3 can use backslash escapes: ```````````````````````````````` example Foo bar \--- baz .

Foo bar --- baz

```````````````````````````````` ## Indented code blocks An [indented code block](@) is composed of one or more [indented chunks] separated by blank lines. An [indented chunk](@) is a sequence of non-blank lines, each indented four or more spaces. The contents of the code block are the literal contents of the lines, including trailing [line endings], minus four spaces of indentation. An indented code block has no [info string]. An indented code block cannot interrupt a paragraph, so there must be a blank line between a paragraph and a following indented code block. (A blank line is not needed, however, between a code block and a following paragraph.) ```````````````````````````````` example a simple indented code block . 
a simple
  indented code block
```````````````````````````````` If there is any ambiguity between an interpretation of indentation as a code block and as indicating that material belongs to a [list item][list items], the list item interpretation takes precedence: ```````````````````````````````` example - foo bar .

  • foo

    bar

```````````````````````````````` ```````````````````````````````` example 1. foo - bar .

  1. foo

    • bar
```````````````````````````````` The contents of a code block are literal text, and do not get parsed as Markdown: ```````````````````````````````` example *hi* - one . 
<a/>
*hi*

- one
```````````````````````````````` Here we have three chunks separated by blank lines: ```````````````````````````````` example chunk1 chunk2 chunk3 . 
chunk1

chunk2



chunk3
```````````````````````````````` Any initial spaces beyond four will be included in the content, even in interior blank lines: ```````````````````````````````` example chunk1 chunk2 . 
chunk1
  
  chunk2
```````````````````````````````` An indented code block cannot interrupt a paragraph. (This allows hanging indents and the like.) ```````````````````````````````` example Foo bar .

Foo bar

```````````````````````````````` However, any non-blank line with fewer than four leading spaces ends the code block immediately. So a paragraph may occur immediately after indented code: ```````````````````````````````` example foo bar . 
foo

bar

```````````````````````````````` And indented code can occur immediately before and after other kinds of blocks: ```````````````````````````````` example # Heading foo Heading ------ foo ---- .

Heading

foo

Heading

foo
```````````````````````````````` The first line can be indented more than four spaces: ```````````````````````````````` example foo bar . 
    foo
bar
```````````````````````````````` Blank lines preceding or following an indented code block are not included in it: ```````````````````````````````` example foo . 
foo
```````````````````````````````` Trailing spaces are included in the code block's content: ```````````````````````````````` example foo . 
foo
```````````````````````````````` ## Fenced code blocks A [code fence](@) is a sequence of at least three consecutive backtick characters (`` ` ``) or tildes (`~`). (Tildes and backticks cannot be mixed.) A [fenced code block](@) begins with a code fence, indented no more than three spaces. The line with the opening code fence may optionally contain some text following the code fence; this is trimmed of leading and trailing whitespace and called the [info string](@). If the [info string] comes after a backtick fence, it may not contain any backtick characters. (The reason for this restriction is that otherwise some inline code would be incorrectly interpreted as the beginning of a fenced code block.) The content of the code block consists of all subsequent lines, until a closing [code fence] of the same type as the code block began with (backticks or tildes), and with at least as many backticks or tildes as the opening code fence. If the leading code fence is indented N spaces, then up to N spaces of indentation are removed from each line of the content (if present). (If a content line is not indented, it is preserved unchanged. If it is indented less than N spaces, all of the indentation is removed.) The closing code fence may be indented up to three spaces, and may be followed only by spaces, which are ignored. If the end of the containing block (or document) is reached and no closing code fence has been found, the code block contains all of the lines after the opening code fence until the end of the containing block (or document). (An alternative spec would require backtracking in the event that a closing code fence is not found. But this makes parsing much less efficient, and there seems to be no real down side to the behavior described here.) A fenced code block may interrupt a paragraph, and does not require a blank line either before or after. The content of a code fence is treated as literal text, not parsed as inlines. The first word of the [info string] is typically used to specify the language of the code sample, and rendered in the `class` attribute of the `code` tag. However, this spec does not mandate any particular treatment of the [info string]. Here is a simple example with backticks: ```````````````````````````````` example ``` < > ``` . 
<
 >
```````````````````````````````` With tildes: ```````````````````````````````` example ~~~ < > ~~~ . 
<
 >
```````````````````````````````` Fewer than three backticks is not enough: ```````````````````````````````` example `` foo `` .

foo

```````````````````````````````` The closing code fence must use the same character as the opening fence: ```````````````````````````````` example ``` aaa ~~~ ``` . 
aaa
~~~
```````````````````````````````` ```````````````````````````````` example ~~~ aaa ``` ~~~ . 
aaa
```
```````````````````````````````` The closing code fence must be at least as long as the opening fence: ```````````````````````````````` example ```` aaa ``` `````` . 
aaa
```
```````````````````````````````` ```````````````````````````````` example ~~~~ aaa ~~~ ~~~~ . 
aaa
~~~
```````````````````````````````` Unclosed code blocks are closed by the end of the document (or the enclosing [block quote][block quotes] or [list item][list items]): ```````````````````````````````` example ``` .
```````````````````````````````` ```````````````````````````````` example ````` ``` aaa . 

```
aaa
```````````````````````````````` ```````````````````````````````` example > ``` > aaa bbb . 
aaa

bbb

```````````````````````````````` A code block can have all empty lines as its content: ```````````````````````````````` example ``` ``` .
```````````````````````````````` A code block can be empty: ```````````````````````````````` example ``` ``` .
```````````````````````````````` Fences can be indented. If the opening fence is indented, content lines will have equivalent opening indentation removed, if present: ```````````````````````````````` example ``` aaa aaa ``` . 
aaa
aaa
```````````````````````````````` ```````````````````````````````` example ``` aaa aaa aaa ``` . 
aaa
aaa
aaa
```````````````````````````````` ```````````````````````````````` example ``` aaa aaa aaa ``` . 
aaa
 aaa
aaa
```````````````````````````````` Four spaces indentation produces an indented code block: ```````````````````````````````` example ``` aaa ``` . 
```
aaa
```
```````````````````````````````` Closing fences may be indented by 0-3 spaces, and their indentation need not match that of the opening fence: ```````````````````````````````` example ``` aaa ``` . 
aaa
```````````````````````````````` ```````````````````````````````` example ``` aaa ``` . 
aaa
```````````````````````````````` This is not a closing fence, because it is indented 4 spaces: ```````````````````````````````` example ``` aaa ``` . 
aaa
    ```
```````````````````````````````` Code fences (opening and closing) cannot contain internal spaces: ```````````````````````````````` example ``` ``` aaa .

aaa

```````````````````````````````` ```````````````````````````````` example ~~~~~~ aaa ~~~ ~~ . 
aaa
~~~ ~~
```````````````````````````````` Fenced code blocks can interrupt paragraphs, and can be followed directly by paragraphs, without a blank line between: ```````````````````````````````` example foo ``` bar ``` baz .

foo

bar

baz

```````````````````````````````` Other blocks can also occur before and after fenced code blocks without an intervening blank line: ```````````````````````````````` example foo --- ~~~ bar ~~~ # baz .

foo

bar

baz

```````````````````````````````` An [info string] can be provided after the opening code fence. Although this spec doesn't mandate any particular treatment of the info string, the first word is typically used to specify the language of the code block. In HTML output, the language is normally indicated by adding a class to the `code` element consisting of `language-` followed by the language name. ```````````````````````````````` example ```ruby def foo(x) return 3 end ``` . 
def foo(x)
  return 3
end
```````````````````````````````` ```````````````````````````````` example ~~~~ ruby startline=3 $%@#$ def foo(x) return 3 end ~~~~~~~ . 
def foo(x)
  return 3
end
```````````````````````````````` ```````````````````````````````` example ````; ```` .
```````````````````````````````` [Info strings] for backtick code blocks cannot contain backticks: ```````````````````````````````` example ``` aa ``` foo .

aa foo

```````````````````````````````` [Info strings] for tilde code blocks can contain backticks and tildes: ```````````````````````````````` example ~~~ aa ``` ~~~ foo ~~~ . 
foo
```````````````````````````````` Closing code fences cannot have [info strings]: ```````````````````````````````` example ``` ``` aaa ``` . 
``` aaa
```````````````````````````````` ## HTML blocks An [HTML block](@) is a group of lines that is treated as raw HTML (and will not be escaped in HTML output). There are seven kinds of [HTML block], which can be defined by their start and end conditions. The block begins with a line that meets a [start condition](@) (after up to three spaces optional indentation). It ends with the first subsequent line that meets a matching [end condition](@), or the last line of the document, or the last line of the [container block](#container-blocks) containing the current HTML block, if no line is encountered that meets the [end condition]. If the first line meets both the [start condition] and the [end condition], the block will contain just that line. 1. **Start condition:** line begins with the string ``, or the end of the line.\ **End condition:** line contains an end tag ``, ``, or `` (case-insensitive; it need not match the start tag). 2. **Start condition:** line begins with the string ``. 3. **Start condition:** line begins with the string ``. 4. **Start condition:** line begins with the string ``. 5. **Start condition:** line begins with the string ``. 6. **Start condition:** line begins the string `<` or ``, or the string `/>`.\ **End condition:** line is followed by a [blank line]. 7. **Start condition:** line begins with a complete [open tag] (with any [tag name] other than `script`, `style`, or `pre`) or a complete [closing tag], followed only by [whitespace] or the end of the line.\ **End condition:** line is followed by a [blank line]. HTML blocks continue until they are closed by their appropriate [end condition], or the last line of the document or other [container block](#container-blocks). This means any HTML **within an HTML block** that might otherwise be recognised as a start condition will be ignored by the parser and passed through as-is, without changing the parser's state. For instance, `
` within a HTML block started by `` will not affect
the parser state; as the HTML block was started in by start condition 6, it
will end at any blank line. This can be surprising:

```````````````````````````````` example



**Hello**,

_world_.




.



**Hello**,

world.




````````````````````````````````

In this case, the HTML block is terminated by the newline — the `**Hello**`
text remains verbatim — and regular parsing resumes, with a paragraph,
emphasised `world` and inline and block HTML following.

All types of [HTML blocks] except type 7 may interrupt
a paragraph.  Blocks of type 7 may not interrupt a paragraph.
(This restriction is intended to prevent unwanted interpretation
of long tags inside a wrapped paragraph as starting HTML blocks.)

Some simple examples follow.  Here are some basic HTML blocks
of type 6:

```````````````````````````````` example


  

    
           hi
    
  




okay.
.


  

    
           hi
    
  




okay.

````````````````````````````````


```````````````````````````````` example
 
*foo*
````````````````````````````````


Here we have two HTML blocks with a Markdown paragraph between them:

```````````````````````````````` example



*Markdown*



.



Markdown



````````````````````````````````


The tag on the first line can be partial, as long
as it is split where there would be whitespace:

```````````````````````````````` example




.




````````````````````````````````


```````````````````````````````` example




.




````````````````````````````````


An open tag need not be closed:
```````````````````````````````` example


*foo*

*bar*
.


*foo*

bar

````````````````````````````````



A partial tag need not even be completed (garbage
in, garbage out):

```````````````````````````````` example

.

````````````````````````````````


```````````````````````````````` example


foo


.


foo


````````````````````````````````


Everything until the next blank line or end of document
gets included in the HTML block.  So, in the following
example, what looks like a Markdown code block
is actually part of the HTML block, which continues until a blank
line or the end of the document is reached:

```````````````````````````````` example


``` c
int x = 33;
```
.


``` c
int x = 33;
```
````````````````````````````````


To start an [HTML block] with a tag that is *not* in the
list of block-level tags in (6), you must put the tag by
itself on the first line (and it must be complete):

```````````````````````````````` example

*bar*

.

*bar*

````````````````````````````````


In type 7 blocks, the [tag name] can be anything:

```````````````````````````````` example

*bar*

.

*bar*

````````````````````````````````


```````````````````````````````` example

*bar*

.

*bar*

````````````````````````````````


```````````````````````````````` example

*bar*
.

*bar*
````````````````````````````````


These rules are designed to allow us to work with tags that
can function as either block-level or inline-level tags.
The `` tag is a nice example.  We can surround content with
`` tags in three different ways.  In this case, we get a raw
HTML block, because the `` tag is on a line by itself:

```````````````````````````````` example

*foo*

.

*foo*

````````````````````````````````


In this case, we get a raw HTML block that just includes
the `` tag (because it ends with the following blank
line).  So the contents get interpreted as CommonMark:

```````````````````````````````` example


*foo*


.


foo


````````````````````````````````


Finally, in this case, the `` tags are interpreted
as [raw HTML] *inside* the CommonMark paragraph.  (Because
the tag is not on a line by itself, we get inline HTML
rather than an [HTML block].)

```````````````````````````````` example
*foo*
.

foo

````````````````````````````````


HTML tags designed to contain literal content
(`script`, `style`, `pre`), comments, processing instructions,
and declarations are treated somewhat differently.
Instead of ending at the first blank line, these blocks
end at the first line containing a corresponding end tag.
As a result, these blocks can contain blank lines:

A pre tag (type 1):

```````````````````````````````` example


import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags


okay
.


import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags



okay

````````````````````````````````


A script tag (type 1):

```````````````````````````````` example

okay
.


okay

````````````````````````````````


A style tag (type 1):

```````````````````````````````` example

okay
.


okay

````````````````````````````````


If there is no matching end tag, the block will end at the
end of the document (or the enclosing [block quote][block quotes]
or [list item][list items]):

```````````````````````````````` example

*foo*
.


foo

````````````````````````````````


```````````````````````````````` example
*bar*
*baz*
.
*bar*

baz

````````````````````````````````


Note that anything on the last line after the
end tag will be included in the [HTML block]:

```````````````````````````````` example
1. *bar*
.
1. *bar*
````````````````````````````````


A comment (type 2):

```````````````````````````````` example

okay
.


okay

````````````````````````````````



A processing instruction (type 3):

```````````````````````````````` example
';

?>
okay
.
';

?>

okay

````````````````````````````````


A declaration (type 4):

```````````````````````````````` example

.

````````````````````````````````


CDATA (type 5):

```````````````````````````````` example

okay
.


okay

````````````````````````````````


The opening tag can be indented 1-3 spaces, but not 4:

```````````````````````````````` example
  

    
.
  

<!-- foo -->


````````````````````````````````


```````````````````````````````` example
  


    

.
  


<div>


````````````````````````````````


An HTML block of types 1--6 can interrupt a paragraph, and need not be
preceded by a blank line.

```````````````````````````````` example
Foo


bar


.

Foo



bar


````````````````````````````````


However, a following blank line is needed, except at the end of
a document, and except for blocks of types 1--5, [above][HTML
block]:

```````````````````````````````` example


bar


*foo*
.


bar


*foo*
````````````````````````````````


HTML blocks of type 7 cannot interrupt a paragraph:

```````````````````````````````` example
Foo

baz
.

Foo

baz

````````````````````````````````


This rule differs from John Gruber's original Markdown syntax
specification, which says:

> The only restrictions are that block-level HTML elements —
> e.g. `
`, ``, `
`, `
`, etc. — must be separated from
> surrounding content by blank lines, and the start and end tags of the
> block should not be indented with tabs or spaces.

In some ways Gruber's rule is more restrictive than the one given
here:

- It requires that an HTML block be preceded by a blank line.
- It does not allow the start tag to be indented.
- It requires a matching end tag, which it also does not allow to
  be indented.

Most Markdown implementations (including some of Gruber's own) do not
respect all of these restrictions.

There is one respect, however, in which Gruber's rule is more liberal
than the one given here, since it allows blank lines to occur inside
an HTML block.  There are two reasons for disallowing them here.
First, it removes the need to parse balanced tags, which is
expensive and can require backtracking from the end of the document
if no matching end tag is found. Second, it provides a very simple
and flexible way of including Markdown content inside HTML tags:
simply separate the Markdown from the HTML using blank lines:

Compare:

```````````````````````````````` example



*Emphasized* text.



.



Emphasized text.



````````````````````````````````


```````````````````````````````` example


*Emphasized* text.


.


*Emphasized* text.


````````````````````````````````


Some Markdown implementations have adopted a convention of
interpreting content inside tags as text if the open tag has
the attribute `markdown=1`.  The rule given above seems a simpler and
more elegant way of achieving the same expressive power, which is also
much simpler to parse.

The main potential drawback is that one can no longer paste HTML
blocks into Markdown documents with 100% reliability.  However,
*in most cases* this will work fine, because the blank lines in
HTML are usually followed by HTML block tags.  For example:

```````````````````````````````` example







Hi







.





Hi





````````````````````````````````


There are problems, however, if the inner tags are indented
*and* separated by spaces, as then they will be interpreted as
an indented code block:

```````````````````````````````` example



  


    
      Hi
    

  




.

<td>
  Hi
</td>


  


  



````````````````````````````````


Fortunately, blank lines are usually not necessary and can be
deleted.  The exception is inside `
` tags, but as described
[above][HTML blocks], raw HTML blocks starting with `
`
*can* contain blank lines.

## Link reference definitions

A [link reference definition](@)
consists of a [link label], indented up to three spaces, followed
by a colon (`:`), optional [whitespace] (including up to one
[line ending]), a [link destination],
optional [whitespace] (including up to one
[line ending]), and an optional [link
title], which if it is present must be separated
from the [link destination] by [whitespace].
No further [non-whitespace characters] may occur on the line.

A [link reference definition]
does not correspond to a structural element of a document.  Instead, it
defines a label which can be used in [reference links]
and reference-style [images] elsewhere in the document.  [Link
reference definitions] can come either before or after the links that use
them.

```````````````````````````````` example
[foo]: /url "title"

[foo]
.

foo

````````````````````````````````


```````````````````````````````` example
   [foo]: 
      /url  
           'the title'  

[foo]
.

foo

````````````````````````````````


```````````````````````````````` example
[Foo*bar\]]:my_(url) 'title (with parens)'

[Foo*bar\]]
.

Foo*bar]

````````````````````````````````


```````````````````````````````` example
[Foo bar]:

'title'

[Foo bar]
.

Foo bar

````````````````````````````````


The title may extend over multiple lines:

```````````````````````````````` example
[foo]: /url '
title
line1
line2
'

[foo]
.

foo

````````````````````````````````


However, it may not contain a [blank line]:

```````````````````````````````` example
[foo]: /url 'title

with blank line'

[foo]
.

[foo]: /url 'title


with blank line'


[foo]

````````````````````````````````


The title may be omitted:

```````````````````````````````` example
[foo]:
/url

[foo]
.

foo

````````````````````````````````


The link destination may not be omitted:

```````````````````````````````` example
[foo]:

[foo]
.

[foo]:


[foo]

````````````````````````````````

 However, an empty link destination may be specified using
 angle brackets:

```````````````````````````````` example
[foo]: <>

[foo]
.

foo

````````````````````````````````

The title must be separated from the link destination by
whitespace:

```````````````````````````````` example
[foo]: (baz)

[foo]
.

[foo]: (baz)


[foo]

````````````````````````````````


Both title and destination can contain backslash escapes
and literal backslashes:

```````````````````````````````` example
[foo]: /url\bar\*baz "foo\"bar\baz"

[foo]
.

foo

````````````````````````````````


A link can come before its corresponding definition:

```````````````````````````````` example
[foo]

[foo]: url
.

foo

````````````````````````````````


If there are several matching definitions, the first one takes
precedence:

```````````````````````````````` example
[foo]

[foo]: first
[foo]: second
.

foo

````````````````````````````````


As noted in the section on [Links], matching of labels is
case-insensitive (see [matches]).

```````````````````````````````` example
[FOO]: /url

[Foo]
.

Foo

````````````````````````````````


```````````````````````````````` example
[ΑΓΩ]: /φου

[αγω]
.

αγω

````````````````````````````````


Here is a link reference definition with no corresponding link.
It contributes nothing to the document.

```````````````````````````````` example
[foo]: /url
.
````````````````````````````````


Here is another one:

```````````````````````````````` example
[
foo
]: /url
bar
.

bar

````````````````````````````````


This is not a link reference definition, because there are
[non-whitespace characters] after the title:

```````````````````````````````` example
[foo]: /url "title" ok
.

[foo]: /url "title" ok

````````````````````````````````


This is a link reference definition, but it has no title:

```````````````````````````````` example
[foo]: /url
"title" ok
.

"title" ok

````````````````````````````````


This is not a link reference definition, because it is indented
four spaces:

```````````````````````````````` example
    [foo]: /url "title"

[foo]
.

[foo]: /url "title"



[foo]

````````````````````````````````


This is not a link reference definition, because it occurs inside
a code block:

```````````````````````````````` example
```
[foo]: /url
```

[foo]
.

[foo]: /url



[foo]

````````````````````````````````


A [link reference definition] cannot interrupt a paragraph.

```````````````````````````````` example
Foo
[bar]: /baz

[bar]
.

Foo
[bar]: /baz


[bar]

````````````````````````````````


However, it can directly follow other block elements, such as headings
and thematic breaks, and it need not be followed by a blank line.

```````````````````````````````` example
# [Foo]
[foo]: /url
> bar
.

Foo




bar



````````````````````````````````

```````````````````````````````` example
[foo]: /url
bar
===
[foo]
.

bar


foo

````````````````````````````````

```````````````````````````````` example
[foo]: /url
===
[foo]
.

===
foo

````````````````````````````````


Several [link reference definitions]
can occur one after another, without intervening blank lines.

```````````````````````````````` example
[foo]: /foo-url "foo"
[bar]: /bar-url
  "bar"
[baz]: /baz-url

[foo],
[bar],
[baz]
.

foo,
bar,
baz

````````````````````````````````


[Link reference definitions] can occur
inside block containers, like lists and block quotations.  They
affect the entire document, not just the container in which they
are defined:

```````````````````````````````` example
[foo]

> [foo]: /url
.

foo





````````````````````````````````


Whether something is a [link reference definition] is
independent of whether the link reference it defines is
used in the document.  Thus, for example, the following
document contains just a link reference definition, and
no visible content:

```````````````````````````````` example
[foo]: /url
.
````````````````````````````````


## Paragraphs

A sequence of non-blank lines that cannot be interpreted as other
kinds of blocks forms a [paragraph](@).
The contents of the paragraph are the result of parsing the
paragraph's raw content as inlines.  The paragraph's raw content
is formed by concatenating the lines and removing initial and final
[whitespace].

A simple example with two paragraphs:

```````````````````````````````` example
aaa

bbb
.

aaa


bbb

````````````````````````````````


Paragraphs can contain multiple lines, but no blank lines:

```````````````````````````````` example
aaa
bbb

ccc
ddd
.

aaa
bbb


ccc
ddd

````````````````````````````````


Multiple blank lines between paragraph have no effect:

```````````````````````````````` example
aaa


bbb
.

aaa


bbb

````````````````````````````````


Leading spaces are skipped:

```````````````````````````````` example
  aaa
 bbb
.

aaa
bbb

````````````````````````````````


Lines after the first may be indented any amount, since indented
code blocks cannot interrupt paragraphs.

```````````````````````````````` example
aaa
             bbb
                                       ccc
.

aaa
bbb
ccc

````````````````````````````````


However, the first line may be indented at most three spaces,
or an indented code block will be triggered:

```````````````````````````````` example
   aaa
bbb
.

aaa
bbb

````````````````````````````````


```````````````````````````````` example
    aaa
bbb
.

aaa



bbb

````````````````````````````````


Final spaces are stripped before inline parsing, so a paragraph
that ends with two or more spaces will not end with a [hard line
break]:

```````````````````````````````` example
aaa     
bbb     
.

aaa

bbb

````````````````````````````````


## Blank lines

[Blank lines] between block-level elements are ignored,
except for the role they play in determining whether a [list]
is [tight] or [loose].

Blank lines at the beginning and end of the document are also ignored.

```````````````````````````````` example
  

aaa
  

# aaa

  
.

aaa


aaa

````````````````````````````````



# Container blocks

A [container block](#container-blocks) is a block that has other
blocks as its contents.  There are two basic kinds of container blocks:
[block quotes] and [list items].
[Lists] are meta-containers for [list items].

We define the syntax for container blocks recursively.  The general
form of the definition is:

> If X is a sequence of blocks, then the result of
> transforming X in such-and-such a way is a container of type Y
> with these blocks as its content.

So, we explain what counts as a block quote or list item by explaining
how these can be *generated* from their contents. This should suffice
to define the syntax, although it does not give a recipe for *parsing*
these constructions.  (A recipe is provided below in the section entitled
[A parsing strategy](#appendix-a-parsing-strategy).)

## Block quotes

A [block quote marker](@)
consists of 0-3 spaces of initial indent, plus (a) the character `>` together
with a following space, or (b) a single character `>` not followed by a space.

The following rules define [block quotes]:

1.  **Basic case.**  If a string of lines *Ls* constitute a sequence
    of blocks *Bs*, then the result of prepending a [block quote
    marker] to the beginning of each line in *Ls*
    is a [block quote](#block-quotes) containing *Bs*.

2.  **Laziness.**  If a string of lines *Ls* constitute a [block
    quote](#block-quotes) with contents *Bs*, then the result of deleting
    the initial [block quote marker] from one or
    more lines in which the next [non-whitespace character] after the [block
    quote marker] is [paragraph continuation
    text] is a block quote with *Bs* as its content.
    [Paragraph continuation text](@) is text
    that will be parsed as part of the content of a paragraph, but does
    not occur at the beginning of the paragraph.

3.  **Consecutiveness.**  A document cannot contain two [block
    quotes] in a row unless there is a [blank line] between them.

Nothing else counts as a [block quote](#block-quotes).

Here is a simple example:

```````````````````````````````` example
> # Foo
> bar
> baz
.



Foo


bar
baz



````````````````````````````````


The spaces after the `>` characters can be omitted:

```````````````````````````````` example
># Foo
>bar
> baz
.



Foo


bar
baz



````````````````````````````````


The `>` characters can be indented 1-3 spaces:

```````````````````````````````` example
   > # Foo
   > bar
 > baz
.



Foo


bar
baz



````````````````````````````````


Four spaces gives us a code block:

```````````````````````````````` example
    > # Foo
    > bar
    > baz
.

> # Foo
> bar
> baz


````````````````````````````````


The Laziness clause allows us to omit the `>` before
[paragraph continuation text]:

```````````````````````````````` example
> # Foo
> bar
baz
.



Foo


bar
baz



````````````````````````````````


A block quote can contain some lazy and some non-lazy
continuation lines:

```````````````````````````````` example
> bar
baz
> foo
.



bar
baz
foo



````````````````````````````````


Laziness only applies to lines that would have been continuations of
paragraphs had they been prepended with [block quote markers].
For example, the `> ` cannot be omitted in the second line of

``` markdown
> foo
> ---
```

without changing the meaning:

```````````````````````````````` example
> foo
---
.



foo





````````````````````````````````


Similarly, if we omit the `> ` in the second line of

``` markdown
> - foo
> - bar
```

then the block quote ends after the first line:

```````````````````````````````` example
> - foo
- bar
.



    

  • foo
    • 





    

  • bar
    • 


````````````````````````````````


For the same reason, we can't omit the `> ` in front of
subsequent lines of an indented or fenced code block:

```````````````````````````````` example
>     foo
    bar
.



foo





bar


````````````````````````````````


```````````````````````````````` example
> ```
foo
```
.







foo



````````````````````````````````


Note that in the following case, we have a [lazy
continuation line]:

```````````````````````````````` example
> foo
    - bar
.



foo
- bar



````````````````````````````````


To see why, note that in

```markdown
> foo
>     - bar
```

the `- bar` is indented too far to start a list, and can't
be an indented code block because indented code blocks cannot
interrupt paragraphs, so it is [paragraph continuation text].

A block quote can be empty:

```````````````````````````````` example
>
.




````````````````````````````````


```````````````````````````````` example
>
>  
> 
.




````````````````````````````````


A block quote can have initial or final blank lines:

```````````````````````````````` example
>
> foo
>  
.



foo



````````````````````````````````


A blank line always separates block quotes:

```````````````````````````````` example
> foo

> bar
.



foo






bar



````````````````````````````````


(Most current Markdown implementations, including John Gruber's
original `Markdown.pl`, will parse this example as a single block quote
with two paragraphs.  But it seems better to allow the author to decide
whether two block quotes or one are wanted.)

Consecutiveness means that if we put these block quotes together,
we get a single block quote:

```````````````````````````````` example
> foo
> bar
.



foo
bar



````````````````````````````````


To get a block quote with two paragraphs, use:

```````````````````````````````` example
> foo
>
> bar
.



foo


bar



````````````````````````````````


Block quotes can interrupt paragraphs:

```````````````````````````````` example
foo
> bar
.

foo




bar



````````````````````````````````


In general, blank lines are not needed before or after block
quotes:

```````````````````````````````` example
> aaa
***
> bbb
.



aaa








bbb



````````````````````````````````


However, because of laziness, a blank line is needed between
a block quote and a following paragraph:

```````````````````````````````` example
> bar
baz
.



bar
baz



````````````````````````````````


```````````````````````````````` example
> bar

baz
.



bar




baz

````````````````````````````````


```````````````````````````````` example
> bar
>
baz
.



bar




baz

````````````````````````````````


It is a consequence of the Laziness rule that any number
of initial `>`s may be omitted on a continuation line of a
nested block quote:

```````````````````````````````` example
> > > foo
bar
.







foo
bar







````````````````````````````````


```````````````````````````````` example
>>> foo
> bar
>>baz
.







foo
bar
baz







````````````````````````````````


When including an indented code block in a block quote,
remember that the [block quote marker] includes
both the `>` and a following space.  So *five spaces* are needed after
the `>`:

```````````````````````````````` example
>     code

>    not code
.



code







not code



````````````````````````````````



## List items

A [list marker](@) is a
[bullet list marker] or an [ordered list marker].

A [bullet list marker](@)
is a `-`, `+`, or `*` character.

An [ordered list marker](@)
is a sequence of 1--9 arabic digits (`0-9`), followed by either a
`.` character or a `)` character.  (The reason for the length
limit is that with 10 digits we start seeing integer overflows
in some browsers.)

The following rules define [list items]:

1.  **Basic case.**  If a sequence of lines *Ls* constitute a sequence of
    blocks *Bs* starting with a [non-whitespace character], and *M* is a
    list marker of width *W* followed by 1 ≤ *N* ≤ 4 spaces, then the result
    of prepending *M* and the following spaces to the first line of
    *Ls*, and indenting subsequent lines of *Ls* by *W + N* spaces, is a
    list item with *Bs* as its contents.  The type of the list item
    (bullet or ordered) is determined by the type of its list marker.
    If the list item is ordered, then it is also assigned a start
    number, based on the ordered list marker.

    Exceptions:

    1. When the first list item in a [list] interrupts
       a paragraph---that is, when it starts on a line that would
       otherwise count as [paragraph continuation text]---then (a)
       the lines *Ls* must not begin with a blank line, and (b) if
       the list item is ordered, the start number must be 1.
    2. If any line is a [thematic break][thematic breaks] then
       that line is not a list item.

For example, let *Ls* be the lines

```````````````````````````````` example
A paragraph
with two lines.

    indented code

> A block quote.
.

A paragraph
with two lines.


indented code





A block quote.



````````````````````````````````


And let *M* be the marker `1.`, and *N* = 2.  Then rule #1 says
that the following is an ordered list item with start number 1,
and the same contents as *Ls*:

```````````````````````````````` example
1.  A paragraph
    with two lines.

        indented code

    > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


The most important thing to notice is that the position of
the text after the list marker determines how much indentation
is needed in subsequent blocks in the list item.  If the list
marker takes up two spaces, and there are three spaces between
the list marker and the next [non-whitespace character], then blocks
must be indented five spaces in order to fall under the list
item.

Here are some examples showing how far content must be indented to be
put under the list item:

```````````````````````````````` example
- one

 two
.

    

  • one
    • 



two

````````````````````````````````


```````````````````````````````` example
- one

  two
.

    

  • 

    one
    

    two
    

    • 


````````````````````````````````


```````````````````````````````` example
 -    one

     two
.

    

  • one
    • 



 two


````````````````````````````````


```````````````````````````````` example
 -    one

      two
.

    

  • 

    one
    

    two
    

    • 


````````````````````````````````


It is tempting to think of this in terms of columns:  the continuation
blocks must be indented at least to the column of the first
[non-whitespace character] after the list marker. However, that is not quite right.
The spaces after the list marker determine how much relative indentation
is needed.  Which column this indentation reaches will depend on
how the list item is embedded in other constructions, as shown by
this example:

```````````````````````````````` example
   > > 1.  one
>>
>>     two
.





    

  1. 

    one
    

    two
    

    2. 






````````````````````````````````


Here `two` occurs in the same column as the list marker `1.`,
but is actually contained in the list item, because there is
sufficient indentation after the last containing blockquote marker.

The converse is also possible.  In the following example, the word `two`
occurs far to the right of the initial text of the list item, `one`, but
it is not considered part of the list item, because it is not indented
far enough past the blockquote marker:

```````````````````````````````` example
>>- one
>>
  >  > two
.





    

  • one
    • 



two





````````````````````````````````


Note that at least one space is needed between the list marker and
any following content, so these are not list items:

```````````````````````````````` example
-one

2.two
.

-one


2.two

````````````````````````````````


A list item may contain blocks that are separated by more than
one blank line.

```````````````````````````````` example
- foo


  bar
.

    

  • 

    foo
    

    bar
    

    • 


````````````````````````````````


A list item may contain any kind of block:

```````````````````````````````` example
1.  foo

    ```
    bar
    ```

    baz

    > bam
.

    

  1. 

    foo
    

    bar

    

    baz
    

    

    bam
    

    

    2. 


````````````````````````````````


A list item that contains an indented code block will preserve
empty lines within the code block verbatim.

```````````````````````````````` example
- Foo

      bar


      baz
.

    

  • 

    Foo
    

    bar


baz

    

    • 


````````````````````````````````

Note that ordered list start numbers must be nine digits or less:

```````````````````````````````` example
123456789. ok
.

    

  1. ok
    2. 


````````````````````````````````


```````````````````````````````` example
1234567890. not ok
.

1234567890. not ok

````````````````````````````````


A start number may begin with 0s:

```````````````````````````````` example
0. ok
.

    

  1. ok
    2. 


````````````````````````````````


```````````````````````````````` example
003. ok
.

    

  1. ok
    2. 


````````````````````````````````


A start number may not be negative:

```````````````````````````````` example
-1. not ok
.

-1. not ok

````````````````````````````````



2.  **Item starting with indented code.**  If a sequence of lines *Ls*
    constitute a sequence of blocks *Bs* starting with an indented code
    block, and *M* is a list marker of width *W* followed by
    one space, then the result of prepending *M* and the following
    space to the first line of *Ls*, and indenting subsequent lines of
    *Ls* by *W + 1* spaces, is a list item with *Bs* as its contents.
    If a line is empty, then it need not be indented.  The type of the
    list item (bullet or ordered) is determined by the type of its list
    marker.  If the list item is ordered, then it is also assigned a
    start number, based on the ordered list marker.

An indented code block will have to be indented four spaces beyond
the edge of the region where text will be included in the list item.
In the following case that is 6 spaces:

```````````````````````````````` example
- foo

      bar
.

    

  • 

    foo
    

    bar

    

    • 


````````````````````````````````


And in this case it is 11 spaces:

```````````````````````````````` example
  10.  foo

           bar
.

    

  1. 

    foo
    

    bar

    

    2. 


````````````````````````````````


If the *first* block in the list item is an indented code block,
then by rule #2, the contents must be indented *one* space after the
list marker:

```````````````````````````````` example
    indented code

paragraph

    more code
.

indented code



paragraph


more code


````````````````````````````````


```````````````````````````````` example
1.     indented code

   paragraph

       more code
.

    

  1. 

    indented code

    

    paragraph
    

    more code

    

    2. 


````````````````````````````````


Note that an additional space indent is interpreted as space
inside the code block:

```````````````````````````````` example
1.      indented code

   paragraph

       more code
.

    

  1. 

     indented code

    

    paragraph
    

    more code

    

    2. 


````````````````````````````````


Note that rules #1 and #2 only apply to two cases:  (a) cases
in which the lines to be included in a list item begin with a
[non-whitespace character], and (b) cases in which
they begin with an indented code
block.  In a case like the following, where the first block begins with
a three-space indent, the rules do not allow us to form a list item by
indenting the whole thing and prepending a list marker:

```````````````````````````````` example
   foo

bar
.

foo


bar

````````````````````````````````


```````````````````````````````` example
-    foo

  bar
.

    

  • foo
    • 



bar

````````````````````````````````


This is not a significant restriction, because when a block begins
with 1-3 spaces indent, the indentation can always be removed without
a change in interpretation, allowing rule #1 to be applied.  So, in
the above case:

```````````````````````````````` example
-  foo

   bar
.

    

  • 

    foo
    

    bar
    

    • 


````````````````````````````````


3.  **Item starting with a blank line.**  If a sequence of lines *Ls*
    starting with a single [blank line] constitute a (possibly empty)
    sequence of blocks *Bs*, not separated from each other by more than
    one blank line, and *M* is a list marker of width *W*,
    then the result of prepending *M* to the first line of *Ls*, and
    indenting subsequent lines of *Ls* by *W + 1* spaces, is a list
    item with *Bs* as its contents.
    If a line is empty, then it need not be indented.  The type of the
    list item (bullet or ordered) is determined by the type of its list
    marker.  If the list item is ordered, then it is also assigned a
    start number, based on the ordered list marker.

Here are some list items that start with a blank line but are not empty:

```````````````````````````````` example
-
  foo
-
  ```
  bar
  ```
-
      baz
.

    

  • foo
    • 

  • 

    bar

    

    • 

  • 

    baz

    

    • 


````````````````````````````````

When the list item starts with a blank line, the number of spaces
following the list marker doesn't change the required indentation:

```````````````````````````````` example
-   
  foo
.

    

  • foo
    • 


````````````````````````````````


A list item can begin with at most one blank line.
In the following example, `foo` is not part of the list
item:

```````````````````````````````` example
-

  foo
.

    

  • 



foo

````````````````````````````````


Here is an empty bullet list item:

```````````````````````````````` example
- foo
-
- bar
.

    

  • foo
    • 

  • 

  • bar
    • 


````````````````````````````````


It does not matter whether there are spaces following the [list marker]:

```````````````````````````````` example
- foo
-   
- bar
.

    

  • foo
    • 

  • 

  • bar
    • 


````````````````````````````````


Here is an empty ordered list item:

```````````````````````````````` example
1. foo
2.
3. bar
.

    

  1. foo
    2. 

  2. 

  3. bar
    4. 


````````````````````````````````


A list may start or end with an empty list item:

```````````````````````````````` example
*
.

    

  • 


````````````````````````````````

However, an empty list item cannot interrupt a paragraph:

```````````````````````````````` example
foo
*

foo
1.
.

foo
*


foo
1.

````````````````````````````````


4.  **Indentation.**  If a sequence of lines *Ls* constitutes a list item
    according to rule #1, #2, or #3, then the result of indenting each line
    of *Ls* by 1-3 spaces (the same for each line) also constitutes a
    list item with the same contents and attributes.  If a line is
    empty, then it need not be indented.

Indented one space:

```````````````````````````````` example
 1.  A paragraph
     with two lines.

         indented code

     > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Indented two spaces:

```````````````````````````````` example
  1.  A paragraph
      with two lines.

          indented code

      > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Indented three spaces:

```````````````````````````````` example
   1.  A paragraph
       with two lines.

           indented code

       > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Four spaces indent gives a code block:

```````````````````````````````` example
    1.  A paragraph
        with two lines.

            indented code

        > A block quote.
.

1.  A paragraph
    with two lines.

        indented code

    > A block quote.


````````````````````````````````



5.  **Laziness.**  If a string of lines *Ls* constitute a [list
    item](#list-items) with contents *Bs*, then the result of deleting
    some or all of the indentation from one or more lines in which the
    next [non-whitespace character] after the indentation is
    [paragraph continuation text] is a
    list item with the same contents and attributes.  The unindented
    lines are called
    [lazy continuation line](@)s.

Here is an example with [lazy continuation lines]:

```````````````````````````````` example
  1.  A paragraph
with two lines.

          indented code

      > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Indentation can be partially deleted:

```````````````````````````````` example
  1.  A paragraph
    with two lines.
.

    

  1. A paragraph
with two lines.
    2. 


````````````````````````````````


These examples show how laziness can work in nested structures:

```````````````````````````````` example
> 1. > Blockquote
continued here.
.



    

  1. 

    

    Blockquote
continued here.
    

    

    2. 




````````````````````````````````


```````````````````````````````` example
> 1. > Blockquote
> continued here.
.



    

  1. 

    

    Blockquote
continued here.
    

    

    2. 




````````````````````````````````



6.  **That's all.** Nothing that is not counted as a list item by rules
    #1--5 counts as a [list item](#list-items).

The rules for sublists follow from the general rules
[above][List items].  A sublist must be indented the same number
of spaces a paragraph would need to be in order to be included
in the list item.

So, in this case we need two spaces indent:

```````````````````````````````` example
- foo
  - bar
    - baz
      - boo
.

    

  • foo

      

    • bar

        

      • baz

          

        • boo
          • 

        

        • 

      

      • 

    

    • 


````````````````````````````````


One is not enough:

```````````````````````````````` example
- foo
 - bar
  - baz
   - boo
.

    

  • foo
    • 

  • bar
    • 

  • baz
    • 

  • boo
    • 


````````````````````````````````


Here we need four, because the list marker is wider:

```````````````````````````````` example
10) foo
    - bar
.

    

  1. foo

      

    • bar
      • 

    

    2. 


````````````````````````````````


Three is not enough:

```````````````````````````````` example
10) foo
   - bar
.

    

  1. foo
    2. 



    

  • bar
    • 


````````````````````````````````


A list may be the first block in a list item:

```````````````````````````````` example
- - foo
.

    

  • 

      

    • foo
      • 

    

    • 


````````````````````````````````


```````````````````````````````` example
1. - 2. foo
.

    

  1. 

      

    • 

        

      1. foo
        2. 

      

      • 

    

    2. 


````````````````````````````````


A list item can contain a heading:

```````````````````````````````` example
- # Foo
- Bar
  ---
  baz
.

    

  • 

    Foo
    

    • 

  • 

    Bar
    
baz
    • 


````````````````````````````````


### Motivation

John Gruber's Markdown spec says the following about list items:

1. "List markers typically start at the left margin, but may be indented
   by up to three spaces. List markers must be followed by one or more
   spaces or a tab."

2. "To make lists look nice, you can wrap items with hanging indents....
   But if you don't want to, you don't have to."

3. "List items may consist of multiple paragraphs. Each subsequent
   paragraph in a list item must be indented by either 4 spaces or one
   tab."

4. "It looks nice if you indent every line of the subsequent paragraphs,
   but here again, Markdown will allow you to be lazy."

5. "To put a blockquote within a list item, the blockquote's `>`
   delimiters need to be indented."

6. "To put a code block within a list item, the code block needs to be
   indented twice — 8 spaces or two tabs."

These rules specify that a paragraph under a list item must be indented
four spaces (presumably, from the left margin, rather than the start of
the list marker, but this is not said), and that code under a list item
must be indented eight spaces instead of the usual four.  They also say
that a block quote must be indented, but not by how much; however, the
example given has four spaces indentation.  Although nothing is said
about other kinds of block-level content, it is certainly reasonable to
infer that *all* block elements under a list item, including other
lists, must be indented four spaces.  This principle has been called the
*four-space rule*.

The four-space rule is clear and principled, and if the reference
implementation `Markdown.pl` had followed it, it probably would have
become the standard.  However, `Markdown.pl` allowed paragraphs and
sublists to start with only two spaces indentation, at least on the
outer level.  Worse, its behavior was inconsistent: a sublist of an
outer-level list needed two spaces indentation, but a sublist of this
sublist needed three spaces.  It is not surprising, then, that different
implementations of Markdown have developed very different rules for
determining what comes under a list item.  (Pandoc and python-Markdown,
for example, stuck with Gruber's syntax description and the four-space
rule, while discount, redcarpet, marked, PHP Markdown, and others
followed `Markdown.pl`'s behavior more closely.)

Unfortunately, given the divergences between implementations, there
is no way to give a spec for list items that will be guaranteed not
to break any existing documents.  However, the spec given here should
correctly handle lists formatted with either the four-space rule or
the more forgiving `Markdown.pl` behavior, provided they are laid out
in a way that is natural for a human to read.

The strategy here is to let the width and indentation of the list marker
determine the indentation necessary for blocks to fall under the list
item, rather than having a fixed and arbitrary number.  The writer can
think of the body of the list item as a unit which gets indented to the
right enough to fit the list marker (and any indentation on the list
marker).  (The laziness rule, #5, then allows continuation lines to be
unindented if needed.)

This rule is superior, we claim, to any rule requiring a fixed level of
indentation from the margin.  The four-space rule is clear but
unnatural. It is quite unintuitive that

``` markdown
- foo

  bar

  - baz
```

should be parsed as two lists with an intervening paragraph,

``` html

    

  • foo
    • 



bar


    

  • baz
    • 


```

as the four-space rule demands, rather than a single list,

``` html

    

  • 

    foo
    

    bar
    

      

    • baz
      • 

    

    • 


```

The choice of four spaces is arbitrary.  It can be learned, but it is
not likely to be guessed, and it trips up beginners regularly.

Would it help to adopt a two-space rule?  The problem is that such
a rule, together with the rule allowing 1--3 spaces indentation of the
initial list marker, allows text that is indented *less than* the
original list marker to be included in the list item. For example,
`Markdown.pl` parses

``` markdown
   - one

  two
```

as a single list item, with `two` a continuation paragraph:

``` html

    

  • 

    one
    

    two
    

    • 


```

and similarly

``` markdown
>   - one
>
>  two
```

as

``` html



    

  • 

    one
    

    two
    

    • 




```

This is extremely unintuitive.

Rather than requiring a fixed indent from the margin, we could require
a fixed indent (say, two spaces, or even one space) from the list marker (which
may itself be indented).  This proposal would remove the last anomaly
discussed.  Unlike the spec presented above, it would count the following
as a list item with a subparagraph, even though the paragraph `bar`
is not indented as far as the first paragraph `foo`:

``` markdown
 10. foo

   bar  
```

Arguably this text does read like a list item with `bar` as a subparagraph,
which may count in favor of the proposal.  However, on this proposal indented
code would have to be indented six spaces after the list marker.  And this
would break a lot of existing Markdown, which has the pattern:

``` markdown
1.  foo

        indented code
```

where the code is indented eight spaces.  The spec above, by contrast, will
parse this text as expected, since the code block's indentation is measured
from the beginning of `foo`.

The one case that needs special treatment is a list item that *starts*
with indented code.  How much indentation is required in that case, since
we don't have a "first paragraph" to measure from?  Rule #2 simply stipulates
that in such cases, we require one space indentation from the list marker
(and then the normal four spaces for the indented code).  This will match the
four-space rule in cases where the list marker plus its initial indentation
takes four spaces (a common case), but diverge in other cases.

## Lists

A [list](@) is a sequence of one or more
list items [of the same type].  The list items
may be separated by any number of blank lines.

Two list items are [of the same type](@)
if they begin with a [list marker] of the same type.
Two list markers are of the
same type if (a) they are bullet list markers using the same character
(`-`, `+`, or `*`) or (b) they are ordered list numbers with the same
delimiter (either `.` or `)`).

A list is an [ordered list](@)
if its constituent list items begin with
[ordered list markers], and a
[bullet list](@) if its constituent list
items begin with [bullet list markers].

The [start number](@)
of an [ordered list] is determined by the list number of
its initial list item.  The numbers of subsequent list items are
disregarded.

A list is [loose](@) if any of its constituent
list items are separated by blank lines, or if any of its constituent
list items directly contain two block-level elements with a blank line
between them.  Otherwise a list is [tight](@).
(The difference in HTML output is that paragraphs in a loose list are
wrapped in `
` tags, while paragraphs in a tight list are not.)

Changing the bullet or ordered list delimiter starts a new list:

```````````````````````````````` example
- foo
- bar
+ baz
.

    

  • foo
    • 

  • bar
    • 



    

  • baz
    • 


````````````````````````````````


```````````````````````````````` example
1. foo
2. bar
3) baz
.

    

  1. foo
    2. 

  2. bar
    3. 



    

  1. baz
    2. 


````````````````````````````````


In CommonMark, a list can interrupt a paragraph. That is,
no blank line is needed to separate a paragraph from a following
list:

```````````````````````````````` example
Foo
- bar
- baz
.

Foo


    

  • bar
    • 

  • baz
    • 


````````````````````````````````

`Markdown.pl` does not allow this, through fear of triggering a list
via a numeral in a hard-wrapped line:

``` markdown
The number of windows in my house is
14.  The number of doors is 6.
```

Oddly, though, `Markdown.pl` *does* allow a blockquote to
interrupt a paragraph, even though the same considerations might
apply.

In CommonMark, we do allow lists to interrupt paragraphs, for
two reasons.  First, it is natural and not uncommon for people
to start lists without blank lines:

``` markdown
I need to buy
- new shoes
- a coat
- a plane ticket
```

Second, we are attracted to a

> [principle of uniformity](@):
> if a chunk of text has a certain
> meaning, it will continue to have the same meaning when put into a
> container block (such as a list item or blockquote).

(Indeed, the spec for [list items] and [block quotes] presupposes
this principle.) This principle implies that if

``` markdown
  * I need to buy
    - new shoes
    - a coat
    - a plane ticket
```

is a list item containing a paragraph followed by a nested sublist,
as all Markdown implementations agree it is (though the paragraph
may be rendered without `
` tags, since the list is "tight"),
then

``` markdown
I need to buy
- new shoes
- a coat
- a plane ticket
```

by itself should be a paragraph followed by a nested sublist.

Since it is well established Markdown practice to allow lists to
interrupt paragraphs inside list items, the [principle of
uniformity] requires us to allow this outside list items as
well.  ([reStructuredText](http://docutils.sourceforge.net/rst.html)
takes a different approach, requiring blank lines before lists
even inside other list items.)

In order to solve of unwanted lists in paragraphs with
hard-wrapped numerals, we allow only lists starting with `1` to
interrupt paragraphs.  Thus,

```````````````````````````````` example
The number of windows in my house is
14.  The number of doors is 6.
.

The number of windows in my house is
14.  The number of doors is 6.

````````````````````````````````

We may still get an unintended result in cases like

```````````````````````````````` example
The number of windows in my house is
1.  The number of doors is 6.
.

The number of windows in my house is


    

  1. The number of doors is 6.
    2. 


````````````````````````````````

but this rule should prevent most spurious list captures.

There can be any number of blank lines between items:

```````````````````````````````` example
- foo

- bar


- baz
.

    

  • 

    foo
    

    • 

  • 

    bar
    

    • 

  • 

    baz
    

    • 


````````````````````````````````

```````````````````````````````` example
- foo
  - bar
    - baz


      bim
.

    

  • foo

      

    • bar

        

      • 

        baz
        

        bim
        

        • 

      

      • 

    

    • 


````````````````````````````````


To separate consecutive lists of the same type, or to separate a
list from an indented code block that would otherwise be parsed
as a subparagraph of the final list item, you can insert a blank HTML
comment:

```````````````````````````````` example
- foo
- bar



- baz
- bim
.

    

  • foo
    • 

  • bar
    • 




    

  • baz
    • 

  • bim
    • 


````````````````````````````````


```````````````````````````````` example
-   foo

    notcode

-   foo



    code
.

    

  • 

    foo
    

    notcode
    

    • 

  • 

    foo
    

    • 




code


````````````````````````````````


List items need not be indented to the same level.  The following
list items will be treated as items at the same list level,
since none is indented enough to belong to the previous list
item:

```````````````````````````````` example
- a
 - b
  - c
   - d
  - e
 - f
- g
.

    

  • a
    • 

  • b
    • 

  • c
    • 

  • d
    • 

  • e
    • 

  • f
    • 

  • g
    • 


````````````````````````````````


```````````````````````````````` example
1. a

  2. b

   3. c
.

    

  1. 

    a
    

    2. 

  2. 

    b
    

    3. 

  3. 

    c
    

    4. 


````````````````````````````````

Note, however, that list items may not be indented more than
three spaces.  Here `- e` is treated as a paragraph continuation
line, because it is indented more than three spaces:

```````````````````````````````` example
- a
 - b
  - c
   - d
    - e
.

    

  • a
    • 

  • b
    • 

  • c
    • 

  • d
- e
    • 


````````````````````````````````

And here, `3. c` is treated as in indented code block,
because it is indented four spaces and preceded by a
blank line.

```````````````````````````````` example
1. a

  2. b

    3. c
.

    

  1. 

    a
    

    2. 

  2. 

    b
    

    3. 



3. c


````````````````````````````````


This is a loose list, because there is a blank line between
two of the list items:

```````````````````````````````` example
- a
- b

- c
.

    

  • 

    a
    

    • 

  • 

    b
    

    • 

  • 

    c
    

    • 


````````````````````````````````


So is this, with a empty second item:

```````````````````````````````` example
* a
*

* c
.

    

  • 

    a
    

    • 

  • 

  • 

    c
    

    • 


````````````````````````````````


These are loose lists, even though there is no space between the items,
because one of the items directly contains two block-level elements
with a blank line between them:

```````````````````````````````` example
- a
- b

  c
- d
.

    

  • 

    a
    

    • 

  • 

    b
    

    c
    

    • 

  • 

    d
    

    • 


````````````````````````````````


```````````````````````````````` example
- a
- b

  [ref]: /url
- d
.

    

  • 

    a
    

    • 

  • 

    b
    

    • 

  • 

    d
    

    • 


````````````````````````````````


This is a tight list, because the blank lines are in a code block:

```````````````````````````````` example
- a
- ```
  b


  ```
- c
.

    

  • a
    • 

  • 

    b



    

    • 

  • c
    • 


````````````````````````````````


This is a tight list, because the blank line is between two
paragraphs of a sublist.  So the sublist is loose while
the outer list is tight:

```````````````````````````````` example
- a
  - b

    c
- d
.

    

  • a

      

    • 

      b
      

      c
      

      • 

    

    • 

  • d
    • 


````````````````````````````````


This is a tight list, because the blank line is inside the
block quote:

```````````````````````````````` example
* a
  > b
  >
* c
.

    

  • a

    

    b
    

    

    • 

  • c
    • 


````````````````````````````````


This list is tight, because the consecutive block elements
are not separated by blank lines:

```````````````````````````````` example
- a
  > b
  ```
  c
  ```
- d
.

    

  • a

    

    b
    

    

    c

    

    • 

  • d
    • 


````````````````````````````````


A single-paragraph list is tight:

```````````````````````````````` example
- a
.

    

  • a
    • 


````````````````````````````````


```````````````````````````````` example
- a
  - b
.

    

  • a

      

    • b
      • 

    

    • 


````````````````````````````````


This list is loose, because of the blank line between the
two block elements in the list item:

```````````````````````````````` example
1. ```
   foo
   ```

   bar
.

    

  1. 

    foo

    

    bar
    

    2. 


````````````````````````````````


Here the outer list is loose, the inner list tight:

```````````````````````````````` example
* foo
  * bar

  baz
.

    

  • 

    foo
    

      

    • bar
      • 

    

    baz
    

    • 


````````````````````````````````


```````````````````````````````` example
- a
  - b
  - c

- d
  - e
  - f
.

    

  • 

    a
    

      

    • b
      • 

    • c
      • 

    

    • 

  • 

    d
    

      

    • e
      • 

    • f
      • 

    

    • 


````````````````````````````````


# Inlines

Inlines are parsed sequentially from the beginning of the character
stream to the end (left to right, in left-to-right languages).
Thus, for example, in

```````````````````````````````` example
`hi`lo`
.

hilo`

````````````````````````````````

`hi` is parsed as code, leaving the backtick at the end as a literal
backtick.


## Backslash escapes

Any ASCII punctuation character may be backslash-escaped:

```````````````````````````````` example
\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~
.

!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

````````````````````````````````


Backslashes before other characters are treated as literal
backslashes:

```````````````````````````````` example
\→\A\a\ \3\φ\«
.

\→\A\a\ \3\φ\«

````````````````````````````````


Escaped characters are treated as regular characters and do
not have their usual Markdown meanings:

```````````````````````````````` example
\*not emphasized*
\
 not a tag
\[not a link](/foo)
\`not code`
1\. not a list
\* not a list
\# not a heading
\[foo]: /url "not a reference"
\ö not a character entity
.

*not emphasized*
<br/> not a tag
[not a link](/foo)
`not code`
1. not a list
* not a list
# not a heading
[foo]: /url "not a reference"
&ouml; not a character entity

````````````````````````````````


If a backslash is itself escaped, the following character is not:

```````````````````````````````` example
\\*emphasis*
.

\emphasis

````````````````````````````````


A backslash at the end of the line is a [hard line break]:

```````````````````````````````` example
foo\
bar
.

foo

bar

````````````````````````````````


Backslash escapes do not work in code blocks, code spans, autolinks, or
raw HTML:

```````````````````````````````` example
`` \[\` ``
.

\[\`

````````````````````````````````


```````````````````````````````` example
    \[\]
.

\[\]


````````````````````````````````


```````````````````````````````` example
~~~
\[\]
~~~
.

\[\]


````````````````````````````````


```````````````````````````````` example

.

http://example.com?find=\*

````````````````````````````````


```````````````````````````````` example

.

````````````````````````````````


But they work in all other contexts, including URLs and link titles,
link references, and [info strings] in [fenced code blocks]:

```````````````````````````````` example
[foo](/bar\* "ti\*tle")
.

foo

````````````````````````````````


```````````````````````````````` example
[foo]

[foo]: /bar\* "ti\*tle"
.

foo

````````````````````````````````


```````````````````````````````` example
``` foo\+bar
foo
```
.

foo


````````````````````````````````



## Entity and numeric character references

Valid HTML entity references and numeric character references
can be used in place of the corresponding Unicode character,
with the following exceptions:

- Entity and character references are not recognized in code
  blocks and code spans.

- Entity and character references cannot stand in place of
  special characters that define structural elements in
  CommonMark.  For example, although `*` can be used
  in place of a literal `*` character, `*` cannot replace
  `*` in emphasis delimiters, bullet list markers, or thematic
  breaks.

Conforming CommonMark parsers need not store information about
whether a particular character was represented in the source
using a Unicode character or an entity reference.

[Entity references](@) consist of `&` + any of the valid
HTML5 entity names + `;`. The
document 
is used as an authoritative source for the valid entity
references and their corresponding code points.

```````````````````````````````` example
  & © Æ Ď
¾ ℋ ⅆ
∲ ≧̸
.

  & © Æ Ď
¾ ℋ ⅆ
∲ ≧̸

````````````````````````````````


[Decimal numeric character
references](@)
consist of `&#` + a string of 1--7 arabic digits + `;`. A
numeric character reference is parsed as the corresponding
Unicode character. Invalid Unicode code points will be replaced by
the REPLACEMENT CHARACTER (`U+FFFD`).  For security reasons,
the code point `U+0000` will also be replaced by `U+FFFD`.

```````````````````````````````` example
# Ӓ Ϡ �
.

# Ӓ Ϡ �

````````````````````````````````


[Hexadecimal numeric character
references](@) consist of `&#` +
either `X` or `x` + a string of 1-6 hexadecimal digits + `;`.
They too are parsed as the corresponding Unicode character (this
time specified with a hexadecimal numeral instead of decimal).

```````````````````````````````` example
" ആ ಫ
.

" ആ ಫ

````````````````````````````````


Here are some nonentities:

```````````````````````````````` example
  &x; &#; &#x;
�
&#abcdef0;
&ThisIsNotDefined; &hi?;
.

&nbsp &x; &#; &#x;
&#987654321;
&#abcdef0;
&ThisIsNotDefined; &hi?;

````````````````````````````````


Although HTML5 does accept some entity references
without a trailing semicolon (such as `©`), these are not
recognized here, because it makes the grammar too ambiguous:

```````````````````````````````` example
©
.

&copy

````````````````````````````````


Strings that are not on the list of HTML5 named entities are not
recognized as entity references either:

```````````````````````````````` example
&MadeUpEntity;
.

&MadeUpEntity;

````````````````````````````````


Entity and numeric character references are recognized in any
context besides code spans or code blocks, including
URLs, [link titles], and [fenced code block][] [info strings]:

```````````````````````````````` example

.

````````````````````````````````


```````````````````````````````` example
[foo](/föö "föö")
.

foo

````````````````````````````````


```````````````````````````````` example
[foo]

[foo]: /föö "föö"
.

foo

````````````````````````````````


```````````````````````````````` example
``` föö
foo
```
.

foo


````````````````````````````````


Entity and numeric character references are treated as literal
text in code spans and code blocks:

```````````````````````````````` example
`föö`
.

f&ouml;&ouml;

````````````````````````````````


```````````````````````````````` example
    föfö
.

f&ouml;f&ouml;


````````````````````````````````


Entity and numeric character references cannot be used
in place of symbols indicating structure in CommonMark
documents.

```````````````````````````````` example
*foo*
*foo*
.

*foo*
foo

````````````````````````````````

```````````````````````````````` example
* foo

* foo
.

* foo


    

  • foo
    • 


````````````````````````````````

```````````````````````````````` example
foo

bar
.

foo

bar

````````````````````````````````

```````````````````````````````` example
	foo
.

→foo

````````````````````````````````


```````````````````````````````` example
[a](url "tit")
.

[a](url "tit")

````````````````````````````````


## Code spans

A [backtick string](@)
is a string of one or more backtick characters (`` ` ``) that is neither
preceded nor followed by a backtick.

A [code span](@) begins with a backtick string and ends with
a backtick string of equal length.  The contents of the code span are
the characters between the two backtick strings, normalized in the
following ways:

- First, [line endings] are converted to [spaces].
- If the resulting string both begins *and* ends with a [space]
  character, but does not consist entirely of [space]
  characters, a single [space] character is removed from the
  front and back.  This allows you to include code that begins
  or ends with backtick characters, which must be separated by
  whitespace from the opening or closing backtick strings.

This is a simple code span:

```````````````````````````````` example
`foo`
.

foo

````````````````````````````````


Here two backticks are used, because the code contains a backtick.
This example also illustrates stripping of a single leading and
trailing space:

```````````````````````````````` example
`` foo ` bar ``
.

foo ` bar

````````````````````````````````


This example shows the motivation for stripping leading and trailing
spaces:

```````````````````````````````` example
` `` `
.

``

````````````````````````````````

Note that only *one* space is stripped:

```````````````````````````````` example
`  ``  `
.

 `` 

````````````````````````````````

The stripping only happens if the space is on both
sides of the string:

```````````````````````````````` example
` a`
.

 a

````````````````````````````````

Only [spaces], and not [unicode whitespace] in general, are
stripped in this way:

```````````````````````````````` example
` b `
.

 b 

````````````````````````````````

No stripping occurs if the code span contains only spaces:

```````````````````````````````` example
` `
`  `
.

 
  

````````````````````````````````


[Line endings] are treated like spaces:

```````````````````````````````` example
``
foo
bar  
baz
``
.

foo bar   baz

````````````````````````````````

```````````````````````````````` example
``
foo 
``
.

foo 

````````````````````````````````


Interior spaces are not collapsed:

```````````````````````````````` example
`foo   bar 
baz`
.

foo   bar  baz

````````````````````````````````

Note that browsers will typically collapse consecutive spaces
when rendering `` elements, so it is recommended that
the following CSS be used:

    code{white-space: pre-wrap;}


Note that backslash escapes do not work in code spans. All backslashes
are treated literally:

```````````````````````````````` example
`foo\`bar`
.

foo\bar`

````````````````````````````````


Backslash escapes are never needed, because one can always choose a
string of *n* backtick characters as delimiters, where the code does
not contain any strings of exactly *n* backtick characters.

```````````````````````````````` example
``foo`bar``
.

foo`bar

````````````````````````````````

```````````````````````````````` example
` foo `` bar `
.

foo `` bar

````````````````````````````````


Code span backticks have higher precedence than any other inline
constructs except HTML tags and autolinks.  Thus, for example, this is
not parsed as emphasized text, since the second `*` is part of a code
span:

```````````````````````````````` example
*foo`*`
.

*foo*

````````````````````````````````


And this is not parsed as a link:

```````````````````````````````` example
[not a `link](/foo`)
.

[not a link](/foo)

````````````````````````````````


Code spans, HTML tags, and autolinks have the same precedence.
Thus, this is code:

```````````````````````````````` example
``
.

<a href="">`

````````````````````````````````


But this is an HTML tag:

```````````````````````````````` example
`
.

`

````````````````````````````````


And this is code:

```````````````````````````````` example
``
.

<http://foo.bar.baz>`

````````````````````````````````


But this is an autolink:

```````````````````````````````` example
`
.

http://foo.bar.`baz`

````````````````````````````````


When a backtick string is not closed by a matching backtick string,
we just have literal backticks:

```````````````````````````````` example
```foo``
.

```foo``

````````````````````````````````


```````````````````````````````` example
`foo
.

`foo

````````````````````````````````

The following case also illustrates the need for opening and
closing backtick strings to be equal in length:

```````````````````````````````` example
`foo``bar``
.

`foobar

````````````````````````````````


## Emphasis and strong emphasis

John Gruber's original [Markdown syntax
description](http://daringfireball.net/projects/markdown/syntax#em) says:

> Markdown treats asterisks (`*`) and underscores (`_`) as indicators of
> emphasis. Text wrapped with one `*` or `_` will be wrapped with an HTML
> `` tag; double `*`'s or `_`'s will be wrapped with an HTML ``
> tag.

This is enough for most users, but these rules leave much undecided,
especially when it comes to nested emphasis.  The original
`Markdown.pl` test suite makes it clear that triple `***` and
`___` delimiters can be used for strong emphasis, and most
implementations have also allowed the following patterns:

``` markdown
***strong emph***
***strong** in emph*
***emph* in strong**
**in strong *emph***
*in emph **strong***
```

The following patterns are less widely supported, but the intent
is clear and they are useful (especially in contexts like bibliography
entries):

``` markdown
*emph *with emph* in it*
**strong **with strong** in it**
```

Many implementations have also restricted intraword emphasis to
the `*` forms, to avoid unwanted emphasis in words containing
internal underscores.  (It is best practice to put these in code
spans, but users often do not.)

``` markdown
internal emphasis: foo*bar*baz
no emphasis: foo_bar_baz
```

The rules given below capture all of these patterns, while allowing
for efficient parsing strategies that do not backtrack.

First, some definitions.  A [delimiter run](@) is either
a sequence of one or more `*` characters that is not preceded or
followed by a non-backslash-escaped `*` character, or a sequence
of one or more `_` characters that is not preceded or followed by
a non-backslash-escaped `_` character.

A [left-flanking delimiter run](@) is
a [delimiter run] that is (1) not followed by [Unicode whitespace],
and either (2a) not followed by a [punctuation character], or
(2b) followed by a [punctuation character] and
preceded by [Unicode whitespace] or a [punctuation character].
For purposes of this definition, the beginning and the end of
the line count as Unicode whitespace.

A [right-flanking delimiter run](@) is
a [delimiter run] that is (1) not preceded by [Unicode whitespace],
and either (2a) not preceded by a [punctuation character], or
(2b) preceded by a [punctuation character] and
followed by [Unicode whitespace] or a [punctuation character].
For purposes of this definition, the beginning and the end of
the line count as Unicode whitespace.

Here are some examples of delimiter runs.

  - left-flanking but not right-flanking:

    ```
    ***abc
      _abc
    **"abc"
     _"abc"
    ```

  - right-flanking but not left-flanking:

    ```
     abc***
     abc_
    "abc"**
    "abc"_
    ```

  - Both left and right-flanking:

    ```
     abc***def
    "abc"_"def"
    ```

  - Neither left nor right-flanking:

    ```
    abc *** def
    a _ b
    ```

(The idea of distinguishing left-flanking and right-flanking
delimiter runs based on the character before and the character
after comes from Roopesh Chander's
[vfmd](http://www.vfmd.org/vfmd-spec/specification/#procedure-for-identifying-emphasis-tags).
vfmd uses the terminology "emphasis indicator string" instead of "delimiter
run," and its rules for distinguishing left- and right-flanking runs
are a bit more complex than the ones given here.)

The following rules define emphasis and strong emphasis:

1.  A single `*` character [can open emphasis](@)
    iff (if and only if) it is part of a [left-flanking delimiter run].

2.  A single `_` character [can open emphasis] iff
    it is part of a [left-flanking delimiter run]
    and either (a) not part of a [right-flanking delimiter run]
    or (b) part of a [right-flanking delimiter run]
    preceded by punctuation.

3.  A single `*` character [can close emphasis](@)
    iff it is part of a [right-flanking delimiter run].

4.  A single `_` character [can close emphasis] iff
    it is part of a [right-flanking delimiter run]
    and either (a) not part of a [left-flanking delimiter run]
    or (b) part of a [left-flanking delimiter run]
    followed by punctuation.

5.  A double `**` [can open strong emphasis](@)
    iff it is part of a [left-flanking delimiter run].

6.  A double `__` [can open strong emphasis] iff
    it is part of a [left-flanking delimiter run]
    and either (a) not part of a [right-flanking delimiter run]
    or (b) part of a [right-flanking delimiter run]
    preceded by punctuation.

7.  A double `**` [can close strong emphasis](@)
    iff it is part of a [right-flanking delimiter run].

8.  A double `__` [can close strong emphasis] iff
    it is part of a [right-flanking delimiter run]
    and either (a) not part of a [left-flanking delimiter run]
    or (b) part of a [left-flanking delimiter run]
    followed by punctuation.

9.  Emphasis begins with a delimiter that [can open emphasis] and ends
    with a delimiter that [can close emphasis], and that uses the same
    character (`_` or `*`) as the opening delimiter.  The
    opening and closing delimiters must belong to separate
    [delimiter runs].  If one of the delimiters can both
    open and close emphasis, then the sum of the lengths of the
    delimiter runs containing the opening and closing delimiters
    must not be a multiple of 3 unless both lengths are
    multiples of 3.

10. Strong emphasis begins with a delimiter that
    [can open strong emphasis] and ends with a delimiter that
    [can close strong emphasis], and that uses the same character
    (`_` or `*`) as the opening delimiter.  The
    opening and closing delimiters must belong to separate
    [delimiter runs].  If one of the delimiters can both open
    and close strong emphasis, then the sum of the lengths of
    the delimiter runs containing the opening and closing
    delimiters must not be a multiple of 3 unless both lengths
    are multiples of 3.

11. A literal `*` character cannot occur at the beginning or end of
    `*`-delimited emphasis or `**`-delimited strong emphasis, unless it
    is backslash-escaped.

12. A literal `_` character cannot occur at the beginning or end of
    `_`-delimited emphasis or `__`-delimited strong emphasis, unless it
    is backslash-escaped.

Where rules 1--12 above are compatible with multiple parsings,
the following principles resolve ambiguity:

13. The number of nestings should be minimized. Thus, for example,
    an interpretation `...` is always preferred to
    `...`.

14. An interpretation `...` is always
    preferred to `...`.

15. When two potential emphasis or strong emphasis spans overlap,
    so that the second begins before the first ends and ends after
    the first ends, the first takes precedence. Thus, for example,
    `*foo _bar* baz_` is parsed as `foo _bar baz_` rather
    than `*foo bar* baz`.

16. When there are two potential emphasis or strong emphasis spans
    with the same closing delimiter, the shorter one (the one that
    opens later) takes precedence. Thus, for example,
    `**foo **bar baz**` is parsed as `**foo bar baz`
    rather than `foo **bar baz`.

17. Inline code spans, links, images, and HTML tags group more tightly
    than emphasis.  So, when there is a choice between an interpretation
    that contains one of these elements and one that does not, the
    former always wins.  Thus, for example, `*[foo*](bar)` is
    parsed as `*foo*` rather than as
    `[foo](bar)`.

These rules can be illustrated through a series of examples.

Rule 1:

```````````````````````````````` example
*foo bar*
.

foo bar

````````````````````````````````


This is not emphasis, because the opening `*` is followed by
whitespace, and hence not part of a [left-flanking delimiter run]:

```````````````````````````````` example
a * foo bar*
.

a * foo bar*

````````````````````````````````


This is not emphasis, because the opening `*` is preceded
by an alphanumeric and followed by punctuation, and hence
not part of a [left-flanking delimiter run]:

```````````````````````````````` example
a*"foo"*
.

a*"foo"*

````````````````````````````````


Unicode nonbreaking spaces count as whitespace, too:

```````````````````````````````` example
* a *
.

* a *

````````````````````````````````


Intraword emphasis with `*` is permitted:

```````````````````````````````` example
foo*bar*
.

foobar

````````````````````````````````


```````````````````````````````` example
5*6*78
.

5678

````````````````````````````````


Rule 2:

```````````````````````````````` example
_foo bar_
.

foo bar

````````````````````````````````


This is not emphasis, because the opening `_` is followed by
whitespace:

```````````````````````````````` example
_ foo bar_
.

_ foo bar_

````````````````````````````````


This is not emphasis, because the opening `_` is preceded
by an alphanumeric and followed by punctuation:

```````````````````````````````` example
a_"foo"_
.

a_"foo"_

````````````````````````````````


Emphasis with `_` is not allowed inside words:

```````````````````````````````` example
foo_bar_
.

foo_bar_

````````````````````````````````


```````````````````````````````` example
5_6_78
.

5_6_78

````````````````````````````````


```````````````````````````````` example
пристаням_стремятся_
.

пристаням_стремятся_

````````````````````````````````


Here `_` does not generate emphasis, because the first delimiter run
is right-flanking and the second left-flanking:

```````````````````````````````` example
aa_"bb"_cc
.

aa_"bb"_cc

````````````````````````````````


This is emphasis, even though the opening delimiter is
both left- and right-flanking, because it is preceded by
punctuation:

```````````````````````````````` example
foo-_(bar)_
.

foo-(bar)

````````````````````````````````


Rule 3:

This is not emphasis, because the closing delimiter does
not match the opening delimiter:

```````````````````````````````` example
_foo*
.

_foo*

````````````````````````````````


This is not emphasis, because the closing `*` is preceded by
whitespace:

```````````````````````````````` example
*foo bar *
.

*foo bar *

````````````````````````````````


A newline also counts as whitespace:

```````````````````````````````` example
*foo bar
*
.

*foo bar
*

````````````````````````````````


This is not emphasis, because the second `*` is
preceded by punctuation and followed by an alphanumeric
(hence it is not part of a [right-flanking delimiter run]:

```````````````````````````````` example
*(*foo)
.

*(*foo)

````````````````````````````````


The point of this restriction is more easily appreciated
with this example:

```````````````````````````````` example
*(*foo*)*
.

(foo)

````````````````````````````````


Intraword emphasis with `*` is allowed:

```````````````````````````````` example
*foo*bar
.

foobar

````````````````````````````````



Rule 4:

This is not emphasis, because the closing `_` is preceded by
whitespace:

```````````````````````````````` example
_foo bar _
.

_foo bar _

````````````````````````````````


This is not emphasis, because the second `_` is
preceded by punctuation and followed by an alphanumeric:

```````````````````````````````` example
_(_foo)
.

_(_foo)

````````````````````````````````


This is emphasis within emphasis:

```````````````````````````````` example
_(_foo_)_
.

(foo)

````````````````````````````````


Intraword emphasis is disallowed for `_`:

```````````````````````````````` example
_foo_bar
.

_foo_bar

````````````````````````````````


```````````````````````````````` example
_пристаням_стремятся
.

_пристаням_стремятся

````````````````````````````````


```````````````````````````````` example
_foo_bar_baz_
.

foo_bar_baz

````````````````````````````````


This is emphasis, even though the closing delimiter is
both left- and right-flanking, because it is followed by
punctuation:

```````````````````````````````` example
_(bar)_.
.

(bar).

````````````````````````````````


Rule 5:

```````````````````````````````` example
**foo bar**
.

foo bar

````````````````````````````````


This is not strong emphasis, because the opening delimiter is
followed by whitespace:

```````````````````````````````` example
** foo bar**
.

** foo bar**

````````````````````````````````


This is not strong emphasis, because the opening `**` is preceded
by an alphanumeric and followed by punctuation, and hence
not part of a [left-flanking delimiter run]:

```````````````````````````````` example
a**"foo"**
.

a**"foo"**

````````````````````````````````


Intraword strong emphasis with `**` is permitted:

```````````````````````````````` example
foo**bar**
.

foobar

````````````````````````````````


Rule 6:

```````````````````````````````` example
__foo bar__
.

foo bar

````````````````````````````````


This is not strong emphasis, because the opening delimiter is
followed by whitespace:

```````````````````````````````` example
__ foo bar__
.

__ foo bar__

````````````````````````````````


A newline counts as whitespace:
```````````````````````````````` example
__
foo bar__
.

__
foo bar__

````````````````````````````````


This is not strong emphasis, because the opening `__` is preceded
by an alphanumeric and followed by punctuation:

```````````````````````````````` example
a__"foo"__
.

a__"foo"__

````````````````````````````````


Intraword strong emphasis is forbidden with `__`:

```````````````````````````````` example
foo__bar__
.

foo__bar__

````````````````````````````````


```````````````````````````````` example
5__6__78
.

5__6__78

````````````````````````````````


```````````````````````````````` example
пристаням__стремятся__
.

пристаням__стремятся__

````````````````````````````````


```````````````````````````````` example
__foo, __bar__, baz__
.

foo, bar, baz

````````````````````````````````


This is strong emphasis, even though the opening delimiter is
both left- and right-flanking, because it is preceded by
punctuation:

```````````````````````````````` example
foo-__(bar)__
.

foo-(bar)

````````````````````````````````



Rule 7:

This is not strong emphasis, because the closing delimiter is preceded
by whitespace:

```````````````````````````````` example
**foo bar **
.

**foo bar **

````````````````````````````````


(Nor can it be interpreted as an emphasized `*foo bar *`, because of
Rule 11.)

This is not strong emphasis, because the second `**` is
preceded by punctuation and followed by an alphanumeric:

```````````````````````````````` example
**(**foo)
.

**(**foo)

````````````````````````````````


The point of this restriction is more easily appreciated
with these examples:

```````````````````````````````` example
*(**foo**)*
.

(foo)

````````````````````````````````


```````````````````````````````` example
**Gomphocarpus (*Gomphocarpus physocarpus*, syn.
*Asclepias physocarpa*)**
.

Gomphocarpus (Gomphocarpus physocarpus, syn.
Asclepias physocarpa)

````````````````````````````````


```````````````````````````````` example
**foo "*bar*" foo**
.

foo "bar" foo

````````````````````````````````


Intraword emphasis:

```````````````````````````````` example
**foo**bar
.

foobar

````````````````````````````````


Rule 8:

This is not strong emphasis, because the closing delimiter is
preceded by whitespace:

```````````````````````````````` example
__foo bar __
.

__foo bar __

````````````````````````````````


This is not strong emphasis, because the second `__` is
preceded by punctuation and followed by an alphanumeric:

```````````````````````````````` example
__(__foo)
.

__(__foo)

````````````````````````````````


The point of this restriction is more easily appreciated
with this example:

```````````````````````````````` example
_(__foo__)_
.

(foo)

````````````````````````````````


Intraword strong emphasis is forbidden with `__`:

```````````````````````````````` example
__foo__bar
.

__foo__bar

````````````````````````````````


```````````````````````````````` example
__пристаням__стремятся
.

__пристаням__стремятся

````````````````````````````````


```````````````````````````````` example
__foo__bar__baz__
.

foo__bar__baz

````````````````````````````````


This is strong emphasis, even though the closing delimiter is
both left- and right-flanking, because it is followed by
punctuation:

```````````````````````````````` example
__(bar)__.
.

(bar).

````````````````````````````````


Rule 9:

Any nonempty sequence of inline elements can be the contents of an
emphasized span.

```````````````````````````````` example
*foo [bar](/url)*
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo
bar*
.

foo
bar

````````````````````````````````


In particular, emphasis and strong emphasis can be nested
inside emphasis:

```````````````````````````````` example
_foo __bar__ baz_
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
_foo _bar_ baz_
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
__foo_ bar_
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo *bar**
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo **bar** baz*
.

foo bar baz

````````````````````````````````

```````````````````````````````` example
*foo**bar**baz*
.

foobarbaz

````````````````````````````````

Note that in the preceding case, the interpretation

``` markdown

foobarbaz

```


is precluded by the condition that a delimiter that
can both open and close (like the `*` after `foo`)
cannot form emphasis if the sum of the lengths of
the delimiter runs containing the opening and
closing delimiters is a multiple of 3 unless
both lengths are multiples of 3.


For the same reason, we don't get two consecutive
emphasis sections in this example:

```````````````````````````````` example
*foo**bar*
.

foo**bar

````````````````````````````````


The same condition ensures that the following
cases are all strong emphasis nested inside
emphasis, even when the interior spaces are
omitted:


```````````````````````````````` example
***foo** bar*
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo **bar***
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo**bar***
.

foobar

````````````````````````````````


When the lengths of the interior closing and opening
delimiter runs are *both* multiples of 3, though,
they can match to create emphasis:

```````````````````````````````` example
foo***bar***baz
.

foobarbaz

````````````````````````````````

```````````````````````````````` example
foo******bar*********baz
.

foobar***baz

````````````````````````````````


Indefinite levels of nesting are possible:

```````````````````````````````` example
*foo **bar *baz* bim** bop*
.

foo bar baz bim bop

````````````````````````````````


```````````````````````````````` example
*foo [*bar*](/url)*
.

foo bar

````````````````````````````````


There can be no empty emphasis or strong emphasis:

```````````````````````````````` example
** is not an empty emphasis
.

** is not an empty emphasis

````````````````````````````````


```````````````````````````````` example
**** is not an empty strong emphasis
.

**** is not an empty strong emphasis

````````````````````````````````



Rule 10:

Any nonempty sequence of inline elements can be the contents of an
strongly emphasized span.

```````````````````````````````` example
**foo [bar](/url)**
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo
bar**
.

foo
bar

````````````````````````````````


In particular, emphasis and strong emphasis can be nested
inside strong emphasis:

```````````````````````````````` example
__foo _bar_ baz__
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
__foo __bar__ baz__
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
____foo__ bar__
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo **bar****
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo *bar* baz**
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
**foo*bar*baz**
.

foobarbaz

````````````````````````````````


```````````````````````````````` example
***foo* bar**
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo *bar***
.

foo bar

````````````````````````````````


Indefinite levels of nesting are possible:

```````````````````````````````` example
**foo *bar **baz**
bim* bop**
.

foo bar baz
bim bop

````````````````````````````````


```````````````````````````````` example
**foo [*bar*](/url)**
.

foo bar

````````````````````````````````


There can be no empty emphasis or strong emphasis:

```````````````````````````````` example
__ is not an empty emphasis
.

__ is not an empty emphasis

````````````````````````````````


```````````````````````````````` example
____ is not an empty strong emphasis
.

____ is not an empty strong emphasis

````````````````````````````````



Rule 11:

```````````````````````````````` example
foo ***
.

foo ***

````````````````````````````````


```````````````````````````````` example
foo *\**
.

foo *

````````````````````````````````


```````````````````````````````` example
foo *_*
.

foo _

````````````````````````````````


```````````````````````````````` example
foo *****
.

foo *****

````````````````````````````````


```````````````````````````````` example
foo **\***
.

foo *

````````````````````````````````


```````````````````````````````` example
foo **_**
.

foo _

````````````````````````````````


Note that when delimiters do not match evenly, Rule 11 determines
that the excess literal `*` characters will appear outside of the
emphasis, rather than inside it:

```````````````````````````````` example
**foo*
.

*foo

````````````````````````````````


```````````````````````````````` example
*foo**
.

foo*

````````````````````````````````


```````````````````````````````` example
***foo**
.

*foo

````````````````````````````````


```````````````````````````````` example
****foo*
.

***foo

````````````````````````````````


```````````````````````````````` example
**foo***
.

foo*

````````````````````````````````


```````````````````````````````` example
*foo****
.

foo***

````````````````````````````````



Rule 12:

```````````````````````````````` example
foo ___
.

foo ___

````````````````````````````````


```````````````````````````````` example
foo _\__
.

foo _

````````````````````````````````


```````````````````````````````` example
foo _*_
.

foo *

````````````````````````````````


```````````````````````````````` example
foo _____
.

foo _____

````````````````````````````````


```````````````````````````````` example
foo __\___
.

foo _

````````````````````````````````


```````````````````````````````` example
foo __*__
.

foo *

````````````````````````````````


```````````````````````````````` example
__foo_
.

_foo

````````````````````````````````


Note that when delimiters do not match evenly, Rule 12 determines
that the excess literal `_` characters will appear outside of the
emphasis, rather than inside it:

```````````````````````````````` example
_foo__
.

foo_

````````````````````````````````


```````````````````````````````` example
___foo__
.

_foo

````````````````````````````````


```````````````````````````````` example
____foo_
.

___foo

````````````````````````````````


```````````````````````````````` example
__foo___
.

foo_

````````````````````````````````


```````````````````````````````` example
_foo____
.

foo___

````````````````````````````````


Rule 13 implies that if you want emphasis nested directly inside
emphasis, you must use different delimiters:

```````````````````````````````` example
**foo**
.

foo

````````````````````````````````


```````````````````````````````` example
*_foo_*
.

foo

````````````````````````````````


```````````````````````````````` example
__foo__
.

foo

````````````````````````````````


```````````````````````````````` example
_*foo*_
.

foo

````````````````````````````````


However, strong emphasis within strong emphasis is possible without
switching delimiters:

```````````````````````````````` example
****foo****
.

foo

````````````````````````````````


```````````````````````````````` example
____foo____
.

foo

````````````````````````````````



Rule 13 can be applied to arbitrarily long sequences of
delimiters:

```````````````````````````````` example
******foo******
.

foo

````````````````````````````````


Rule 14:

```````````````````````````````` example
***foo***
.

foo

````````````````````````````````


```````````````````````````````` example
_____foo_____
.

foo

````````````````````````````````


Rule 15:

```````````````````````````````` example
*foo _bar* baz_
.

foo _bar baz_

````````````````````````````````


```````````````````````````````` example
*foo __bar *baz bim__ bam*
.

foo bar *baz bim bam

````````````````````````````````


Rule 16:

```````````````````````````````` example
**foo **bar baz**
.

**foo bar baz

````````````````````````````````


```````````````````````````````` example
*foo *bar baz*
.

*foo bar baz

````````````````````````````````


Rule 17:

```````````````````````````````` example
*[bar*](/url)
.

*bar*

````````````````````````````````


```````````````````````````````` example
_foo [bar_](/url)
.

_foo bar_

````````````````````````````````


```````````````````````````````` example
*
.

*

````````````````````````````````


```````````````````````````````` example
**
.

**

````````````````````````````````


```````````````````````````````` example
__
.

__

````````````````````````````````


```````````````````````````````` example
*a `*`*
.

a *

````````````````````````````````


```````````````````````````````` example
_a `_`_
.

a _

````````````````````````````````


```````````````````````````````` example
**a
.

**ahttp://foo.bar/?q=**

````````````````````````````````


```````````````````````````````` example
__a
.

__ahttp://foo.bar/?q=__

````````````````````````````````



## Links

A link contains [link text] (the visible text), a [link destination]
(the URI that is the link destination), and optionally a [link title].
There are two basic kinds of links in Markdown.  In [inline links] the
destination and title are given immediately after the link text.  In
[reference links] the destination and title are defined elsewhere in
the document.

A [link text](@) consists of a sequence of zero or more
inline elements enclosed by square brackets (`[` and `]`).  The
following rules apply:

- Links may not contain other links, at any level of nesting. If
  multiple otherwise valid link definitions appear nested inside each
  other, the inner-most definition is used.

- Brackets are allowed in the [link text] only if (a) they
  are backslash-escaped or (b) they appear as a matched pair of brackets,
  with an open bracket `[`, a sequence of zero or more inlines, and
  a close bracket `]`.

- Backtick [code spans], [autolinks], and raw [HTML tags] bind more tightly
  than the brackets in link text.  Thus, for example,
  `` [foo`]` `` could not be a link text, since the second `]`
  is part of a code span.

- The brackets in link text bind more tightly than markers for
  [emphasis and strong emphasis]. Thus, for example, `*[foo*](url)` is a link.

A [link destination](@) consists of either

- a sequence of zero or more characters between an opening `<` and a
  closing `>` that contains no line breaks or unescaped
  `<` or `>` characters, or

- a nonempty sequence of characters that does not start with
  `<`, does not include ASCII space or control characters, and
  includes parentheses only if (a) they are backslash-escaped or
  (b) they are part of a balanced pair of unescaped parentheses.
  (Implementations may impose limits on parentheses nesting to
  avoid performance issues, but at least three levels of nesting
  should be supported.)

A [link title](@)  consists of either

- a sequence of zero or more characters between straight double-quote
  characters (`"`), including a `"` character only if it is
  backslash-escaped, or

- a sequence of zero or more characters between straight single-quote
  characters (`'`), including a `'` character only if it is
  backslash-escaped, or

- a sequence of zero or more characters between matching parentheses
  (`(...)`), including a `(` or `)` character only if it is
  backslash-escaped.

Although [link titles] may span multiple lines, they may not contain
a [blank line].

An [inline link](@) consists of a [link text] followed immediately
by a left parenthesis `(`, optional [whitespace], an optional
[link destination], an optional [link title] separated from the link
destination by [whitespace], optional [whitespace], and a right
parenthesis `)`. The link's text consists of the inlines contained
in the [link text] (excluding the enclosing square brackets).
The link's URI consists of the link destination, excluding enclosing
`<...>` if present, with backslash-escapes in effect as described
above.  The link's title consists of the link title, excluding its
enclosing delimiters, with backslash-escapes in effect as described
above.

Here is a simple inline link:

```````````````````````````````` example
[link](/uri "title")
.

link

````````````````````````````````


The title may be omitted:

```````````````````````````````` example
[link](/uri)
.

link

````````````````````````````````


Both the title and the destination may be omitted:

```````````````````````````````` example
[link]()
.

link

````````````````````````````````


```````````````````````````````` example
[link](<>)
.

link

````````````````````````````````

The destination can only contain spaces if it is
enclosed in pointy brackets:

```````````````````````````````` example
[link](/my uri)
.

[link](/my uri)

````````````````````````````````

```````````````````````````````` example
[link]()
.

link

````````````````````````````````

The destination cannot contain line breaks,
even if enclosed in pointy brackets:

```````````````````````````````` example
[link](foo
bar)
.

[link](foo
bar)

````````````````````````````````

```````````````````````````````` example
[link]()
.

[link]()

````````````````````````````````

The destination can contain `)` if it is enclosed
in pointy brackets:

```````````````````````````````` example
[a]()
.

a

````````````````````````````````

Pointy brackets that enclose links must be unescaped:

```````````````````````````````` example
[link]()
.

[link](<foo>)

````````````````````````````````

These are not links, because the opening pointy bracket
is not matched properly:

```````````````````````````````` example
[a](
[a](c)
.

[a](<b)c
[a](<b)c>
[a](c)

````````````````````````````````

Parentheses inside the link destination may be escaped:

```````````````````````````````` example
[link](\(foo\))
.

link

````````````````````````````````

Any number of parentheses are allowed without escaping, as long as they are
balanced:

```````````````````````````````` example
[link](foo(and(bar)))
.

link

````````````````````````````````

However, if you have unbalanced parentheses, you need to escape or use the
`<...>` form:

```````````````````````````````` example
[link](foo\(and\(bar\))
.

link

````````````````````````````````


```````````````````````````````` example
[link]()
.

link

````````````````````````````````


Parentheses and other symbols can also be escaped, as usual
in Markdown:

```````````````````````````````` example
[link](foo\)\:)
.

link

````````````````````````````````


A link can contain fragment identifiers and queries:

```````````````````````````````` example
[link](#fragment)

[link](http://example.com#fragment)

[link](http://example.com?foo=3#frag)
.

link


link


link

````````````````````````````````


Note that a backslash before a non-escapable character is
just a backslash:

```````````````````````````````` example
[link](foo\bar)
.

link

````````````````````````````````


URL-escaping should be left alone inside the destination, as all
URL-escaped characters are also valid URL characters. Entity and
numerical character references in the destination will be parsed
into the corresponding Unicode code points, as usual.  These may
be optionally URL-escaped when written as HTML, but this spec
does not enforce any particular policy for rendering URLs in
HTML or other formats.  Renderers may make different decisions
about how to escape or normalize URLs in the output.

```````````````````````````````` example
[link](foo%20bä)
.

link

````````````````````````````````


Note that, because titles can often be parsed as destinations,
if you try to omit the destination and keep the title, you'll
get unexpected results:

```````````````````````````````` example
[link]("title")
.

link

````````````````````````````````


Titles may be in single quotes, double quotes, or parentheses:

```````````````````````````````` example
[link](/url "title")
[link](/url 'title')
[link](/url (title))
.

link
link
link

````````````````````````````````


Backslash escapes and entity and numeric character references
may be used in titles:

```````````````````````````````` example
[link](/url "title \""")
.

link

````````````````````````````````


Titles must be separated from the link using a [whitespace].
Other [Unicode whitespace] like non-breaking space doesn't work.

```````````````````````````````` example
[link](/url "title")
.

link

````````````````````````````````


Nested balanced quotes are not allowed without escaping:

```````````````````````````````` example
[link](/url "title "and" title")
.

[link](/url "title "and" title")

````````````````````````````````


But it is easy to work around this by using a different quote type:

```````````````````````````````` example
[link](/url 'title "and" title')
.

link

````````````````````````````````


(Note:  `Markdown.pl` did allow double quotes inside a double-quoted
title, and its test suite included a test demonstrating this.
But it is hard to see a good rationale for the extra complexity this
brings, since there are already many ways---backslash escaping,
entity and numeric character references, or using a different
quote type for the enclosing title---to write titles containing
double quotes.  `Markdown.pl`'s handling of titles has a number
of other strange features.  For example, it allows single-quoted
titles in inline links, but not reference links.  And, in
reference links but not inline links, it allows a title to begin
with `"` and end with `)`.  `Markdown.pl` 1.0.1 even allows
titles with no closing quotation mark, though 1.0.2b8 does not.
It seems preferable to adopt a simple, rational rule that works
the same way in inline links and link reference definitions.)

[Whitespace] is allowed around the destination and title:

```````````````````````````````` example
[link](   /uri
  "title"  )
.

link

````````````````````````````````


But it is not allowed between the link text and the
following parenthesis:

```````````````````````````````` example
[link] (/uri)
.

[link] (/uri)

````````````````````````````````


The link text may contain balanced brackets, but not unbalanced ones,
unless they are escaped:

```````````````````````````````` example
[link [foo [bar]]](/uri)
.

link [foo [bar]]

````````````````````````````````


```````````````````````````````` example
[link] bar](/uri)
.

[link] bar](/uri)

````````````````````````````````


```````````````````````````````` example
[link [bar](/uri)
.

[link bar

````````````````````````````````


```````````````````````````````` example
[link \[bar](/uri)
.

link [bar

````````````````````````````````


The link text may contain inline content:

```````````````````````````````` example
[link *foo **bar** `#`*](/uri)
.

link foo bar #

````````````````````````````````


```````````````````````````````` example
[![moon](moon.jpg)](/uri)
.

moon

````````````````````````````````


However, links may not contain other links, at any level of nesting.

```````````````````````````````` example
[foo [bar](/uri)](/uri)
.

[foo bar](/uri)

````````````````````````````````


```````````````````````````````` example
[foo *[bar [baz](/uri)](/uri)*](/uri)
.

[foo [bar baz](/uri)](/uri)

````````````````````````````````


```````````````````````````````` example
![[[foo](uri1)](uri2)](uri3)
.

[foo](uri2)

````````````````````````````````


These cases illustrate the precedence of link text grouping over
emphasis grouping:

```````````````````````````````` example
*[foo*](/uri)
.

*foo*

````````````````````````````````


```````````````````````````````` example
[foo *bar](baz*)
.

foo *bar

````````````````````````````````


Note that brackets that *aren't* part of links do not take
precedence:

```````````````````````````````` example
*foo [bar* baz]
.

foo [bar baz]

````````````````````````````````


These cases illustrate the precedence of HTML tags, code spans,
and autolinks over link grouping:

```````````````````````````````` example
[foo 
.

[foo 

````````````````````````````````


```````````````````````````````` example
[foo`](/uri)`
.

[foo](/uri)

````````````````````````````````


```````````````````````````````` example
[foo
.

[foohttp://example.com/?search=](uri)

````````````````````````````````


There are three kinds of [reference link](@)s:
[full](#full-reference-link), [collapsed](#collapsed-reference-link),
and [shortcut](#shortcut-reference-link).

A [full reference link](@)
consists of a [link text] immediately followed by a [link label]
that [matches] a [link reference definition] elsewhere in the document.

A [link label](@)  begins with a left bracket (`[`) and ends
with the first right bracket (`]`) that is not backslash-escaped.
Between these brackets there must be at least one [non-whitespace character].
Unescaped square bracket characters are not allowed inside the
opening and closing square brackets of [link labels].  A link
label can have at most 999 characters inside the square
brackets.

One label [matches](@)
another just in case their normalized forms are equal.  To normalize a
label, strip off the opening and closing brackets,
perform the *Unicode case fold*, strip leading and trailing
[whitespace] and collapse consecutive internal
[whitespace] to a single space.  If there are multiple
matching reference link definitions, the one that comes first in the
document is used.  (It is desirable in such cases to emit a warning.)

The contents of the first link label are parsed as inlines, which are
used as the link's text.  The link's URI and title are provided by the
matching [link reference definition].

Here is a simple example:

```````````````````````````````` example
[foo][bar]

[bar]: /url "title"
.

foo

````````````````````````````````


The rules for the [link text] are the same as with
[inline links].  Thus:

The link text may contain balanced brackets, but not unbalanced ones,
unless they are escaped:

```````````````````````````````` example
[link [foo [bar]]][ref]

[ref]: /uri
.

link [foo [bar]]

````````````````````````````````


```````````````````````````````` example
[link \[bar][ref]

[ref]: /uri
.

link [bar

````````````````````````````````


The link text may contain inline content:

```````````````````````````````` example
[link *foo **bar** `#`*][ref]

[ref]: /uri
.

link foo bar #

````````````````````````````````


```````````````````````````````` example
[![moon](moon.jpg)][ref]

[ref]: /uri
.

moon

````````````````````````````````


However, links may not contain other links, at any level of nesting.

```````````````````````````````` example
[foo [bar](/uri)][ref]

[ref]: /uri
.

[foo bar]ref

````````````````````````````````


```````````````````````````````` example
[foo *bar [baz][ref]*][ref]

[ref]: /uri
.

[foo bar baz]ref

````````````````````````````````


(In the examples above, we have two [shortcut reference links]
instead of one [full reference link].)

The following cases illustrate the precedence of link text grouping over
emphasis grouping:

```````````````````````````````` example
*[foo*][ref]

[ref]: /uri
.

*foo*

````````````````````````````````


```````````````````````````````` example
[foo *bar][ref]

[ref]: /uri
.

foo *bar

````````````````````````````````


These cases illustrate the precedence of HTML tags, code spans,
and autolinks over link grouping:

```````````````````````````````` example
[foo 

[ref]: /uri
.

[foo 

````````````````````````````````


```````````````````````````````` example
[foo`][ref]`

[ref]: /uri
.

[foo][ref]

````````````````````````````````


```````````````````````````````` example
[foo

[ref]: /uri
.

[foohttp://example.com/?search=][ref]

````````````````````````````````


Matching is case-insensitive:

```````````````````````````````` example
[foo][BaR]

[bar]: /url "title"
.

foo

````````````````````````````````


Unicode case fold is used:

```````````````````````````````` example
[Толпой][Толпой] is a Russian word.

[ТОЛПОЙ]: /url
.

Толпой is a Russian word.

````````````````````````````````


Consecutive internal [whitespace] is treated as one space for
purposes of determining matching:

```````````````````````````````` example
[Foo
  bar]: /url

[Baz][Foo bar]
.

Baz

````````````````````````````````


No [whitespace] is allowed between the [link text] and the
[link label]:

```````````````````````````````` example
[foo] [bar]

[bar]: /url "title"
.

[foo] bar

````````````````````````````````


```````````````````````````````` example
[foo]
[bar]

[bar]: /url "title"
.

[foo]
bar

````````````````````````````````


This is a departure from John Gruber's original Markdown syntax
description, which explicitly allows whitespace between the link
text and the link label.  It brings reference links in line with
[inline links], which (according to both original Markdown and
this spec) cannot have whitespace after the link text.  More
importantly, it prevents inadvertent capture of consecutive
[shortcut reference links]. If whitespace is allowed between the
link text and the link label, then in the following we will have
a single reference link, not two shortcut reference links, as
intended:

``` markdown
[foo]
[bar]

[foo]: /url1
[bar]: /url2
```

(Note that [shortcut reference links] were introduced by Gruber
himself in a beta version of `Markdown.pl`, but never included
in the official syntax description.  Without shortcut reference
links, it is harmless to allow space between the link text and
link label; but once shortcut references are introduced, it is
too dangerous to allow this, as it frequently leads to
unintended results.)

When there are multiple matching [link reference definitions],
the first is used:

```````````````````````````````` example
[foo]: /url1

[foo]: /url2

[bar][foo]
.

bar

````````````````````````````````


Note that matching is performed on normalized strings, not parsed
inline content.  So the following does not match, even though the
labels define equivalent inline content:

```````````````````````````````` example
[bar][foo\!]

[foo!]: /url
.

[bar][foo!]

````````````````````````````````


[Link labels] cannot contain brackets, unless they are
backslash-escaped:

```````````````````````````````` example
[foo][ref[]

[ref[]: /uri
.

[foo][ref[]


[ref[]: /uri

````````````````````````````````


```````````````````````````````` example
[foo][ref[bar]]

[ref[bar]]: /uri
.

[foo][ref[bar]]


[ref[bar]]: /uri

````````````````````````````````


```````````````````````````````` example
[[[foo]]]

[[[foo]]]: /url
.

[[[foo]]]


[[[foo]]]: /url

````````````````````````````````


```````````````````````````````` example
[foo][ref\[]

[ref\[]: /uri
.

foo

````````````````````````````````


Note that in this example `]` is not backslash-escaped:

```````````````````````````````` example
[bar\\]: /uri

[bar\\]
.

bar\

````````````````````````````````


A [link label] must contain at least one [non-whitespace character]:

```````````````````````````````` example
[]

[]: /uri
.

[]


[]: /uri

````````````````````````````````


```````````````````````````````` example
[
 ]

[
 ]: /uri
.

[
]


[
]: /uri

````````````````````````````````


A [collapsed reference link](@)
consists of a [link label] that [matches] a
[link reference definition] elsewhere in the
document, followed by the string `[]`.
The contents of the first link label are parsed as inlines,
which are used as the link's text.  The link's URI and title are
provided by the matching reference link definition.  Thus,
`[foo][]` is equivalent to `[foo][foo]`.

```````````````````````````````` example
[foo][]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
[*foo* bar][]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


The link labels are case-insensitive:

```````````````````````````````` example
[Foo][]

[foo]: /url "title"
.

Foo

````````````````````````````````



As with full reference links, [whitespace] is not
allowed between the two sets of brackets:

```````````````````````````````` example
[foo] 
[]

[foo]: /url "title"
.

foo
[]

````````````````````````````````


A [shortcut reference link](@)
consists of a [link label] that [matches] a
[link reference definition] elsewhere in the
document and is not followed by `[]` or a link label.
The contents of the first link label are parsed as inlines,
which are used as the link's text.  The link's URI and title
are provided by the matching link reference definition.
Thus, `[foo]` is equivalent to `[foo][]`.

```````````````````````````````` example
[foo]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
[*foo* bar]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


```````````````````````````````` example
[[*foo* bar]]

[*foo* bar]: /url "title"
.

[foo bar]

````````````````````````````````


```````````````````````````````` example
[[bar [foo]

[foo]: /url
.

[[bar foo

````````````````````````````````


The link labels are case-insensitive:

```````````````````````````````` example
[Foo]

[foo]: /url "title"
.

Foo

````````````````````````````````


A space after the link text should be preserved:

```````````````````````````````` example
[foo] bar

[foo]: /url
.

foo bar

````````````````````````````````


If you just want bracketed text, you can backslash-escape the
opening bracket to avoid links:

```````````````````````````````` example
\[foo]

[foo]: /url "title"
.

[foo]

````````````````````````````````


Note that this is a link, because a link label ends with the first
following closing bracket:

```````````````````````````````` example
[foo*]: /url

*[foo*]
.

*foo*

````````````````````````````````


Full and compact references take precedence over shortcut
references:

```````````````````````````````` example
[foo][bar]

[foo]: /url1
[bar]: /url2
.

foo

````````````````````````````````

```````````````````````````````` example
[foo][]

[foo]: /url1
.

foo

````````````````````````````````

Inline links also take precedence:

```````````````````````````````` example
[foo]()

[foo]: /url1
.

foo

````````````````````````````````

```````````````````````````````` example
[foo](not a link)

[foo]: /url1
.

foo(not a link)

````````````````````````````````

In the following case `[bar][baz]` is parsed as a reference,
`[foo]` as normal text:

```````````````````````````````` example
[foo][bar][baz]

[baz]: /url
.

[foo]bar

````````````````````````````````


Here, though, `[foo][bar]` is parsed as a reference, since
`[bar]` is defined:

```````````````````````````````` example
[foo][bar][baz]

[baz]: /url1
[bar]: /url2
.

foobaz

````````````````````````````````


Here `[foo]` is not parsed as a shortcut reference, because it
is followed by a link label (even though `[bar]` is not defined):

```````````````````````````````` example
[foo][bar][baz]

[baz]: /url1
[foo]: /url2
.

[foo]bar

````````````````````````````````



## Images

Syntax for images is like the syntax for links, with one
difference. Instead of [link text], we have an
[image description](@).  The rules for this are the
same as for [link text], except that (a) an
image description starts with `![` rather than `[`, and
(b) an image description may contain links.
An image description has inline elements
as its contents.  When an image is rendered to HTML,
this is standardly used as the image's `alt` attribute.

```````````````````````````````` example
![foo](/url "title")
.

foo

````````````````````````````````


```````````````````````````````` example
![foo *bar*]

[foo *bar*]: train.jpg "train & tracks"
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo ![bar](/url)](/url2)
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo [bar](/url)](/url2)
.

foo bar

````````````````````````````````


Though this spec is concerned with parsing, not rendering, it is
recommended that in rendering to HTML, only the plain string content
of the [image description] be used.  Note that in
the above example, the alt attribute's value is `foo bar`, not `foo
[bar](/url)` or `foo bar`.  Only the plain string
content is rendered, without formatting.

```````````````````````````````` example
![foo *bar*][]

[foo *bar*]: train.jpg "train & tracks"
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo *bar*][foobar]

[FOOBAR]: train.jpg "train & tracks"
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo](train.jpg)
.

foo

````````````````````````````````


```````````````````````````````` example
My ![foo bar](/path/to/train.jpg  "title"   )
.

My foo bar

````````````````````````````````


```````````````````````````````` example
![foo]()
.

foo

````````````````````````````````


```````````````````````````````` example
![](/url)
.


````````````````````````````````


Reference-style:

```````````````````````````````` example
![foo][bar]

[bar]: /url
.

foo

````````````````````````````````


```````````````````````````````` example
![foo][bar]

[BAR]: /url
.

foo

````````````````````````````````


Collapsed:

```````````````````````````````` example
![foo][]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
![*foo* bar][]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


The labels are case-insensitive:

```````````````````````````````` example
![Foo][]

[foo]: /url "title"
.

Foo

````````````````````````````````


As with reference links, [whitespace] is not allowed
between the two sets of brackets:

```````````````````````````````` example
![foo] 
[]

[foo]: /url "title"
.

foo
[]

````````````````````````````````


Shortcut:

```````````````````````````````` example
![foo]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
![*foo* bar]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


Note that link labels cannot contain unescaped brackets:

```````````````````````````````` example
![[foo]]

[[foo]]: /url "title"
.

![[foo]]


[[foo]]: /url "title"

````````````````````````````````


The link labels are case-insensitive:

```````````````````````````````` example
![Foo]

[foo]: /url "title"
.

Foo

````````````````````````````````


If you just want a literal `!` followed by bracketed text, you can
backslash-escape the opening `[`:

```````````````````````````````` example
!\[foo]

[foo]: /url "title"
.

![foo]

````````````````````````````````


If you want a link after a literal `!`, backslash-escape the
`!`:

```````````````````````````````` example
\![foo]

[foo]: /url "title"
.

!foo

````````````````````````````````


## Autolinks

[Autolink](@)s are absolute URIs and email addresses inside
`<` and `>`. They are parsed as links, with the URL or email address
as the link label.

A [URI autolink](@) consists of `<`, followed by an
[absolute URI] followed by `>`.  It is parsed as
a link to the URI, with the URI as the link's label.

An [absolute URI](@),
for these purposes, consists of a [scheme] followed by a colon (`:`)
followed by zero or more characters other than ASCII
[whitespace] and control characters, `<`, and `>`.  If
the URI includes these characters, they must be percent-encoded
(e.g. `%20` for a space).

For purposes of this spec, a [scheme](@) is any sequence
of 2--32 characters beginning with an ASCII letter and followed
by any combination of ASCII letters, digits, or the symbols plus
("+"), period ("."), or hyphen ("-").

Here are some valid autolinks:

```````````````````````````````` example

.

http://foo.bar.baz

````````````````````````````````


```````````````````````````````` example

.

http://foo.bar.baz/test?q=hello&id=22&boolean

````````````````````````````````


```````````````````````````````` example

.

irc://foo.bar:2233/baz

````````````````````````````````


Uppercase is also fine:

```````````````````````````````` example

.

MAILTO:FOO@BAR.BAZ

````````````````````````````````


Note that many strings that count as [absolute URIs] for
purposes of this spec are not valid URIs, because their
schemes are not registered or because of other problems
with their syntax:

```````````````````````````````` example

.

a+b+c:d

````````````````````````````````


```````````````````````````````` example

.

made-up-scheme://foo,bar

````````````````````````````````


```````````````````````````````` example

.

http://../

````````````````````````````````


```````````````````````````````` example

.

localhost:5001/foo

````````````````````````````````


Spaces are not allowed in autolinks:

```````````````````````````````` example

.

<http://foo.bar/baz bim>

````````````````````````````````


Backslash-escapes do not work inside autolinks:

```````````````````````````````` example

.

http://example.com/\[\

````````````````````````````````


An [email autolink](@)
consists of `<`, followed by an [email address],
followed by `>`.  The link's label is the email address,
and the URL is `mailto:` followed by the email address.

An [email address](@),
for these purposes, is anything that matches
the [non-normative regex from the HTML5
spec](https://html.spec.whatwg.org/multipage/forms.html#e-mail-state-(type=email)):

    /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?
    (?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/

Examples of email autolinks:

```````````````````````````````` example

.

foo@bar.example.com

````````````````````````````````


```````````````````````````````` example

.

foo+special@Bar.baz-bar0.com

````````````````````````````````


Backslash-escapes do not work inside email autolinks:

```````````````````````````````` example

.

<foo+@bar.example.com>

````````````````````````````````


These are not autolinks:

```````````````````````````````` example
<>
.

<>

````````````````````````````````


```````````````````````````````` example
< http://foo.bar >
.

< http://foo.bar >

````````````````````````````````


```````````````````````````````` example

.

<m:abc>

````````````````````````````````


```````````````````````````````` example

.

<foo.bar.baz>

````````````````````````````````


```````````````````````````````` example
http://example.com
.

http://example.com

````````````````````````````````


```````````````````````````````` example
foo@bar.example.com
.

foo@bar.example.com

````````````````````````````````


## Raw HTML

Text between `<` and `>` that looks like an HTML tag is parsed as a
raw HTML tag and will be rendered in HTML without escaping.
Tag and attribute names are not limited to current HTML tags,
so custom tags (and even, say, DocBook tags) may be used.

Here is the grammar for tags:

A [tag name](@) consists of an ASCII letter
followed by zero or more ASCII letters, digits, or
hyphens (`-`).

An [attribute](@) consists of [whitespace],
an [attribute name], and an optional
[attribute value specification].

An [attribute name](@)
consists of an ASCII letter, `_`, or `:`, followed by zero or more ASCII
letters, digits, `_`, `.`, `:`, or `-`.  (Note:  This is the XML
specification restricted to ASCII.  HTML5 is laxer.)

An [attribute value specification](@)
consists of optional [whitespace],
a `=` character, optional [whitespace], and an [attribute
value].

An [attribute value](@)
consists of an [unquoted attribute value],
a [single-quoted attribute value], or a [double-quoted attribute value].

An [unquoted attribute value](@)
is a nonempty string of characters not
including [whitespace], `"`, `'`, `=`, `<`, `>`, or `` ` ``.

A [single-quoted attribute value](@)
consists of `'`, zero or more
characters not including `'`, and a final `'`.

A [double-quoted attribute value](@)
consists of `"`, zero or more
characters not including `"`, and a final `"`.

An [open tag](@) consists of a `<` character, a [tag name],
zero or more [attributes], optional [whitespace], an optional `/`
character, and a `>` character.

A [closing tag](@) consists of the string ``.

An [HTML comment](@) consists of ``,
where *text* does not start with `>` or `->`, does not end with `-`,
and does not contain `--`.  (See the
[HTML5 spec](http://www.w3.org/TR/html5/syntax.html#comments).)

A [processing instruction](@)
consists of the string ``, and the string
`?>`.

A [declaration](@) consists of the
string ``, and the character `>`.

A [CDATA section](@) consists of
the string ``, and the string `]]>`.

An [HTML tag](@) consists of an [open tag], a [closing tag],
an [HTML comment], a [processing instruction], a [declaration],
or a [CDATA section].

Here are some simple open tags:

```````````````````````````````` example

.


````````````````````````````````


Empty elements:

```````````````````````````````` example

.


````````````````````````````````


[Whitespace] is allowed:

```````````````````````````````` example

.


````````````````````````````````


With attributes:

```````````````````````````````` example

.


````````````````````````````````


Custom tag names can be used:

```````````````````````````````` example
Foo 
.

Foo 

````````````````````````````````


Illegal tag names, not parsed as HTML:

```````````````````````````````` example
<33> <__>
.

<33> <__>

````````````````````````````````


Illegal attribute names:

```````````````````````````````` example

.

<a h*#ref="hi">

````````````````````````````````


Illegal attribute values:

```````````````````````````````` example

.

</a href="foo">

````````````````````````````````


Comments:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


```````````````````````````````` example
foo 
.

foo <!-- not a comment -- two hyphens -->

````````````````````````````````


Not comments:

```````````````````````````````` example
foo  foo -->

foo 
.

foo <!--> foo -->


foo <!-- foo--->

````````````````````````````````


Processing instructions:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


Declarations:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


CDATA sections:

```````````````````````````````` example
foo &<]]>
.

foo &<]]>

````````````````````````````````


Entity and numeric character references are preserved in HTML
attributes:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


Backslash escapes do not work in HTML attributes:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


```````````````````````````````` example

.

<a href=""">

````````````````````````````````


## Hard line breaks

A line break (not in a code span or HTML tag) that is preceded
by two or more spaces and does not occur at the end of a block
is parsed as a [hard line break](@) (rendered
in HTML as a `
` tag):

```````````````````````````````` example
foo  
baz
.

foo

baz

````````````````````````````````


For a more visible alternative, a backslash before the
[line ending] may be used instead of two spaces:

```````````````````````````````` example
foo\
baz
.

foo

baz

````````````````````````````````


More than two spaces can be used:

```````````````````````````````` example
foo       
baz
.

foo

baz

````````````````````````````````


Leading spaces at the beginning of the next line are ignored:

```````````````````````````````` example
foo  
     bar
.

foo

bar

````````````````````````````````


```````````````````````````````` example
foo\
     bar
.

foo

bar

````````````````````````````````


Line breaks can occur inside emphasis, links, and other constructs
that allow inline content:

```````````````````````````````` example
*foo  
bar*
.

foo

bar

````````````````````````````````


```````````````````````````````` example
*foo\
bar*
.

foo

bar

````````````````````````````````


Line breaks do not occur inside code spans

```````````````````````````````` example
`code 
span`
.

code  span

````````````````````````````````


```````````````````````````````` example
`code\
span`
.

code\ span

````````````````````````````````


or HTML tags:

```````````````````````````````` example

.


````````````````````````````````


```````````````````````````````` example

.


````````````````````````````````


Hard line breaks are for separating inline content within a block.
Neither syntax for hard line breaks works at the end of a paragraph or
other block element:

```````````````````````````````` example
foo\
.

foo\

````````````````````````````````


```````````````````````````````` example
foo  
.

foo

````````````````````````````````


```````````````````````````````` example
### foo\
.

foo\

````````````````````````````````


```````````````````````````````` example
### foo  
.

foo

````````````````````````````````


## Soft line breaks

A regular line break (not in a code span or HTML tag) that is not
preceded by two or more spaces or a backslash is parsed as a
[softbreak](@).  (A softbreak may be rendered in HTML either as a
[line ending] or as a space. The result will be the same in
browsers. In the examples here, a [line ending] will be used.)

```````````````````````````````` example
foo
baz
.

foo
baz

````````````````````````````````


Spaces at the end of the line and beginning of the next line are
removed:

```````````````````````````````` example
foo 
 baz
.

foo
baz

````````````````````````````````


A conforming parser may render a soft line break in HTML either as a
line break or as a space.

A renderer may also provide an option to render soft line breaks
as hard line breaks.

## Textual content

Any characters not given an interpretation by the above rules will
be parsed as plain textual content.

```````````````````````````````` example
hello $.;'there
.

hello $.;'there

````````````````````````````````


```````````````````````````````` example
Foo χρῆν
.

Foo χρῆν

````````````````````````````````


Internal spaces are preserved verbatim:

```````````````````````````````` example
Multiple     spaces
.

Multiple     spaces

````````````````````````````````




# Appendix: A parsing strategy

In this appendix we describe some features of the parsing strategy
used in the CommonMark reference implementations.

## Overview

Parsing has two phases:

1. In the first phase, lines of input are consumed and the block
structure of the document---its division into paragraphs, block quotes,
list items, and so on---is constructed.  Text is assigned to these
blocks but not parsed. Link reference definitions are parsed and a
map of links is constructed.

2. In the second phase, the raw text contents of paragraphs and headings
are parsed into sequences of Markdown inline elements (strings,
code spans, links, emphasis, and so on), using the map of link
references constructed in phase 1.

At each point in processing, the document is represented as a tree of
**blocks**.  The root of the tree is a `document` block.  The `document`
may have any number of other blocks as **children**.  These children
may, in turn, have other blocks as children.  The last child of a block
is normally considered **open**, meaning that subsequent lines of input
can alter its contents.  (Blocks that are not open are **closed**.)
Here, for example, is a possible document tree, with the open blocks
marked by arrows:

``` tree
-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
         list_item
           paragraph
             "Qui *quodsi iracundia*"
      -> list_item
        -> paragraph
             "aliquando id"
```

## Phase 1: block structure

Each line that is processed has an effect on this tree.  The line is
analyzed and, depending on its contents, the document may be altered
in one or more of the following ways:

1. One or more open blocks may be closed.
2. One or more new blocks may be created as children of the
   last open block.
3. Text may be added to the last (deepest) open block remaining
   on the tree.

Once a line has been incorporated into the tree in this way,
it can be discarded, so input can be read in a stream.

For each line, we follow this procedure:

1. First we iterate through the open blocks, starting with the
root document, and descending through last children down to the last
open block.  Each block imposes a condition that the line must satisfy
if the block is to remain open.  For example, a block quote requires a
`>` character.  A paragraph requires a non-blank line.
In this phase we may match all or just some of the open
blocks.  But we cannot close unmatched blocks yet, because we may have a
[lazy continuation line].

2.  Next, after consuming the continuation markers for existing
blocks, we look for new block starts (e.g. `>` for a block quote).
If we encounter a new block start, we close any blocks unmatched
in step 1 before creating the new block as a child of the last
matched block.

3.  Finally, we look at the remainder of the line (after block
markers like `>`, list markers, and indentation have been consumed).
This is text that can be incorporated into the last open
block (a paragraph, code block, heading, or raw HTML).

Setext headings are formed when we see a line of a paragraph
that is a [setext heading underline].

Reference link definitions are detected when a paragraph is closed;
the accumulated text lines are parsed to see if they begin with
one or more reference link definitions.  Any remainder becomes a
normal paragraph.

We can see how this works by considering how the tree above is
generated by four lines of Markdown:

``` markdown
> Lorem ipsum dolor
sit amet.
> - Qui *quodsi iracundia*
> - aliquando id
```

At the outset, our document model is just

``` tree
-> document
```

The first line of our text,

``` markdown
> Lorem ipsum dolor
```

causes a `block_quote` block to be created as a child of our
open `document` block, and a `paragraph` block as a child of
the `block_quote`.  Then the text is added to the last open
block, the `paragraph`:

``` tree
-> document
  -> block_quote
    -> paragraph
         "Lorem ipsum dolor"
```

The next line,

``` markdown
sit amet.
```

is a "lazy continuation" of the open `paragraph`, so it gets added
to the paragraph's text:

``` tree
-> document
  -> block_quote
    -> paragraph
         "Lorem ipsum dolor\nsit amet."
```

The third line,

``` markdown
> - Qui *quodsi iracundia*
```

causes the `paragraph` block to be closed, and a new `list` block
opened as a child of the `block_quote`.  A `list_item` is also
added as a child of the `list`, and a `paragraph` as a child of
the `list_item`.  The text is then added to the new `paragraph`:

``` tree
-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
      -> list_item
        -> paragraph
             "Qui *quodsi iracundia*"
```

The fourth line,

``` markdown
> - aliquando id
```

causes the `list_item` (and its child the `paragraph`) to be closed,
and a new `list_item` opened up as child of the `list`.  A `paragraph`
is added as a child of the new `list_item`, to contain the text.
We thus obtain the final tree:

``` tree
-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
         list_item
           paragraph
             "Qui *quodsi iracundia*"
      -> list_item
        -> paragraph
             "aliquando id"
```

## Phase 2: inline structure

Once all of the input has been parsed, all open blocks are closed.

We then "walk the tree," visiting every node, and parse raw
string contents of paragraphs and headings as inlines.  At this
point we have seen all the link reference definitions, so we can
resolve reference links as we go.

``` tree
document
  block_quote
    paragraph
      str "Lorem ipsum dolor"
      softbreak
      str "sit amet."
    list (type=bullet tight=true bullet_char=-)
      list_item
        paragraph
          str "Qui "
          emph
            str "quodsi iracundia"
      list_item
        paragraph
          str "aliquando id"
```

Notice how the [line ending] in the first paragraph has
been parsed as a `softbreak`, and the asterisks in the first list item
have become an `emph`.

### An algorithm for parsing nested emphasis and links

By far the trickiest part of inline parsing is handling emphasis,
strong emphasis, links, and images.  This is done using the following
algorithm.

When we're parsing inlines and we hit either

- a run of `*` or `_` characters, or
- a `[` or `![`

we insert a text node with these symbols as its literal content, and we
add a pointer to this text node to the [delimiter stack](@).

The [delimiter stack] is a doubly linked list.  Each
element contains a pointer to a text node, plus information about

- the type of delimiter (`[`, `![`, `*`, `_`)
- the number of delimiters,
- whether the delimiter is "active" (all are active to start), and
- whether the delimiter is a potential opener, a potential closer,
  or both (which depends on what sort of characters precede
  and follow the delimiters).

When we hit a `]` character, we call the *look for link or image*
procedure (see below).

When we hit the end of the input, we call the *process emphasis*
procedure (see below), with `stack_bottom` = NULL.

#### *look for link or image*

Starting at the top of the delimiter stack, we look backwards
through the stack for an opening `[` or `![` delimiter.

- If we don't find one, we return a literal text node `]`.

- If we do find one, but it's not *active*, we remove the inactive
  delimiter from the stack, and return a literal text node `]`.

- If we find one and it's active, then we parse ahead to see if
  we have an inline link/image, reference link/image, compact reference
  link/image, or shortcut reference link/image.

  + If we don't, then we remove the opening delimiter from the
    delimiter stack and return a literal text node `]`.

  + If we do, then

    * We return a link or image node whose children are the inlines
      after the text node pointed to by the opening delimiter.

    * We run *process emphasis* on these inlines, with the `[` opener
      as `stack_bottom`.

    * We remove the opening delimiter.

    * If we have a link (and not an image), we also set all
      `[` delimiters before the opening delimiter to *inactive*.  (This
      will prevent us from getting links within links.)

#### *process emphasis*

Parameter `stack_bottom` sets a lower bound to how far we
descend in the [delimiter stack].  If it is NULL, we can
go all the way to the bottom.  Otherwise, we stop before
visiting `stack_bottom`.

Let `current_position` point to the element on the [delimiter stack]
just above `stack_bottom` (or the first element if `stack_bottom`
is NULL).

We keep track of the `openers_bottom` for each delimiter
type (`*`, `_`) and each length of the closing delimiter run
(modulo 3).  Initialize this to `stack_bottom`.

Then we repeat the following until we run out of potential
closers:

- Move `current_position` forward in the delimiter stack (if needed)
  until we find the first potential closer with delimiter `*` or `_`.
  (This will be the potential closer closest
  to the beginning of the input -- the first one in parse order.)

- Now, look back in the stack (staying above `stack_bottom` and
  the `openers_bottom` for this delimiter type) for the
  first matching potential opener ("matching" means same delimiter).

- If one is found:

  + Figure out whether we have emphasis or strong emphasis:
    if both closer and opener spans have length >= 2, we have
    strong, otherwise regular.

  + Insert an emph or strong emph node accordingly, after
    the text node corresponding to the opener.

  + Remove any delimiters between the opener and closer from
    the delimiter stack.

  + Remove 1 (for regular emph) or 2 (for strong emph) delimiters
    from the opening and closing text nodes.  If they become empty
    as a result, remove them and remove the corresponding element
    of the delimiter stack.  If the closing node is removed, reset
    `current_position` to the next element in the stack.

- If none is found:

  + Set `openers_bottom` to the element before `current_position`.
    (We know that there are no openers for this kind of closer up to and
    including this point, so this puts a lower bound on future searches.)

  + If the closer at `current_position` is not a potential opener,
    remove it from the delimiter stack (since we know it can't
    be a closer either).

  + Advance `current_position` to the next element in the stack.

After we're done, we remove all delimiters above `stack_bottom` from the
delimiter stack.

markdown-it-py-4.2.0/codecov.yml000066400000000000000000000002421517710005200165400ustar00rootroot00000000000000coverage:
  status:
    project:
      default:
        target: 95%
        threshold: 0.2%
    patch:
      default:
        target: 80%
        threshold: 0.2%
markdown-it-py-4.2.0/docs/000077500000000000000000000000001517710005200153255ustar00rootroot00000000000000markdown-it-py-4.2.0/docs/.gitignore000066400000000000000000000000101517710005200173040ustar00rootroot00000000000000*.ipynb
markdown-it-py-4.2.0/docs/Makefile000066400000000000000000000016061517710005200167700ustar00rootroot00000000000000# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS    ?=
SPHINXBUILD   ?= sphinx-build
SOURCEDIR     = .
BUILDDIR      = _build

# Put it first so that "make" without argument is like "make help".
help:
	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# raise warnings to errors
html-strict:
	@$(SPHINXBUILD) -b html -nW --keep-going "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

# increase logging level to verbose
html-verbose:
	@$(SPHINXBUILD) -b html -v "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
markdown-it-py-4.2.0/docs/_static/000077500000000000000000000000001517710005200167535ustar00rootroot00000000000000markdown-it-py-4.2.0/docs/_static/custom.css000066400000000000000000000002111517710005200207710ustar00rootroot00000000000000.cell_output > .output > .highlight > pre {
    border-left-color: green;
    border-left-width: medium;
    border-left-style: solid;
}
markdown-it-py-4.2.0/docs/_static/markdown-it-py.svg000066400000000000000000000132041517710005200223560ustar00rootroot00000000000000

































markdown-it-py-4.2.0/docs/architecture.md000066400000000000000000000152421517710005200203350ustar00rootroot00000000000000(md/architecture)=

# Design principles

(md/data-flow)=
## Data flow

Input data is parsed via nested chains of rules. There are 3 nested chains -
`core`, `block` & `inline`:

```
core
    core.rule1 (normalize)
    ...
    core.ruleX

    block
        block.rule1 (blockquote)
        ...
        block.ruleX

    core.ruleX1 (intermediate rule that applies on block tokens, nothing yet)
    ...
    core.ruleXX

    inline (applied to each block token with "inline" type)
        inline.rule1 (text)
        ...
        inline.ruleX

    core.ruleYY (applies to all tokens)
    ... (abbreviation, footnote, typographer, linkifier)

```

The result of the parsing is a *list of tokens*, that will be passed to the `renderer` to generate the html content.

These tokens can be themselves parsed again to generate more tokens (ex: a `list token` can be divided into multiple `inline tokens`).

An `env` sandbox can be used alongside tokens to inject external variables for your parsers and renderers.

Each chain (core / block / inline) uses an independent `state` object when parsing data, so that each parsing operation is independent and can be disabled on the fly.


## Token stream

Instead of traditional AST we use more low-level data representation - *tokens*.
The difference is simple:

- Tokens are a simple sequence (Array).
- Opening and closing tags are separate.
- There are special token objects, "inline containers", having nested tokens.
  sequences with inline markup (bold, italic, text, ...).

See [token class](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/token.py)
for details about each token content.

In total, a token stream is:

- On the top level - array of paired or single "block" tokens:
  - open/close for headers, lists, blockquotes, paragraphs, ...
  - codes, fenced blocks, horizontal rules, html blocks, inlines containers
- Each inline token has a `.children` property with a nested token stream for inline content:
  - open/close for strong, em, link, code, ...
  - text, line breaks

Why not AST? Because it's not needed for our tasks. We follow KISS principle.
If you wish - you can call a parser without a renderer and convert the token stream
to an AST.

More details about tokens:

- [Renderer source](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/renderer.py)
- [Token source](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/token.py)
- [Live demo](https://markdown-it.github.io/) - type your text and click `debug` tab.


## Rules

Rules are functions, doing "magic" with parser `state` objects. A rule is associated with one or more *chains* and is unique. For instance, a `blockquote` token is associated with `blockquote`, `paragraph`, `heading` and `list` chains.

Rules are managed by names via [Ruler](https://markdown-it.github.io/markdown-it/#Ruler) instances and can be  `enabled` / `disabled` from the [MarkdownIt](https://markdown-it.github.io/markdown-it/#MarkdownIt) methods.

Note that some rules have a `validation mode` - in this mode rules do not
modify the token stream, and only look ahead for the end of a token. It's one
important design principle - a token stream is "write only" on block & inline parse stages.

Parsers are designed to keep rules independent of each other. You can safely enable/disable them, or
add new ones. There are no universal recipes for how to create new rules - design of
distributed state machines with good data isolation is a tricky business. But you
can investigate existing rules & plugins to see possible approaches.

Also, in complex cases you can try to ask for help in tracker. Condition is very
simple - it should be clear from your ticket, that you studied docs, sources,
and tried to do something yourself. We never reject with help to real developers.


## Renderer

After the token stream is generated, it's passed to a [renderer](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/renderer.py).
It then plays all the tokens, passing each to a rule with the same name as token type.

Renderer rules are located in `md.renderer.rules[name]` and are simple functions
with the same signature:

```python
def function(renderer, tokens, idx, options, env):
  return htmlResult
```

In many cases that allows easy output change even without parser intrusion.
For example, let's replace images with vimeo links to player's iframe:

```python
import re
md = MarkdownIt("commonmark")

vimeoRE = re.compile(r'^https?:\/\/(www\.)?vimeo.com\/(\d+)($|\/)')

def render_vimeo(self, tokens, idx, options, env):
    token = tokens[idx]

    if vimeoRE.match(token.attrs["src"]):

        ident = vimeoRE.match(token.attrs["src"])[2]

        return ('
\n' +
               '  \n' +
               '
\n')
    return self.image(tokens, idx, options, env)

md = MarkdownIt("commonmark")
md.add_render_rule("image", render_vimeo)
print(md.render("![](https://www.vimeo.com/123)"))
```

Here is another example, how to add `target="_blank"` to all links:

```python
from markdown_it import MarkdownIt

def render_blank_link(self, tokens, idx, options, env):
    tokens[idx].attrSet("target", "_blank")

    # pass token to default renderer.
    return self.renderToken(tokens, idx, options, env)

md = MarkdownIt("commonmark")
md.add_render_rule("link_open", render_blank_link)
print(md.render("[a]\n\n[a]: b"))
```

Note, if you need to add attributes, you can do things without renderer override.
For example, you can update tokens in `core` chain. That is slower, than direct
renderer override, but can be more simple.

You also can write your own renderer to generate other formats than HTML, such as
JSON/XML... You can even use it to generate AST.

## Summary

This was mentioned in [Data flow](md/data-flow), but let's repeat the sequence again:

1. Blocks are parsed, and the top level of the token stream filled with block tokens.
2. Content on inline containers is parsed, filling `.children` properties.
3. Rendering happens.

And somewhere between you can apply additional transformations :) . Full content
of each chain can be seen on the top of
[parser_core.py](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/parser_core.py),
[parser_block.py](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/parser_block.py) and
[parser_inline.py](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/parser_inline.py)
files.

Also you can change output directly in [renderer](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/renderer.py) for many simple cases.
markdown-it-py-4.2.0/docs/conf.py000066400000000000000000000106231517710005200166260ustar00rootroot00000000000000# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
from glob import glob
import os

# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = "markdown-it-py"
copyright = "2020, executable book project"
author = "executable book project"


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.viewcode",
    "sphinx.ext.intersphinx",
    "myst_parser",
    "sphinx_copybutton",
    "sphinx_design",
    "jupyter_sphinx",
]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

nitpicky = True
nitpick_ignore_regex = [
    ("py:.*", name)
    for name in (
        ".*_ItemTV",
        ".*_NodeType",
        ".*Literal.*",
        ".*_Result",
        ".*_State",
        "EnvType",
        "Path",
        "Ellipsis",
        "NotRequired",
    )
]

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_title = "markdown-it-py"
html_logo = html_favicon = "_static/markdown-it-py.svg"
html_theme = "sphinx_book_theme"
html_theme_options = {
    "home_page_in_toc": True,
    "use_repository_button": True,
    "use_edit_page_button": True,
    "repository_url": "https://github.com/executablebooks/markdown-it-py",
    "repository_branch": "master",
    "path_to_docs": "docs",
}
html_static_path = ["_static"]
html_css_files = ["custom.css"]

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ["_static"]


intersphinx_mapping = {
    "python": ("https://docs.python.org/3.10", None),
    "mdit-py-plugins": ("https://mdit-py-plugins.readthedocs.io/en/latest/", None),
}


def run_apidoc(app):
    """generate apidoc

    See: https://github.com/rtfd/readthedocs.org/issues/1139
    """
    import os
    import shutil

    import sphinx
    from sphinx.ext import apidoc

    logger = sphinx.util.logging.getLogger(__name__)
    logger.info("running apidoc")
    # get correct paths
    this_folder = os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
    api_folder = os.path.join(this_folder, "api")
    module_path = os.path.normpath(os.path.join(this_folder, "../"))
    ignore_paths = ["../scripts", "../conftest.py", "../tests", "../benchmarking"]
    ignore_paths = [
        os.path.normpath(os.path.join(this_folder, p)) for p in ignore_paths
    ]
    # functions from these modules are all imported in the __init__.py with __all__
    for rule in ("block", "core", "inline"):
        for path in glob(
            os.path.normpath(
                os.path.join(this_folder, f"../markdown_it/rules_{rule}/*.py")
            )
        ):
            if os.path.basename(path) not in ("__init__.py", f"state_{rule}.py"):
                ignore_paths.append(path)

    if os.path.exists(api_folder):
        shutil.rmtree(api_folder)
    os.mkdir(api_folder)

    argv = ["-M", "--separate", "-o", api_folder, module_path, *ignore_paths]

    apidoc.OPTIONS.append("ignore-module-all")
    apidoc.main(argv)

    # we don't use this
    if os.path.exists(os.path.join(api_folder, "modules.rst")):
        os.remove(os.path.join(api_folder, "modules.rst"))


def setup(app):
    """Add functions to the Sphinx setup."""
    if os.environ.get("SKIP_APIDOC", None) is None:
        app.connect("builder-inited", run_apidoc)
markdown-it-py-4.2.0/docs/contributing.md000066400000000000000000000110361517710005200203570ustar00rootroot00000000000000# Contribute

We welcome all contributions! ✨

See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contribute/) for general details, and below for guidance specific to markdown-it-py.

Before continuing, make sure you've read:

1. [Architecture description](md/architecture)
2. [Security considerations](md/security)
3. [API documentation](api/markdown_it)

## Development guidance

Details of the port can be found in the `markdown_it/port.yaml` and in `port.yaml` files, within the extension folders.

## Code Style

Code style is tested using [ruff](https://github.com/astral-sh/ruff), with the configuration set in `pyproject.toml`, and code formatted with [black](https://github.com/ambv/black).

Installing with `markdown-it-py[code_style]` makes the [pre-commit](https://pre-commit.com/) package available, which will ensure this style is met before commits are submitted, by reformatting the code and testing for lint errors.
It can be setup by:

```shell
>> cd markdown-it-py
>> pre-commit install
```

Editors like VS Code also have automatic code reformat utilities, which can adhere to this standard.

All functions and class methods should be annotated with types and include a docstring.

## Testing

For code tests, markdown-it-py uses [pytest](https://docs.pytest.org):

```shell
>> cd markdown-it-py
>> pytest
```

You can also use [tox](https://tox.readthedocs.io), to run the tests in multiple isolated environments (see the `tox.ini` file for available test environments):

```shell
>> cd markdown-it-py
>> tox -p
```

This can also be used to run benchmarking tests using [pytest-benchmark](https://pytest-benchmark.readthedocs.io):

```shell
>> cd markdown-it-py
tox -e py310-bench-packages -- --benchmark-min-rounds 50
```

For documentation build tests:

```shell
>> cd markdown-it-py/docs
>> make clean
>> make html-strict
```

### Updating the commonmark specification

If you need to update the commonmark specification, you can do so by running:

```shell
>> cd markdown-it-py
>> python tests/test_cmark_spec/get_cmark_spec.py
```

or

```shell
>> cd markdown-it-py
>> uv run tests/test_cmark_spec/get_cmark_spec.py
```

## Contributing a plugin

1. Does it already exist as JavaScript implementation ([see npm](https://www.npmjs.com/search?q=keywords:markdown-it-plugin))?
   Where possible try to port directly from that.
   It is usually better to modify existing code, instead of writing all from scratch.
2. Try to find the right place for your plugin rule:
  - Will it conflict with existing markup (by priority)?
    - If yes - you need to write an inline or block rule.
    - If no - you can morph tokens within core chains.
  - Remember that token morphing in core chains is always more simple than writing
    block or inline rules, if you don't copy existing ones. However,
    block and inline rules are usually faster.
  - Sometimes, it's enough to only modify the renderer, for example, to add
    header IDs or `target="_blank"` for the links.

## FAQ

### I need async rule, how to do it?

Sorry. You can't do it directly. All complex parsers are sync by nature. But you
can use workarounds:

1. On parse phase, replace content by random number and store it in `env`.
2. Do async processing over collected data.
3. Render content and replace those random numbers with text; or replace first, then render.

Alternatively, you can render HTML, then parse it to DOM, or
[cheerio](https://github.com/cheeriojs/cheerio) AST, and apply transformations
in a more convenient way.

### How to replace part of text token with link?

The right sequence is to split text to several tokens and add link tokens in between.
The result will be: `text` + `link_open` + `text` + `link_close` + `text`.

See implementations of [linkify](https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/linkify.mjs) and [emoji](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/replace.mjs) - those do text token splits.

__Note:__ Don't try to replace text with HTML markup! That's not secure.

### Why is my inline rule not executed?

The inline parser skips pieces of texts to optimize speed. It stops only on [a small set of chars](https://github.com/executablebooks/markdown-it-py/blob/master/markdown_it/parser_inline.py), which can be tokens.

If your inline rule needs to trigger on a character that is not in the default terminator set, you can register it via `md.inline.add_terminator_char`:

```python
def my_plugin(md: MarkdownIt) -> None:
    md.inline.add_terminator_char("w")  # stop text rule on 'w'
    md.inline.ruler.push("my_rule", my_inline_rule)
```
markdown-it-py-4.2.0/docs/index.md000066400000000000000000000036061517710005200167630ustar00rootroot00000000000000# markdown-it-py

> Markdown parser done right.

- {fa}`check,text-success mr-1` Follows the __[CommonMark spec](http://spec.commonmark.org/)__ for baseline parsing
- {fa}`check,text-success mr-1` Configurable syntax: you can add new rules and even replace existing ones.
- {fa}`check,text-success mr-1` Pluggable: Adds syntax extensions to extend the parser (see the [plugin list](md/plugins))
- {fa}`check,text-success mr-1` High speed (see our [benchmarking tests](md/performance))
- {fa}`check,text-success mr-1` Easy to configure for [security](md/security)
- {fa}`check,text-success mr-1` Member of [Google's Assured Open Source Software](https://cloud.google.com/assured-open-source-software/docs/supported-packages)

For a good introduction to [markdown-it] see the __[Live demo](https://markdown-it.github.io)__.
This is a Python port of the well used [markdown-it], and some of its associated plugins.
The driving design philosophy of the port has been to change as little of the fundamental code structure (file names, function name, etc) as possible, just sprinkling in a little Python syntactical sugar ✨.
It is very simple to write complementary extensions for both language implementations!

## References & Thanks

Big thanks to the authors of [markdown-it]

- Alex Kocharin [github/rlidwka](https://github.com/rlidwka)
- Vitaly Puzrin [github/puzrin](https://github.com/puzrin)

Also [John MacFarlane](https://github.com/jgm) for his work on the CommonMark spec and reference implementations.

## Related Links

-  - reference CommonMark implementations in C & JS, also contains latest spec & online demo.
-  - CommonMark forum, good place to collaborate developers' efforts.

```{toctree}
:maxdepth: 2

using
architecture
security
performance
plugins
contributing
api/markdown_it
```

[markdown-it]: https://github.com/markdown-it/markdown-it
markdown-it-py-4.2.0/docs/performance.md000066400000000000000000000025551517710005200201570ustar00rootroot00000000000000(md/performance)=

# Performance

You can view our continuous integration benchmarking analysis at: ,
or you can run it for yourself within the repository:

```bash
tox -e py311-bench-packages -- --benchmark-columns mean,stddev
```

|       package        | version | mean (ms) | stddev  |
| -------------------- | ------- | --------- | ------- |
| markdown-it-pyrs[^1] | 0.2.1   | 6.410     | 0.426   |
| mistune[^2]          | 3.0.1   | 80.409    | 2.335   |
| **markdown-it-py**   | 3.0.0   | 97.242    | 4.427   |
| mistletoe            | 1.1.0   | 99.633    | 4.628   |
| commonmark-py        | 0.9.1   | 300.403   | 9.706   |
| pymarkdown           | 3.4.3   | 387.775   | 10.394  |
| pymarkdown (+extras) | 3.4.3   | 646.564   | 11.316  |
| panflute             | 2.3.0   | 860.105   | 208.607 |

As you can see, `markdown-it-py` doesn't pay with speed for it's flexibility.

[^1]: `markdown-it-pyrs` is a Rust implementation of `markdown-it-py`'s parser, in beta development, check it out at: 
[^2]: `mistune` is not CommonMark compliant, which is what allows for its
faster parsing, at the expense of issues, for example, with nested inline parsing.
See [mistletoes's explanation](https://github.com/miyuchina/mistletoe/blob/master/performance.md) for further details.
markdown-it-py-4.2.0/docs/plugins.md000066400000000000000000000030471517710005200173340ustar00rootroot00000000000000(md/plugins)=

# Plugin extensions

The following plugins are embedded within the core package:

- [tables](https://help.github.com/articles/organizing-information-with-tables/) (GFM)
- [strikethrough](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) (GFM)
- [task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) (GFM) — `- [x] done`
- [alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) (GFM) — `> [!NOTE]`

These can be enabled individually:

```python
from markdown_it import MarkdownIt
md = MarkdownIt("commonmark").enable('table')
```

or as part of a configuration:

```python
from markdown_it import MarkdownIt
md = MarkdownIt("gfm-like")   # tables, strikethrough, linkify
md = MarkdownIt("gfm-like2")  # + task lists, alerts, single-tilde strikethrough
```

```{seealso}
See [](using.md)
```

Many other plugins are then available *via* the `mdit-py-plugins` package, including:

- Front-matter
- Footnotes
- Definition lists
- Task lists
- Heading anchors
- LaTeX math
- Containers
- Word count

For full information see: 

Or you can write them yourself!

They can be chained and loaded *via*:

```python
from markdown_it import MarkdownIt
from mdit_py_plugins import plugin1, plugin2
md = MarkdownIt().use(plugin1, keyword=value).use(plugin2, keyword=value)
html_string = md.render("some *Markdown*")
```
markdown-it-py-4.2.0/docs/requirements.txt000066400000000000000000000002361517710005200206120ustar00rootroot00000000000000# temporary requirement until myst-parser is updated to allow markdown-it-py v4
git+https://github.com/executablebooks/MyST-Parser.git@update-markdown-parser
markdown-it-py-4.2.0/docs/security.md000066400000000000000000000042371517710005200175240ustar00rootroot00000000000000(md/security)=

# Security

By default, the `MarkdownIt` parser is initialised to comply with the [CommonMark spec](https://spec.commonmark.org/), which allows for parsing arbitrary HTML tags.
This can be useful for many use cases, for example when writing articles for one's own blog or composing technical documentation for a software package.

However, extra precautions are needed when parsing content from untrusted sources.
Generally, the output should be run through sanitizers to ensure safety and prevent vulnerabilities like cross-site scripting (XSS).
With `markdown-it`/`markdown-it-py`, there are two strategies for doing this:

1. Enable HTML (as is needed for full CommonMark compliance), and then use external sanitizer package(s).
2. Disable HTML, and then use [plugins](md/plugins) to selectively enable markup features.
   This removes the need for further sanitizing.

```{warning}
Unlike the original `markdown-it` JavaScript project, which uses the second, safe-by-default strategy, `markdown-it-py` enables the more convenient, but less secure, CommonMark-compliant settings by default.

This is not safe when using `markdown-it-py` in web applications that parse user-submitted content.
In such cases, [using the `js-default` preset](using.md) is strongly recommended.
For example:

```python
from markdown_it import MarkdownIt
MarkdownIt("js-default").render("*user-submitted* text")
```

Note that even with the default configuration, `markdown-it-py` prohibits some kinds of links which could be used for XSS:

- `javascript:`, `vbscript:`
- `file:`
- `data:` (except some images: gif/png/jpeg/webp)

If you find a security problem, please report it to .

## Plugins

Usually, plugins operate with tokenized content, and that's enough to provide safe output.

But there is one non-evident case you should know - don't allow plugins to generate arbitrary `id` and `name` attributes.
If those depend on user input - always add prefixes to avoid DOM clobbering.
See [discussion](https://github.com/markdown-it/markdown-it/issues/28) for details.

So, if you decide to use plugins that add extended class syntax or autogenerate header anchors - be careful.
markdown-it-py-4.2.0/docs/using.md000066400000000000000000000253621517710005200170040ustar00rootroot00000000000000---
jupytext:
  formats: ipynb,md:myst
  text_representation:
    extension: .md
    format_name: myst
    format_version: '0.8'
    jupytext_version: 1.4.2
kernelspec:
  display_name: Python 3
  language: python
  name: python3
---

# Using `markdown_it`

> This document can be opened to execute with [Jupytext](https://jupytext.readthedocs.io)!

markdown-it-py may be used as an API *via* the [`markdown-it-py`](https://pypi.org/project/markdown-it-py/) package.

The raw text is first parsed to syntax 'tokens',
then these are converted to other formats using 'renderers'.

+++

## Quick-Start

The simplest way to understand how text will be parsed is using:

```{jupyter-execute}
from pprint import pprint
from markdown_it import MarkdownIt
```

```{jupyter-execute}
md = MarkdownIt()
md.render("some *text*")
```

```{jupyter-execute}
for token in md.parse("some *text*"):
    print(token)
    print()
```

## The Parser

+++

The `MarkdownIt` class is instantiated with parsing configuration options,
dictating the syntax rules and additional options for the parser and renderer.
You can define this configuration *via* directly supplying a dictionary or a preset name:

- `zero`: This configures the minimum components to parse text (i.e. just paragraphs and text)
- `commonmark` (default): This configures the parser to strictly comply with the [CommonMark specification](http://spec.commonmark.org/).
- `js-default`: This is the default in the JavaScript version.
  Compared to `commonmark`, it disables HTML parsing and enables the table and strikethrough components.
- `gfm-like`: This configures the parser to approximately comply with the [GitHub Flavored Markdown specification](https://github.github.com/gfm/).
  Compared to `commonmark`, it enables the table, strikethrough and linkify components.
  **Important**, to use this configuration you must have `linkify-it-py` installed.
- `gfm-like2`: Builds on `gfm-like` and additionally enables task lists (`- [x] done`),
  GitHub-style alerts (`> [!NOTE]`), and single-tilde strikethrough (`~text~`).
  **Important**, to use this configuration you must have `linkify-it-py` installed.

```{jupyter-execute}
from markdown_it.presets import zero
zero.make()
```

```{jupyter-execute}
md = MarkdownIt("zero")
md.options
```

You can also override specific options:

```{jupyter-execute}
md = MarkdownIt("zero", {"maxNesting": 99})
md.options
```

```{jupyter-execute}
pprint(md.get_active_rules())
```

You can find all the parsing rules in the source code:
`parser_core.py`, `parser_block.py`,
`parser_inline.py`.

```{jupyter-execute}
pprint(md.get_all_rules())
```

Any of the parsing rules can be enabled/disabled, and these methods are "chainable":

```{jupyter-execute}
md.render("- __*emphasise this*__")
```

```{jupyter-execute}
md.enable(["list", "emphasis"]).render("- __*emphasise this*__")
```

You can temporarily modify rules with the `reset_rules` context manager.

```{jupyter-execute}
with md.reset_rules():
    md.disable("emphasis")
    print(md.render("__*emphasise this*__"))
md.render("__*emphasise this*__")
```

Additionally `renderInline` runs the parser with all block syntax rules disabled.

```{jupyter-execute}
md.renderInline("__*emphasise this*__")
```

### Typographic components

The `smartquotes` and `replacements` components are intended to improve typography:

`smartquotes` will convert basic quote marks to their opening and closing variants:

- 'single quotes' -> ‘single quotes’
- "double quotes" -> “double quotes”

`replacements` will replace particular text constructs:

- ``(c)``, ``(C)`` → ©
- ``(tm)``, ``(TM)`` → ™
- ``(r)``, ``(R)`` → ®
- ``(p)``, ``(P)`` → §
- ``+-`` → ±
- ``...`` → …
- ``?....`` → ?..
- ``!....`` → !..
- ``????????`` → ???
- ``!!!!!`` → !!!
- ``,,,`` → ,
- ``--`` → &ndash
- ``---`` → &mdash

Both of these components require typography to be turned on, as well as the components enabled:

```{jupyter-execute}
md = MarkdownIt("commonmark", {"typographer": True})
md.enable(["replacements", "smartquotes"])
md.render("'single quotes' (c)")
```

### Linkify

The `linkify` component requires that [linkify-it-py](https://github.com/tsutsu3/linkify-it-py) be installed (e.g. *via* `pip install markdown-it-py[linkify]`).
This allows URI autolinks to be identified, without the need for enclosing in `<>` brackets:

```{jupyter-execute}
md = MarkdownIt("commonmark", {"linkify": True})
md.enable(["linkify"])
md.render("github.com")
```

### Plugins load

Plugins load collections of additional syntax rules and render methods into the parser.
A number of useful plugins are available in [`mdit_py_plugins`](https://github.com/executablebooks/mdit-py-plugins) (see [the plugin list](./plugins.md)),
or you can create your own (following the [markdown-it design principles](./architecture.md)).

```{jupyter-execute}
from markdown_it import MarkdownIt
import mdit_py_plugins
from mdit_py_plugins.front_matter import front_matter_plugin
from mdit_py_plugins.footnote import footnote_plugin

md = (
    MarkdownIt()
    .use(front_matter_plugin)
    .use(footnote_plugin)
    .enable('table')
)
text = ("""\
---
a: 1
---

a | b
- | -
1 | 2

A footnote [^1]

[^1]: some details
""")
print(md.render(text))
```

## The Token Stream

+++

Before rendering, the text is parsed to a flat token stream of block level syntax elements, with nesting defined by opening (1) and closing (-1) attributes:

```{jupyter-execute}
md = MarkdownIt("commonmark")
tokens = md.parse("""
Here's some *text*

1. a list

> a *quote*""")
[(t.type, t.nesting) for t in tokens]
```

Naturally all openings should eventually be closed,
such that:

```{jupyter-execute}
sum([t.nesting for t in tokens]) == 0
```

All tokens are the same class, which can also be created outside the parser:

```{jupyter-execute}
tokens[0]
```

```{jupyter-execute}
from markdown_it.token import Token
token = Token("paragraph_open", "p", 1, block=True, map=[1, 2])
token == tokens[0]
```

The `'inline'` type token contain the inline tokens as children:

```{jupyter-execute}
tokens[1]
```

You can serialize a token (and its children) to a JSONable dictionary using:

```{jupyter-execute}
print(tokens[1].as_dict())
```

This dictionary can also be deserialized:

```{jupyter-execute}
Token.from_dict(tokens[1].as_dict())
```

### Creating a syntax tree

```{versionchanged} 0.7.0
`nest_tokens` and `NestedTokens` are deprecated and replaced by `SyntaxTreeNode`.
```

In some use cases it may be useful to convert the token stream into a syntax tree,
with opening/closing tokens collapsed into a single token that contains children.

```{jupyter-execute}
from markdown_it.tree import SyntaxTreeNode

md = MarkdownIt("commonmark")
tokens = md.parse("""
# Header

Here's some text and an image ![title](image.png)

1. a **list**

> a *quote*
""")

node = SyntaxTreeNode(tokens)
print(node.pretty(indent=2, show_text=True))
```

You can then use methods to traverse the tree

```{jupyter-execute}
node.children
```

```{jupyter-execute}
print(node[0])
node[0].next_sibling
```

## Renderers

+++

After the token stream is generated, it's passed to a [renderer](https://github.com/executablebooks/markdown-it-py/tree/master/markdown_it/renderer.py).
It then plays all the tokens, passing each to a rule with the same name as token type.

Renderer rules are located in `md.renderer.rules` and are simple functions
with the same signature:

```python
def function(renderer, tokens, idx, options, env):
  return htmlResult
```

+++

You can inject render methods into the instantiated render class.

```{jupyter-execute}
md = MarkdownIt("commonmark")

def render_em_open(self, tokens, idx, options, env):
    return ''

md.add_render_rule("em_open", render_em_open)
md.render("*a*")
```

This is a slight change to the JS version, where the renderer argument is at the end.
Also `add_render_rule` method is specific to Python, rather than adding directly to the `md.renderer.rules`, this ensures the method is bound to the renderer.

+++

You can also subclass a render and add the method there:

```{jupyter-execute}
from markdown_it.renderer import RendererHTML

class MyRenderer(RendererHTML):
    def em_open(self, tokens, idx, options, env):
        return ''

md = MarkdownIt("commonmark", renderer_cls=MyRenderer)
md.render("*a*")
```

Plugins can support multiple render types, using the `__output__` attribute (this is currently a Python only feature).

```{jupyter-execute}
from markdown_it.renderer import RendererHTML

class MyRenderer1(RendererHTML):
    __output__ = "html1"

class MyRenderer2(RendererHTML):
    __output__ = "html2"

def plugin(md):
    def render_em_open1(self, tokens, idx, options, env):
        return ''
    def render_em_open2(self, tokens, idx, options, env):
        return ''
    md.add_render_rule("em_open", render_em_open1, fmt="html1")
    md.add_render_rule("em_open", render_em_open2, fmt="html2")

md = MarkdownIt("commonmark", renderer_cls=MyRenderer1).use(plugin)
print(md.render("*a*"))

md = MarkdownIt("commonmark", renderer_cls=MyRenderer2).use(plugin)
print(md.render("*a*"))
```

Here's a more concrete example; let's replace images with vimeo links to player's iframe:

```{jupyter-execute}
import re
from markdown_it import MarkdownIt

vimeoRE = re.compile(r'^https?:\/\/(www\.)?vimeo.com\/(\d+)($|\/)')

def render_vimeo(self, tokens, idx, options, env):
    token = tokens[idx]

    if vimeoRE.match(token.attrs["src"]):

        ident = vimeoRE.match(token.attrs["src"])[2]

        return ('
\n' +
               '  \n' +
               '
\n')
    return self.image(tokens, idx, options, env)

md = MarkdownIt("commonmark")
md.add_render_rule("image", render_vimeo)
print(md.render("![](https://www.vimeo.com/123)"))
```

Here is another example, how to add `target="_blank"` to all links:

```{jupyter-execute}
from markdown_it import MarkdownIt

def render_blank_link(self, tokens, idx, options, env):
    tokens[idx].attrSet("target", "_blank")

    # pass token to default renderer.
    return self.renderToken(tokens, idx, options, env)

md = MarkdownIt("commonmark")
md.add_render_rule("link_open", render_blank_link)
print(md.render("[a]\n\n[a]: b"))
```

### Markdown renderer

You can also render a token stream directly to markdown via the `MDRenderer` class from [`mdformat`](https://github.com/executablebooks/mdformat):

```python
from markdown_it import MarkdownIt
from mdformat.renderer import MDRenderer

md = MarkdownIt("commonmark")

source_markdown = """
Here's some *text*

1. a list

> a *quote*"""

tokens = md.parse(source_markdown)

renderer = MDRenderer()
options = {}
env = {}

output_markdown = renderer.render(tokens, options, env)
```
markdown-it-py-4.2.0/markdown_it/000077500000000000000000000000001517710005200167135ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/__init__.py000066400000000000000000000001621517710005200210230ustar00rootroot00000000000000"""A Python port of Markdown-It"""

__all__ = ("MarkdownIt",)
__version__ = "4.2.0"

from .main import MarkdownIt
markdown-it-py-4.2.0/markdown_it/_compat.py000066400000000000000000000000431517710005200207040ustar00rootroot00000000000000from __future__ import annotations
markdown-it-py-4.2.0/markdown_it/_punycode.py000066400000000000000000000045051517710005200212560ustar00rootroot00000000000000# Copyright 2014 Mathias Bynens 
# Copyright 2021 Taneli Hukkinen
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

import codecs
from collections.abc import Callable
import re

REGEX_SEPARATORS = re.compile(r"[\x2E\u3002\uFF0E\uFF61]")
REGEX_NON_ASCII = re.compile(r"[^\0-\x7E]")


def encode(uni: str) -> str:
    return codecs.encode(uni, encoding="punycode").decode()


def decode(ascii: str) -> str:
    return codecs.decode(ascii, encoding="punycode")  # type: ignore


def map_domain(string: str, fn: Callable[[str], str]) -> str:
    parts = string.split("@")
    result = ""
    if len(parts) > 1:
        # In email addresses, only the domain name should be punycoded. Leave
        # the local part (i.e. everything up to `@`) intact.
        result = parts[0] + "@"
        string = parts[1]
    labels = REGEX_SEPARATORS.split(string)
    encoded = ".".join(fn(label) for label in labels)
    return result + encoded


def to_unicode(obj: str) -> str:
    def mapping(obj: str) -> str:
        if obj.startswith("xn--"):
            return decode(obj[4:].lower())
        return obj

    return map_domain(obj, mapping)


def to_ascii(obj: str) -> str:
    def mapping(obj: str) -> str:
        if REGEX_NON_ASCII.search(obj):
            return "xn--" + encode(obj)
        return obj

    return map_domain(obj, mapping)
markdown-it-py-4.2.0/markdown_it/cli/000077500000000000000000000000001517710005200174625ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/cli/__init__.py000066400000000000000000000000001517710005200215610ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/cli/parse.py000066400000000000000000000064421517710005200211540ustar00rootroot00000000000000#!/usr/bin/env python
"""
CLI interface to markdown-it-py

Parse one or more markdown files, convert each to HTML, and print to stdout.
"""

from __future__ import annotations

import argparse
from collections.abc import Iterable, Sequence
import sys

from markdown_it import __version__
from markdown_it.main import MarkdownIt

version_str = f"markdown-it-py [version {__version__}]"


def main(args: Sequence[str] | None = None) -> int:
    namespace = parse_args(args)
    if namespace.filenames:
        convert(namespace.filenames)
    elif namespace.stdin:
        convert_stdin()
    else:
        interactive()
    return 0


def convert(filenames: Iterable[str]) -> None:
    for filename in filenames:
        convert_file(filename)


def convert_stdin() -> None:
    """
    Parse a Markdown file and dump the output to stdout.
    """
    try:
        rendered = MarkdownIt().render(sys.stdin.read())
        print(rendered, end="")
    except OSError:
        sys.stderr.write("Cannot parse Markdown from the standard input.\n")
        sys.exit(1)


def convert_file(filename: str) -> None:
    """
    Parse a Markdown file and dump the output to stdout.
    """
    try:
        with open(filename, encoding="utf8", errors="ignore") as fin:
            rendered = MarkdownIt().render(fin.read())
            print(rendered, end="")
    except OSError:
        sys.stderr.write(f'Cannot open file "{filename}".\n')
        sys.exit(1)


def interactive() -> None:
    """
    Parse user input, dump to stdout, rinse and repeat.
    Python REPL style.
    """
    print_heading()
    contents = []
    more = False
    while True:
        try:
            prompt, more = ("... ", True) if more else (">>> ", True)
            contents.append(input(prompt) + "\n")
        except EOFError:
            print("\n" + MarkdownIt().render("\n".join(contents)), end="")
            more = False
            contents = []
        except KeyboardInterrupt:
            print("\nExiting.")
            break


def parse_args(args: Sequence[str] | None) -> argparse.Namespace:
    """Parse input CLI arguments."""
    parser = argparse.ArgumentParser(
        description="Parse one or more markdown files, "
        "convert each to HTML, and print to stdout",
        # NOTE: Remember to update README.md w/ the output of `markdown-it -h`
        epilog=(
            f"""
Interactive:

  $ markdown-it
  markdown-it-py [version {__version__}] (interactive)
  Type Ctrl-D to complete input, or Ctrl-C to exit.
  >>> # Example
  ... > markdown *input*
  ...
  
Example

  

  
markdown input

  


Batch:

  $ markdown-it README.md README.footer.md > index.html
"""
        ),
        formatter_class=argparse.RawDescriptionHelpFormatter,
    )
    parser.add_argument("-v", "--version", action="version", version=version_str)
    parser.add_argument(
        "--stdin", action="store_true", help="read Markdown from standard input"
    )
    parser.add_argument(
        "filenames", nargs="*", help="specify an optional list of files to convert"
    )
    return parser.parse_args(args)


def print_heading() -> None:
    print(f"{version_str} (interactive)")
    print("Type Ctrl-D to complete input, or Ctrl-C to exit.")


if __name__ == "__main__":
    exit_code = main(sys.argv[1:])
    sys.exit(exit_code)
markdown-it-py-4.2.0/markdown_it/common/000077500000000000000000000000001517710005200202035ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/common/__init__.py000066400000000000000000000000001517710005200223020ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/common/entities.py000066400000000000000000000002351517710005200224010ustar00rootroot00000000000000"""HTML5 entities map: { name -> characters }."""

import html.entities

entities = {name.rstrip(";"): chars for name, chars in html.entities.html5.items()}
markdown-it-py-4.2.0/markdown_it/common/html_blocks.py000066400000000000000000000017321517710005200230610ustar00rootroot00000000000000"""List of valid html blocks names, according to commonmark spec
http://jgm.github.io/CommonMark/spec.html#html-blocks
"""

# see https://spec.commonmark.org/0.31.2/#html-blocks
block_names = [
    "address",
    "article",
    "aside",
    "base",
    "basefont",
    "blockquote",
    "body",
    "caption",
    "center",
    "col",
    "colgroup",
    "dd",
    "details",
    "dialog",
    "dir",
    "div",
    "dl",
    "dt",
    "fieldset",
    "figcaption",
    "figure",
    "footer",
    "form",
    "frame",
    "frameset",
    "h1",
    "h2",
    "h3",
    "h4",
    "h5",
    "h6",
    "head",
    "header",
    "hr",
    "html",
    "iframe",
    "legend",
    "li",
    "link",
    "main",
    "menu",
    "menuitem",
    "nav",
    "noframes",
    "ol",
    "optgroup",
    "option",
    "p",
    "param",
    "search",
    "section",
    "summary",
    "table",
    "tbody",
    "td",
    "tfoot",
    "th",
    "thead",
    "title",
    "tr",
    "track",
    "ul",
]
markdown-it-py-4.2.0/markdown_it/common/html_re.py000066400000000000000000000016361517710005200222150ustar00rootroot00000000000000"""Regexps to match html elements"""

import re

attr_name = "[a-zA-Z_:][a-zA-Z0-9:._-]*"

unquoted = "[^\"'=<>`\\x00-\\x20]+"
single_quoted = "'[^']*'"
double_quoted = '"[^"]*"'

attr_value = "(?:" + unquoted + "|" + single_quoted + "|" + double_quoted + ")"

attribute = "(?:\\s+" + attr_name + "(?:\\s*=\\s*" + attr_value + ")?)"

open_tag = "<[A-Za-z][A-Za-z0-9\\-]*" + attribute + "*\\s*\\/?>"

close_tag = "<\\/[A-Za-z][A-Za-z0-9\\-]*\\s*>"
comment = ""
processing = "<[?][\\s\\S]*?[?]>"
declaration = "]*>"
cdata = ""

HTML_TAG_RE = re.compile(
    "^(?:"
    + open_tag
    + "|"
    + close_tag
    + "|"
    + comment
    + "|"
    + processing
    + "|"
    + declaration
    + "|"
    + cdata
    + ")"
)
HTML_OPEN_CLOSE_TAG_STR = "^(?:" + open_tag + "|" + close_tag + ")"
HTML_OPEN_CLOSE_TAG_RE = re.compile(HTML_OPEN_CLOSE_TAG_STR)
markdown-it-py-4.2.0/markdown_it/common/normalize_url.py000066400000000000000000000050101517710005200234330ustar00rootroot00000000000000from __future__ import annotations

from collections.abc import Callable
from contextlib import suppress
import re
from urllib.parse import quote, unquote, urlparse, urlunparse  # noqa: F401

import mdurl

from .. import _punycode

RECODE_HOSTNAME_FOR = ("http:", "https:", "mailto:")


def normalizeLink(url: str) -> str:
    """Normalize destination URLs in links

    ::

        [label]:   destination   'title'
                ^^^^^^^^^^^
    """
    parsed = mdurl.parse(url, slashes_denote_host=True)

    # Encode hostnames in urls like:
    # `http://host/`, `https://host/`, `mailto:user@host`, `//host/`
    #
    # We don't encode unknown schemas, because it's likely that we encode
    # something we shouldn't (e.g. `skype:name` treated as `skype:host`)
    #
    if parsed.hostname and (
        not parsed.protocol or parsed.protocol in RECODE_HOSTNAME_FOR
    ):
        with suppress(Exception):
            parsed = parsed._replace(hostname=_punycode.to_ascii(parsed.hostname))

    return mdurl.encode(mdurl.format(parsed))


def normalizeLinkText(url: str) -> str:
    """Normalize autolink content

    ::

        
         ~~~~~~~~~~~
    """
    parsed = mdurl.parse(url, slashes_denote_host=True)

    # Encode hostnames in urls like:
    # `http://host/`, `https://host/`, `mailto:user@host`, `//host/`
    #
    # We don't encode unknown schemas, because it's likely that we encode
    # something we shouldn't (e.g. `skype:name` treated as `skype:host`)
    #
    if parsed.hostname and (
        not parsed.protocol or parsed.protocol in RECODE_HOSTNAME_FOR
    ):
        with suppress(Exception):
            parsed = parsed._replace(hostname=_punycode.to_unicode(parsed.hostname))

    # add '%' to exclude list because of https://github.com/markdown-it/markdown-it/issues/720
    return mdurl.decode(mdurl.format(parsed), mdurl.DECODE_DEFAULT_CHARS + "%")


BAD_PROTO_RE = re.compile(r"^(vbscript|javascript|file|data):")
GOOD_DATA_RE = re.compile(r"^data:image\/(gif|png|jpeg|webp);")


def validateLink(url: str, validator: Callable[[str], bool] | None = None) -> bool:
    """Validate URL link is allowed in output.

    This validator can prohibit more than really needed to prevent XSS.
    It's a tradeoff to keep code simple and to be secure by default.

    Note: url should be normalized at this point, and existing entities decoded.
    """
    if validator is not None:
        return validator(url)
    url = url.strip().lower()
    return bool(GOOD_DATA_RE.search(url)) if BAD_PROTO_RE.search(url) else True
markdown-it-py-4.2.0/markdown_it/common/utils.py000066400000000000000000000210361517710005200217170ustar00rootroot00000000000000"""Utilities for parsing source text"""

from __future__ import annotations

import re
from re import Match
from typing import TypeVar
import unicodedata

from .entities import entities


def charCodeAt(src: str, pos: int) -> int | None:
    """
    Returns the Unicode value of the character at the specified location.

    @param - index The zero-based index of the desired character.
    If there is no character at the specified index, NaN is returned.

    This was added for compatibility with python
    """
    try:
        return ord(src[pos])
    except IndexError:
        return None


def charStrAt(src: str, pos: int) -> str | None:
    """
    Returns the Unicode value of the character at the specified location.

    @param - index The zero-based index of the desired character.
    If there is no character at the specified index, NaN is returned.

    This was added for compatibility with python
    """
    try:
        return src[pos]
    except IndexError:
        return None


_ItemTV = TypeVar("_ItemTV")


def arrayReplaceAt(
    src: list[_ItemTV], pos: int, newElements: list[_ItemTV]
) -> list[_ItemTV]:
    """
    Remove element from array and put another array at those position.
    Useful for some operations with tokens
    """
    return src[:pos] + newElements + src[pos + 1 :]


def isValidEntityCode(c: int) -> bool:
    # broken sequence
    if c >= 0xD800 and c <= 0xDFFF:
        return False
    # never used
    if c >= 0xFDD0 and c <= 0xFDEF:
        return False
    if ((c & 0xFFFF) == 0xFFFF) or ((c & 0xFFFF) == 0xFFFE):
        return False
    # control codes
    if c >= 0x00 and c <= 0x08:
        return False
    if c == 0x0B:
        return False
    if c >= 0x0E and c <= 0x1F:
        return False
    if c >= 0x7F and c <= 0x9F:
        return False
    # out of range
    return not (c > 0x10FFFF)


def fromCodePoint(c: int) -> str:
    """Convert ordinal to unicode.

    Note, in the original Javascript two string characters were required,
    for codepoints larger than `0xFFFF`.
    But Python 3 can represent any unicode codepoint in one character.
    """
    return chr(c)


# UNESCAPE_MD_RE = re.compile(r'\\([!"#$%&\'()*+,\-.\/:;<=>?@[\\\]^_`{|}~])')
# ENTITY_RE_g       = re.compile(r'&([a-z#][a-z0-9]{1,31})', re.IGNORECASE)
UNESCAPE_ALL_RE = re.compile(
    r'\\([!"#$%&\'()*+,\-.\/:;<=>?@[\\\]^_`{|}~])' + "|" + r"&([a-z#][a-z0-9]{1,31});",
    re.IGNORECASE,
)
DIGITAL_ENTITY_BASE10_RE = re.compile(r"#([0-9]{1,8})")
DIGITAL_ENTITY_BASE16_RE = re.compile(r"#x([a-f0-9]{1,8})", re.IGNORECASE)


def replaceEntityPattern(match: str, name: str) -> str:
    """Convert HTML entity patterns,
    see https://spec.commonmark.org/0.30/#entity-references
    """
    if name in entities:
        return entities[name]

    code: None | int = None
    if pat := DIGITAL_ENTITY_BASE10_RE.fullmatch(name):
        code = int(pat.group(1), 10)
    elif pat := DIGITAL_ENTITY_BASE16_RE.fullmatch(name):
        code = int(pat.group(1), 16)

    if code is not None and isValidEntityCode(code):
        return fromCodePoint(code)

    return match


def unescapeAll(string: str) -> str:
    def replacer_func(match: Match[str]) -> str:
        escaped = match.group(1)
        if escaped:
            return escaped
        entity = match.group(2)
        return replaceEntityPattern(match.group(), entity)

    if "\\" not in string and "&" not in string:
        return string
    return UNESCAPE_ALL_RE.sub(replacer_func, string)


ESCAPABLE = r"""\\!"#$%&'()*+,./:;<=>?@\[\]^`{}|_~-"""
ESCAPE_CHAR = re.compile(r"\\([" + ESCAPABLE + r"])")


def stripEscape(string: str) -> str:
    """Strip escape \\ characters"""
    return ESCAPE_CHAR.sub(r"\1", string)


def escapeHtml(raw: str) -> str:
    """Replace special characters "&", "<", ">" and '"' to HTML-safe sequences."""
    # like html.escape, but without escaping single quotes
    raw = raw.replace("&", "&")  # Must be done first!
    raw = raw.replace("<", "<")
    raw = raw.replace(">", ">")
    raw = raw.replace('"', """)
    return raw


# //////////////////////////////////////////////////////////////////////////////

REGEXP_ESCAPE_RE = re.compile(r"[.?*+^$[\]\\(){}|-]")


def escapeRE(string: str) -> str:
    string = REGEXP_ESCAPE_RE.sub("\\$&", string)
    return string


# //////////////////////////////////////////////////////////////////////////////


def isSpace(code: int | None) -> bool:
    """Check if character code is a whitespace."""
    return code in (0x09, 0x20)


def isStrSpace(ch: str | None) -> bool:
    """Check if character is a whitespace."""
    return ch in ("\t", " ")


MD_WHITESPACE = {
    0x09,  # \t
    0x0A,  # \n
    0x0B,  # \v
    0x0C,  # \f
    0x0D,  # \r
    0x20,  # space
    0xA0,
    0x1680,
    0x202F,
    0x205F,
    0x3000,
}


def isWhiteSpace(code: int) -> bool:
    r"""Zs (unicode class) || [\t\f\v\r\n]"""
    if code >= 0x2000 and code <= 0x200A:
        return True
    return code in MD_WHITESPACE


# //////////////////////////////////////////////////////////////////////////////


def isPunctChar(ch: str) -> bool:
    """Check if character is a punctuation character."""
    return unicodedata.category(ch).startswith(("P", "S"))


MD_ASCII_PUNCT = {
    0x21,  # /* ! */
    0x22,  # /* " */
    0x23,  # /* # */
    0x24,  # /* $ */
    0x25,  # /* % */
    0x26,  # /* & */
    0x27,  # /* ' */
    0x28,  # /* ( */
    0x29,  # /* ) */
    0x2A,  # /* * */
    0x2B,  # /* + */
    0x2C,  # /* , */
    0x2D,  # /* - */
    0x2E,  # /* . */
    0x2F,  # /* / */
    0x3A,  # /* : */
    0x3B,  # /* ; */
    0x3C,  # /* < */
    0x3D,  # /* = */
    0x3E,  # /* > */
    0x3F,  # /* ? */
    0x40,  # /* @ */
    0x5B,  # /* [ */
    0x5C,  # /* \ */
    0x5D,  # /* ] */
    0x5E,  # /* ^ */
    0x5F,  # /* _ */
    0x60,  # /* ` */
    0x7B,  # /* { */
    0x7C,  # /* | */
    0x7D,  # /* } */
    0x7E,  # /* ~ */
}


def isMdAsciiPunct(ch: int) -> bool:
    """Markdown ASCII punctuation characters.

    ::

        !, ", #, $, %, &, ', (, ), *, +, ,, -, ., /, :, ;, <, =, >, ?, @, [, \\, ], ^, _, `, {, |, }, or ~

    See http://spec.commonmark.org/0.15/#ascii-punctuation-character

    Don't confuse with unicode punctuation !!! It lacks some chars in ascii range.

    """
    return ch in MD_ASCII_PUNCT


def normalizeReference(string: str) -> str:
    """Helper to unify [reference labels]."""
    # Trim and collapse whitespace
    #
    string = re.sub(r"\s+", " ", string.strip())

    # In node v10 'ẞ'.toLowerCase() === 'Ṿ', which is presumed to be a bug
    # fixed in v12 (couldn't find any details).
    #
    # So treat this one as a special case
    # (remove this when node v10 is no longer supported).
    #
    # if ('ẞ'.toLowerCase() === 'Ṿ') {
    #   str = str.replace(/ẞ/g, 'ß')
    # }

    # .toLowerCase().toUpperCase() should get rid of all differences
    # between letter variants.
    #
    # Simple .toLowerCase() doesn't normalize 125 code points correctly,
    # and .toUpperCase doesn't normalize 6 of them (list of exceptions:
    # İ, ϴ, ẞ, Ω, K, Å - those are already uppercased, but have differently
    # uppercased versions).
    #
    # Here's an example showing how it happens. Lets take greek letter omega:
    # uppercase U+0398 (Θ), U+03f4 (ϴ) and lowercase U+03b8 (θ), U+03d1 (ϑ)
    #
    # Unicode entries:
    # 0398;GREEK CAPITAL LETTER THETA;Lu;0;L;;;;;N;;;;03B8
    # 03B8;GREEK SMALL LETTER THETA;Ll;0;L;;;;;N;;;0398;;0398
    # 03D1;GREEK THETA SYMBOL;Ll;0;L; 03B8;;;;N;GREEK SMALL LETTER SCRIPT THETA;;0398;;0398
    # 03F4;GREEK CAPITAL THETA SYMBOL;Lu;0;L; 0398;;;;N;;;;03B8
    #
    # Case-insensitive comparison should treat all of them as equivalent.
    #
    # But .toLowerCase() doesn't change ϑ (it's already lowercase),
    # and .toUpperCase() doesn't change ϴ (already uppercase).
    #
    # Applying first lower then upper case normalizes any character:
    # '\u0398\u03f4\u03b8\u03d1'.toLowerCase().toUpperCase() === '\u0398\u0398\u0398\u0398'
    #
    # Note: this is equivalent to unicode case folding; unicode normalization
    # is a different step that is not required here.
    #
    # Final result should be uppercased, because it's later stored in an object
    # (this avoid a conflict with Object.prototype members,
    # most notably, `__proto__`)
    #
    return string.lower().upper()


LINK_OPEN_RE = re.compile(r"^\s]", flags=re.IGNORECASE)
LINK_CLOSE_RE = re.compile(r"^", flags=re.IGNORECASE)


def isLinkOpen(string: str) -> bool:
    return bool(LINK_OPEN_RE.search(string))


def isLinkClose(string: str) -> bool:
    return bool(LINK_CLOSE_RE.search(string))
markdown-it-py-4.2.0/markdown_it/helpers/000077500000000000000000000000001517710005200203555ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/helpers/__init__.py000066400000000000000000000003751517710005200224730ustar00rootroot00000000000000"""Functions for parsing Links"""

__all__ = ("parseLinkDestination", "parseLinkLabel", "parseLinkTitle")
from .parse_link_destination import parseLinkDestination
from .parse_link_label import parseLinkLabel
from .parse_link_title import parseLinkTitle
markdown-it-py-4.2.0/markdown_it/helpers/parse_link_destination.py000066400000000000000000000035621517710005200254650ustar00rootroot00000000000000"""
Parse link destination
"""

from ..common.utils import charCodeAt, unescapeAll


class _Result:
    __slots__ = ("ok", "pos", "str")

    def __init__(self) -> None:
        self.ok = False
        self.pos = 0
        self.str = ""


def parseLinkDestination(string: str, pos: int, maximum: int) -> _Result:
    start = pos
    result = _Result()

    if charCodeAt(string, pos) == 0x3C:  # /* < */
        pos += 1
        while pos < maximum:
            code = charCodeAt(string, pos)
            if code == 0x0A:  # /* \n */)
                return result
            if code == 0x3C:  # / * < * /
                return result
            if code == 0x3E:  # /* > */) {
                result.pos = pos + 1
                result.str = unescapeAll(string[start + 1 : pos])
                result.ok = True
                return result

            if code == 0x5C and pos + 1 < maximum:  # \
                pos += 2
                continue

            pos += 1

        # no closing '>'
        return result

    # this should be ... } else { ... branch

    level = 0
    while pos < maximum:
        code = charCodeAt(string, pos)

        if code is None or code == 0x20:
            break

        # ascii control characters
        if code < 0x20 or code == 0x7F:
            break

        if code == 0x5C and pos + 1 < maximum:
            if charCodeAt(string, pos + 1) == 0x20:
                break
            pos += 2
            continue

        if code == 0x28:  # /* ( */)
            level += 1
            if level > 32:
                return result

        if code == 0x29:  # /* ) */)
            if level == 0:
                break
            level -= 1

        pos += 1

    if start == pos:
        return result
    if level != 0:
        return result

    result.str = unescapeAll(string[start:pos])
    result.pos = pos
    result.ok = True
    return result
markdown-it-py-4.2.0/markdown_it/helpers/parse_link_label.py000066400000000000000000000020151517710005200242130ustar00rootroot00000000000000"""
Parse link label

this function assumes that first character ("[") already matches
returns the end of the label

"""

from markdown_it.rules_inline import StateInline


def parseLinkLabel(state: StateInline, start: int, disableNested: bool = False) -> int:
    labelEnd = -1
    oldPos = state.pos
    found = False

    state.pos = start + 1
    level = 1

    while state.pos < state.posMax:
        marker = state.src[state.pos]
        if marker == "]":
            level -= 1
            if level == 0:
                found = True
                break

        prevPos = state.pos
        state.md.inline.skipToken(state)
        if marker == "[":
            if prevPos == state.pos - 1:
                # increase level if we find text `[`,
                # which is not a part of any token
                level += 1
            elif disableNested:
                state.pos = oldPos
                return -1
    if found:
        labelEnd = state.pos

    # restore old state
    state.pos = oldPos

    return labelEnd
markdown-it-py-4.2.0/markdown_it/helpers/parse_link_title.py000066400000000000000000000043411517710005200242610ustar00rootroot00000000000000"""Parse link title"""

from ..common.utils import charCodeAt, unescapeAll


class _State:
    __slots__ = ("can_continue", "marker", "ok", "pos", "str")

    def __init__(self) -> None:
        self.ok = False
        """if `true`, this is a valid link title"""
        self.can_continue = False
        """if `true`, this link can be continued on the next line"""
        self.pos = 0
        """if `ok`, it's the position of the first character after the closing marker"""
        self.str = ""
        """if `ok`, it's the unescaped title"""
        self.marker = 0
        """expected closing marker character code"""

    def __str__(self) -> str:
        return self.str


def parseLinkTitle(
    string: str, start: int, maximum: int, prev_state: _State | None = None
) -> _State:
    """Parse link title within `str` in [start, max] range,
    or continue previous parsing if `prev_state` is defined (equal to result of last execution).
    """
    pos = start
    state = _State()

    if prev_state is not None:
        # this is a continuation of a previous parseLinkTitle call on the next line,
        # used in reference links only
        state.str = prev_state.str
        state.marker = prev_state.marker
    else:
        if pos >= maximum:
            return state

        marker = charCodeAt(string, pos)

        # /* " */  /* ' */  /* ( */
        if marker != 0x22 and marker != 0x27 and marker != 0x28:
            return state

        start += 1
        pos += 1

        # if opening marker is "(", switch it to closing marker ")"
        if marker == 0x28:
            marker = 0x29

        state.marker = marker

    while pos < maximum:
        code = charCodeAt(string, pos)
        if code == state.marker:
            state.pos = pos + 1
            state.str += unescapeAll(string[start:pos])
            state.ok = True
            return state
        elif code == 0x28 and state.marker == 0x29:  # /* ( */  /* ) */
            return state
        elif code == 0x5C and pos + 1 < maximum:  # /* \ */
            pos += 1

        pos += 1

    # no closing marker found, but this link title may continue on the next line (for references)
    state.can_continue = True
    state.str += unescapeAll(string[start:pos])
    return state
markdown-it-py-4.2.0/markdown_it/main.py000066400000000000000000000307271517710005200202220ustar00rootroot00000000000000from __future__ import annotations

from collections.abc import Callable, Generator, Iterable, Mapping, MutableMapping
from contextlib import contextmanager
from typing import Any, Literal, overload

from . import helpers, presets
from .common import normalize_url, utils
from .parser_block import ParserBlock
from .parser_core import ParserCore
from .parser_inline import ParserInline
from .renderer import RendererHTML, RendererProtocol
from .rules_core.state_core import StateCore
from .token import Token
from .utils import EnvType, OptionsDict, OptionsType, PresetType

try:
    import linkify_it
except ModuleNotFoundError:
    linkify_it = None


_PRESETS: dict[str, PresetType] = {
    "default": presets.default.make(),
    "js-default": presets.js_default.make(),
    "zero": presets.zero.make(),
    "commonmark": presets.commonmark.make(),
    "gfm-like": presets.gfm_like.make(),
    "gfm-like2": presets.gfm_like2.make(),
}


class MarkdownIt:
    def __init__(
        self,
        config: str | PresetType = "commonmark",
        options_update: Mapping[str, Any] | None = None,
        *,
        renderer_cls: Callable[[MarkdownIt], RendererProtocol] = RendererHTML,
    ):
        """Main parser class

        :param config: name of configuration to load or a pre-defined dictionary
        :param options_update: dictionary that will be merged into ``config["options"]``
        :param renderer_cls: the class to load as the renderer:
            ``self.renderer = renderer_cls(self)
        """
        # add modules
        self.utils = utils
        self.helpers = helpers

        # initialise classes
        self.inline = ParserInline()
        self.block = ParserBlock()
        self.core = ParserCore()
        self.renderer = renderer_cls(self)
        self.linkify = linkify_it.LinkifyIt() if linkify_it else None

        # set the configuration
        if options_update and not isinstance(options_update, Mapping):
            # catch signature change where renderer_cls was not used as a key-word
            raise TypeError(
                f"options_update should be a mapping: {options_update}"
                "\n(Perhaps you intended this to be the renderer_cls?)"
            )
        self.configure(config, options_update=options_update)

    def __repr__(self) -> str:
        return f"{self.__class__.__module__}.{self.__class__.__name__}()"

    @overload
    def __getitem__(self, name: Literal["inline"]) -> ParserInline: ...

    @overload
    def __getitem__(self, name: Literal["block"]) -> ParserBlock: ...

    @overload
    def __getitem__(self, name: Literal["core"]) -> ParserCore: ...

    @overload
    def __getitem__(self, name: Literal["renderer"]) -> RendererProtocol: ...

    @overload
    def __getitem__(self, name: str) -> Any: ...

    def __getitem__(self, name: str) -> Any:
        return {
            "inline": self.inline,
            "block": self.block,
            "core": self.core,
            "renderer": self.renderer,
        }[name]

    def set(self, options: OptionsType) -> None:
        """Set parser options (in the same format as in constructor).
        Probably, you will never need it, but you can change options after constructor call.

        __Note:__ To achieve the best possible performance, don't modify a
        `markdown-it` instance options on the fly. If you need multiple configurations
        it's best to create multiple instances and initialize each with separate config.
        """
        self.options = OptionsDict(options)

    def configure(
        self, presets: str | PresetType, options_update: Mapping[str, Any] | None = None
    ) -> MarkdownIt:
        """Batch load of all options and component settings.
        This is an internal method, and you probably will not need it.
        But if you will - see available presets and data structure
        [here](https://github.com/markdown-it/markdown-it/tree/master/lib/presets)

        We strongly recommend to use presets instead of direct config loads.
        That will give better compatibility with next versions.
        """
        if isinstance(presets, str):
            if presets not in _PRESETS:
                raise KeyError(f"Wrong `markdown-it` preset '{presets}', check name")
            config = _PRESETS[presets]
        else:
            config = presets

        if not config:
            raise ValueError("Wrong `markdown-it` config, can't be empty")

        options = config.get("options", {}) or {}
        if options_update:
            options = {**options, **options_update}  # type: ignore

        self.set(options)

        if "components" in config:
            for name, component in config["components"].items():
                rules = component.get("rules", None)
                if rules:
                    self[name].ruler.enableOnly(rules)
                rules2 = component.get("rules2", None)
                if rules2:
                    self[name].ruler2.enableOnly(rules2)

        return self

    def get_all_rules(self) -> dict[str, list[str]]:
        """Return the names of all active rules."""
        rules = {
            chain: self[chain].ruler.get_all_rules()
            for chain in ["core", "block", "inline"]
        }
        rules["inline2"] = self.inline.ruler2.get_all_rules()
        return rules

    def get_active_rules(self) -> dict[str, list[str]]:
        """Return the names of all active rules."""
        rules = {
            chain: self[chain].ruler.get_active_rules()
            for chain in ["core", "block", "inline"]
        }
        rules["inline2"] = self.inline.ruler2.get_active_rules()
        return rules

    def enable(
        self, names: str | Iterable[str], ignoreInvalid: bool = False
    ) -> MarkdownIt:
        """Enable list or rules. (chainable)

        :param names: rule name or list of rule names to enable.
        :param ignoreInvalid: set `true` to ignore errors when rule not found.

        It will automatically find appropriate components,
        containing rules with given names. If rule not found, and `ignoreInvalid`
        not set - throws exception.

        Example::

            md = MarkdownIt().enable(['sub', 'sup']).disable('smartquotes')

        """
        result = []

        if isinstance(names, str):
            names = [names]

        for chain in ["core", "block", "inline"]:
            result.extend(self[chain].ruler.enable(names, True))
        result.extend(self.inline.ruler2.enable(names, True))

        missed = [name for name in names if name not in result]
        if missed and not ignoreInvalid:
            raise ValueError(f"MarkdownIt. Failed to enable unknown rule(s): {missed}")

        return self

    def disable(
        self, names: str | Iterable[str], ignoreInvalid: bool = False
    ) -> MarkdownIt:
        """The same as [[MarkdownIt.enable]], but turn specified rules off. (chainable)

        :param names: rule name or list of rule names to disable.
        :param ignoreInvalid: set `true` to ignore errors when rule not found.

        """
        result = []

        if isinstance(names, str):
            names = [names]

        for chain in ["core", "block", "inline"]:
            result.extend(self[chain].ruler.disable(names, True))
        result.extend(self.inline.ruler2.disable(names, True))

        missed = [name for name in names if name not in result]
        if missed and not ignoreInvalid:
            raise ValueError(f"MarkdownIt. Failed to disable unknown rule(s): {missed}")
        return self

    @contextmanager
    def reset_rules(self) -> Generator[None, None, None]:
        """A context manager, that will reset the current enabled rules on exit."""
        chain_rules = self.get_active_rules()
        yield
        for chain, rules in chain_rules.items():
            if chain != "inline2":
                self[chain].ruler.enableOnly(rules)
        self.inline.ruler2.enableOnly(chain_rules["inline2"])

    def add_render_rule(
        self, name: str, function: Callable[..., Any], fmt: str = "html"
    ) -> None:
        """Add a rule for rendering a particular Token type.

        Only applied when ``renderer.__output__ == fmt``
        """
        if self.renderer.__output__ == fmt:
            self.renderer.rules[name] = function.__get__(self.renderer)  # type: ignore

    def use(
        self, plugin: Callable[..., None], *params: Any, **options: Any
    ) -> MarkdownIt:
        """Load specified plugin with given params into current parser instance. (chainable)

        It's just a sugar to call `plugin(md, params)` with curring.

        Example::

            def func(tokens, idx):
                tokens[idx].content = tokens[idx].content.replace('foo', 'bar')
            md = MarkdownIt().use(plugin, 'foo_replace', 'text', func)

        """
        plugin(self, *params, **options)
        return self

    def parse(self, src: str, env: EnvType | None = None) -> list[Token]:
        """Parse the source string to a token stream

        :param src: source string
        :param env: environment sandbox

        Parse input string and return list of block tokens (special token type
        "inline" will contain list of inline tokens).

        `env` is used to pass data between "distributed" rules and return additional
        metadata like reference info, needed for the renderer. It also can be used to
        inject data in specific cases. Usually, you will be ok to pass `{}`,
        and then pass updated object to renderer.
        """
        env = {} if env is None else env
        if not isinstance(env, MutableMapping):
            raise TypeError(f"Input data should be a MutableMapping, not {type(env)}")
        if not isinstance(src, str):
            raise TypeError(f"Input data should be a string, not {type(src)}")
        state = StateCore(src, self, env)
        self.core.process(state)
        return state.tokens

    def render(self, src: str, env: EnvType | None = None) -> Any:
        """Render markdown string into html. It does all magic for you :).

        :param src: source string
        :param env: environment sandbox
        :returns: The output of the loaded renderer

        `env` can be used to inject additional metadata (`{}` by default).
        But you will not need it with high probability. See also comment
        in [[MarkdownIt.parse]].
        """
        env = {} if env is None else env
        return self.renderer.render(self.parse(src, env), self.options, env)

    def parseInline(self, src: str, env: EnvType | None = None) -> list[Token]:
        """The same as [[MarkdownIt.parse]] but skip all block rules.

        :param src: source string
        :param env: environment sandbox

        It returns the
        block tokens list with the single `inline` element, containing parsed inline
        tokens in `children` property. Also updates `env` object.
        """
        env = {} if env is None else env
        if not isinstance(env, MutableMapping):
            raise TypeError(f"Input data should be an MutableMapping, not {type(env)}")
        if not isinstance(src, str):
            raise TypeError(f"Input data should be a string, not {type(src)}")
        state = StateCore(src, self, env)
        state.inlineMode = True
        self.core.process(state)
        return state.tokens

    def renderInline(self, src: str, env: EnvType | None = None) -> Any:
        """Similar to [[MarkdownIt.render]] but for single paragraph content.

        :param src: source string
        :param env: environment sandbox

        Similar to [[MarkdownIt.render]] but for single paragraph content. Result
        will NOT be wrapped into `
` tags.
        """
        env = {} if env is None else env
        return self.renderer.render(self.parseInline(src, env), self.options, env)

    # link methods

    def validateLink(self, url: str) -> bool:
        """Validate if the URL link is allowed in output.

        This validator can prohibit more than really needed to prevent XSS.
        It's a tradeoff to keep code simple and to be secure by default.

        Note: the url should be normalized at this point, and existing entities decoded.
        """
        return normalize_url.validateLink(url)

    def normalizeLink(self, url: str) -> str:
        """Normalize destination URLs in links

        ::

            [label]:   destination   'title'
                    ^^^^^^^^^^^
        """
        return normalize_url.normalizeLink(url)

    def normalizeLinkText(self, link: str) -> str:
        """Normalize autolink content

        ::

            
            ~~~~~~~~~~~
        """
        return normalize_url.normalizeLinkText(link)
markdown-it-py-4.2.0/markdown_it/parser_block.py000066400000000000000000000075431517710005200217440ustar00rootroot00000000000000"""Block-level tokenizer."""

from __future__ import annotations

from collections.abc import Callable
import logging
from typing import TYPE_CHECKING

from . import rules_block
from .ruler import Ruler
from .rules_block.state_block import StateBlock
from .token import Token
from .utils import EnvType

if TYPE_CHECKING:
    from markdown_it import MarkdownIt

LOGGER = logging.getLogger(__name__)


RuleFuncBlockType = Callable[[StateBlock, int, int, bool], bool]
"""(state: StateBlock, startLine: int, endLine: int, silent: bool) -> matched: bool)

`silent` disables token generation, useful for lookahead.
"""

_rules: list[tuple[str, RuleFuncBlockType, list[str]]] = [
    # First 2 params - rule name & source. Secondary array - list of rules,
    # which can be terminated by this one.
    ("table", rules_block.table, ["paragraph", "reference"]),
    ("code", rules_block.code, []),
    ("fence", rules_block.fence, ["paragraph", "reference", "blockquote", "list"]),
    (
        "blockquote",
        rules_block.blockquote,
        ["paragraph", "reference", "blockquote", "list"],
    ),
    ("hr", rules_block.hr, ["paragraph", "reference", "blockquote", "list"]),
    ("list", rules_block.list_block, ["paragraph", "reference", "blockquote"]),
    ("reference", rules_block.reference, []),
    ("html_block", rules_block.html_block, ["paragraph", "reference", "blockquote"]),
    ("heading", rules_block.heading, ["paragraph", "reference", "blockquote"]),
    ("lheading", rules_block.lheading, []),
    ("paragraph", rules_block.paragraph, []),
]


class ParserBlock:
    """
    ParserBlock#ruler -> Ruler

    [[Ruler]] instance. Keep configuration of block rules.
    """

    def __init__(self) -> None:
        self.ruler = Ruler[RuleFuncBlockType]()
        for name, rule, alt in _rules:
            self.ruler.push(name, rule, {"alt": alt})

    def tokenize(self, state: StateBlock, startLine: int, endLine: int) -> None:
        """Generate tokens for input range."""
        rules = self.ruler.getRules("")
        line = startLine
        maxNesting = state.md.options.maxNesting
        hasEmptyLines = False

        while line < endLine:
            state.line = line = state.skipEmptyLines(line)
            if line >= endLine:
                break
            if state.sCount[line] < state.blkIndent:
                # Termination condition for nested calls.
                # Nested calls currently used for blockquotes & lists
                break
            if state.level >= maxNesting:
                # If nesting level exceeded - skip tail to the end.
                # That's not ordinary situation and we should not care about content.
                state.line = endLine
                break

            # Try all possible rules.
            # On success, rule should:
            # - update `state.line`
            # - update `state.tokens`
            # - return True
            for rule in rules:
                if rule(state, line, endLine, False):
                    break

            # set state.tight if we had an empty line before current tag
            # i.e. latest empty line should not count
            state.tight = not hasEmptyLines

            line = state.line

            # paragraph might "eat" one newline after it in nested lists
            if (line - 1) < endLine and state.isEmpty(line - 1):
                hasEmptyLines = True

            if line < endLine and state.isEmpty(line):
                hasEmptyLines = True
                line += 1
                state.line = line

    def parse(
        self, src: str, md: MarkdownIt, env: EnvType, outTokens: list[Token]
    ) -> list[Token] | None:
        """Process input string and push block tokens into `outTokens`."""
        if not src:
            return None
        state = StateBlock(src, md, env, outTokens)
        self.tokenize(state, state.line, state.lineMax)
        return state.tokens
markdown-it-py-4.2.0/markdown_it/parser_core.py000066400000000000000000000017701517710005200215760ustar00rootroot00000000000000"""
* class Core
*
* Top-level rules executor. Glues block/inline parsers and does intermediate
* transformations.
"""

from __future__ import annotations

from collections.abc import Callable

from .ruler import Ruler
from .rules_core import (
    block,
    inline,
    linkify,
    normalize,
    replace,
    smartquotes,
    text_join,
)
from .rules_core.state_core import StateCore

RuleFuncCoreType = Callable[[StateCore], None]

_rules: list[tuple[str, RuleFuncCoreType]] = [
    ("normalize", normalize),
    ("block", block),
    ("inline", inline),
    ("linkify", linkify),
    ("replacements", replace),
    ("smartquotes", smartquotes),
    ("text_join", text_join),
]


class ParserCore:
    def __init__(self) -> None:
        self.ruler = Ruler[RuleFuncCoreType]()
        for name, rule in _rules:
            self.ruler.push(name, rule)

    def process(self, state: StateCore) -> None:
        """Executes core chain rules."""
        for rule in self.ruler.getRules(""):
            rule(state)
markdown-it-py-4.2.0/markdown_it/parser_inline.py000066400000000000000000000161631517710005200221260ustar00rootroot00000000000000"""Tokenizes paragraph content."""

from __future__ import annotations

from collections.abc import Callable
import functools
import re
from typing import TYPE_CHECKING

from . import rules_inline
from .ruler import Ruler
from .rules_inline.state_inline import StateInline
from .token import Token
from .utils import EnvType

if TYPE_CHECKING:
    from markdown_it import MarkdownIt


# Default set of characters that terminate a text token and allow inline rules to fire.
# '{}$%@~+=:' reserved for extensions.
# Note: Don't confuse with "Markdown ASCII Punctuation" chars.
# http://spec.commonmark.org/0.15/#ascii-punctuation-character
_DEFAULT_TERMINATORS: frozenset[str] = frozenset(
    {
        "\n",
        "!",
        "#",
        "$",
        "%",
        "&",
        "*",
        "+",
        "-",
        ":",
        "<",
        "=",
        ">",
        "@",
        "[",
        "\\",
        "]",
        "^",
        "_",
        "`",
        "{",
        "}",
        "~",
    }
)


# Lazily compiled regex for the default terminator set.  The @cache ensures it is
# compiled at most once (on first ParserInline instantiation) and shared across all
# instances that have not added extra chars, keeping __init__ cost near zero.
@functools.cache
def _default_terminator_re() -> re.Pattern[str]:
    return re.compile("[" + re.escape("".join(_DEFAULT_TERMINATORS)) + "]")


# Parser rules
RuleFuncInlineType = Callable[[StateInline, bool], bool]
"""(state: StateInline, silent: bool) -> matched: bool)

`silent` disables token generation, useful for lookahead.
"""
_rules: list[tuple[str, RuleFuncInlineType]] = [
    ("text", rules_inline.text),
    ("linkify", rules_inline.linkify),
    ("newline", rules_inline.newline),
    ("escape", rules_inline.escape),
    ("backticks", rules_inline.backtick),
    ("strikethrough", rules_inline.strikethrough.tokenize),
    ("emphasis", rules_inline.emphasis.tokenize),
    ("link", rules_inline.link),
    ("image", rules_inline.image),
    ("autolink", rules_inline.autolink),
    ("html_inline", rules_inline.html_inline),
    ("entity", rules_inline.entity),
]

# Note `rule2` ruleset was created specifically for emphasis/strikethrough
# post-processing and may be changed in the future.
#
# Don't use this for anything except pairs (plugins working with `balance_pairs`).
#
RuleFuncInline2Type = Callable[[StateInline], None]
_rules2: list[tuple[str, RuleFuncInline2Type]] = [
    ("balance_pairs", rules_inline.link_pairs),
    ("strikethrough", rules_inline.strikethrough.postProcess),
    ("emphasis", rules_inline.emphasis.postProcess),
    # rules for pairs separate '**' into its own text tokens, which may be left unused,
    # rule below merges unused segments back with the rest of the text
    ("fragments_join", rules_inline.fragments_join),
]


class ParserInline:
    def __init__(self) -> None:
        self.ruler = Ruler[RuleFuncInlineType]()
        for name, rule in _rules:
            self.ruler.push(name, rule)
        # Second ruler used for post-processing (e.g. in emphasis-like rules)
        self.ruler2 = Ruler[RuleFuncInline2Type]()
        for name, rule2 in _rules2:
            self.ruler2.push(name, rule2)
        # Characters that stop the text rule, allowing other inline rules to fire.
        # _extra_terminator_chars is only allocated when add_terminator_char() is called
        # with a char outside the defaults, keeping __init__ allocation-free.
        self._extra_terminator_chars: set[str] = set()
        # Pre-compiled regex shared with all default instances (no copy in the common path).
        self.terminator_re: re.Pattern[str] = _default_terminator_re()

    def add_terminator_char(self, ch: str) -> None:
        """Register a character that stops the ``text`` rule, allowing inline rules to fire.

        This lets plugins declare which characters their inline rules react to,
        mirroring the ``MARKER`` mechanism in the Rust markdown-it implementation.

        :param ch: A single character to add to the terminator set.
        """
        if ch not in _DEFAULT_TERMINATORS and ch not in self._extra_terminator_chars:
            self._extra_terminator_chars.add(ch)
            self.terminator_re = re.compile(
                "["
                + re.escape(
                    "".join(_DEFAULT_TERMINATORS | self._extra_terminator_chars)
                )
                + "]"
            )

    def skipToken(self, state: StateInline) -> None:
        """Skip single token by running all rules in validation mode;
        returns `True` if any rule reported success
        """
        ok = False
        pos = state.pos
        rules = self.ruler.getRules("")
        maxNesting = state.md.options["maxNesting"]
        cache = state.cache

        if pos in cache:
            state.pos = cache[pos]
            return

        if state.level < maxNesting:
            for rule in rules:
                #  Increment state.level and decrement it later to limit recursion.
                # It's harmless to do here, because no tokens are created.
                # But ideally, we'd need a separate private state variable for this purpose.
                state.level += 1
                ok = rule(state, True)
                state.level -= 1
                if ok:
                    break
        else:
            # Too much nesting, just skip until the end of the paragraph.
            #
            # NOTE: this will cause links to behave incorrectly in the following case,
            #       when an amount of `[` is exactly equal to `maxNesting + 1`:
            #
            #       [[[[[[[[[[[[[[[[[[[[[foo]()
            #
            # TODO: remove this workaround when CM standard will allow nested links
            #       (we can replace it by preventing links from being parsed in
            #       validation mode)
            #
            state.pos = state.posMax

        if not ok:
            state.pos += 1
        cache[pos] = state.pos

    def tokenize(self, state: StateInline) -> None:
        """Generate tokens for input range."""
        ok = False
        rules = self.ruler.getRules("")
        end = state.posMax
        maxNesting = state.md.options["maxNesting"]

        while state.pos < end:
            # Try all possible rules.
            # On success, rule should:
            #
            # - update `state.pos`
            # - update `state.tokens`
            # - return true

            if state.level < maxNesting:
                for rule in rules:
                    ok = rule(state, False)
                    if ok:
                        break

            if ok:
                if state.pos >= end:
                    break
                continue

            state.pending += state.src[state.pos]
            state.pos += 1

        if state.pending:
            state.pushPending()

    def parse(
        self, src: str, md: MarkdownIt, env: EnvType, tokens: list[Token]
    ) -> list[Token]:
        """Process input string and push inline tokens into `tokens`"""
        state = StateInline(src, md, env, tokens)
        self.tokenize(state)
        rules2 = self.ruler2.getRules("")
        for rule in rules2:
            rule(state)
        return state.tokens
markdown-it-py-4.2.0/markdown_it/port.yaml000066400000000000000000000046171517710005200205730ustar00rootroot00000000000000- package: markdown-it/markdown-it
  version: 14.1.0
  commit: 0fe7ccb4b7f30236fb05f623be6924961d296d3d
  date: Mar 19, 2024
  notes:
    - Rename variables that use python built-in names, e.g.
      - `max` -> `maximum`
      - `len` -> `length`
      - `str` -> `string`
    - |
      Convert JS `for` loops to `while` loops
      this is generally the main difference between the codes,
      because in python you can't do e.g. `for {i=1;i PresetType:
        config = commonmark.make()
        config["components"]["core"]["rules"].append("linkify")
        config["components"]["block"]["rules"].append("table")
        config["components"]["inline"]["rules"].extend(["strikethrough", "linkify"])
        config["components"]["inline"]["rules2"].append("strikethrough")
        config["options"]["linkify"] = True
        config["options"]["html"] = True
        return config


class gfm_like2:  # noqa: N801
    """GitHub Flavoured Markdown (GFM) like, extended.

    Builds on ``gfm-like`` and additionally enables:

    - Task lists (``- [x] done``)
    - Alerts (``> [!NOTE]``)
    - Single-tilde strikethrough (``~text~`` in addition to ``~~text~~``)
    """

    @staticmethod
    def make() -> PresetType:
        config = gfm_like.make()
        config["options"]["tasklists"] = True
        config["options"]["tasklists_editable"] = False
        config["options"]["alerts"] = True
        config["options"]["strikethrough_single_tilde"] = True
        return config
markdown-it-py-4.2.0/markdown_it/presets/commonmark.py000066400000000000000000000054651517710005200231270ustar00rootroot00000000000000"""Commonmark default options.

This differs to presets.default,
primarily in that it allows HTML and does not enable components:

- block: table
- inline: strikethrough
"""

from ..utils import PresetType


def make() -> PresetType:
    return {
        "options": {
            "maxNesting": 20,  # Internal protection, recursion limit
            "html": True,  # Enable HTML tags in source,
            # this is just a shorthand for .enable(["html_inline", "html_block"])
            # used by the linkify rule:
            "linkify": False,  # autoconvert URL-like texts to links
            # used by the replacements and smartquotes rules
            # Enable some language-neutral replacements + quotes beautification
            "typographer": False,
            # used by the smartquotes rule:
            # Double + single quotes replacement pairs, when typographer enabled,
            # and smartquotes on. Could be either a String or an Array.
            #
            # For example, you can use '«»„“' for Russian, '„“‚‘' for German,
            # and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).
            "quotes": "\u201c\u201d\u2018\u2019",  # /* “”‘’ */
            # Renderer specific; these options are used directly in the HTML renderer
            "xhtmlOut": True,  # Use '/' to close single tags (
)
            "breaks": False,  # Convert '\n' in paragraphs into 

            "langPrefix": "language-",  # CSS language prefix for fenced blocks
            # Highlighter function. Should return escaped HTML,
            # or '' if the source string is not changed and should be escaped externally.
            # If result starts with  PresetType:
    return {
        "options": {
            "maxNesting": 100,  # Internal protection, recursion limit
            "html": False,  # Enable HTML tags in source
            # this is just a shorthand for .disable(["html_inline", "html_block"])
            # used by the linkify rule:
            "linkify": False,  # autoconvert URL-like texts to links
            # used by the replacements and smartquotes rules:
            # Enable some language-neutral replacements + quotes beautification
            "typographer": False,
            # used by the smartquotes rule:
            # Double + single quotes replacement pairs, when typographer enabled,
            # and smartquotes on. Could be either a String or an Array.
            # For example, you can use '«»„“' for Russian, '„“‚‘' for German,
            # and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).
            "quotes": "\u201c\u201d\u2018\u2019",  # /* “”‘’ */
            # Renderer specific; these options are used directly in the HTML renderer
            "xhtmlOut": False,  # Use '/' to close single tags (
)
            "breaks": False,  # Convert '\n' in paragraphs into 

            "langPrefix": "language-",  # CSS language prefix for fenced blocks
            # Highlighter function. Should return escaped HTML,
            # or '' if the source string is not changed and should be escaped externally.
            # If result starts with  PresetType:
    return {
        "options": {
            "maxNesting": 20,  # Internal protection, recursion limit
            "html": False,  # Enable HTML tags in source
            # this is just a shorthand for .disable(["html_inline", "html_block"])
            # used by the linkify rule:
            "linkify": False,  # autoconvert URL-like texts to links
            # used by the replacements and smartquotes rules:
            # Enable some language-neutral replacements + quotes beautification
            "typographer": False,
            # used by the smartquotes rule:
            # Double + single quotes replacement pairs, when typographer enabled,
            # and smartquotes on. Could be either a String or an Array.
            # For example, you can use '«»„“' for Russian, '„“‚‘' for German,
            # and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).
            "quotes": "\u201c\u201d\u2018\u2019",  # /* “”‘’ */
            # Renderer specific; these options are used directly in the HTML renderer
            "xhtmlOut": False,  # Use '/' to close single tags (
)
            "breaks": False,  # Convert '\n' in paragraphs into 

            "langPrefix": "language-",  # CSS language prefix for fenced blocks
            # Highlighter function. Should return escaped HTML,
            # or '' if the source string is not changed and should be escaped externally.
            # If result starts with  Any: ...


class RendererHTML(RendererProtocol):
    """Contains render rules for tokens. Can be updated and extended.

    Example:

    Each rule is called as independent static function with fixed signature:

    ::

        class Renderer:
            def token_type_name(self, tokens, idx, options, env) {
                # ...
                return renderedHTML

    ::

        class CustomRenderer(RendererHTML):
            def strong_open(self, tokens, idx, options, env):
                return ''
            def strong_close(self, tokens, idx, options, env):
                return ''

        md = MarkdownIt(renderer_cls=CustomRenderer)

        result = md.render(...)

    See https://github.com/markdown-it/markdown-it/blob/master/lib/renderer.js
    for more details and examples.
    """

    __output__ = "html"

    def __init__(self, parser: Any = None):
        self.rules = {
            k: v
            for k, v in inspect.getmembers(self, predicate=inspect.ismethod)
            if not (k.startswith("render") or k.startswith("_"))
        }

    def render(
        self, tokens: Sequence[Token], options: OptionsDict, env: EnvType
    ) -> str:
        """Takes token stream and generates HTML.

        :param tokens: list on block tokens to render
        :param options: params of parser instance
        :param env: additional data from parsed input

        """
        result = ""

        for i, token in enumerate(tokens):
            if token.type == "inline":
                if token.children:
                    result += self.renderInline(token.children, options, env)
            elif token.type in self.rules:
                result += self.rules[token.type](tokens, i, options, env)
            else:
                result += self.renderToken(tokens, i, options, env)

        return result

    def renderInline(
        self, tokens: Sequence[Token], options: OptionsDict, env: EnvType
    ) -> str:
        """The same as ``render``, but for single token of `inline` type.

        :param tokens: list on block tokens to render
        :param options: params of parser instance
        :param env: additional data from parsed input (references, for example)
        """
        result = ""

        for i, token in enumerate(tokens):
            if token.type in self.rules:
                result += self.rules[token.type](tokens, i, options, env)
            else:
                result += self.renderToken(tokens, i, options, env)

        return result

    def renderToken(
        self,
        tokens: Sequence[Token],
        idx: int,
        options: OptionsDict,
        env: EnvType,
    ) -> str:
        """Default token renderer.

        Can be overridden by custom function

        :param idx: token index to render
        :param options: params of parser instance
        """
        result = ""
        needLf = False
        token = tokens[idx]

        # Tight list paragraphs
        if token.hidden:
            return ""

        # Insert a newline between hidden paragraph and subsequent opening
        # block-level tag.
        #
        # For example, here we should insert a newline before blockquote:
        #  - a
        #    >
        #
        if token.block and token.nesting != -1 and idx and tokens[idx - 1].hidden:
            result += "\n"

        # Add token name, e.g. ``.
                    #
                    needLf = False

        result += ">\n" if needLf else ">"

        return result

    @staticmethod
    def renderAttrs(token: Token) -> str:
        """Render token attributes to string."""
        result = ""

        for key, value in token.attrItems():
            result += " " + escapeHtml(key) + '="' + escapeHtml(str(value)) + '"'

        return result

    def renderInlineAsText(
        self,
        tokens: Sequence[Token] | None,
        options: OptionsDict,
        env: EnvType,
    ) -> str:
        """Special kludge for image `alt` attributes to conform CommonMark spec.

        Don't try to use it! Spec requires to show `alt` content with stripped markup,
        instead of simple escaping.

        :param tokens: list on block tokens to render
        :param options: params of parser instance
        :param env: additional data from parsed input
        """
        result = ""

        for token in tokens or []:
            if token.type == "text":
                result += token.content
            elif token.type == "image":
                if token.children:
                    result += self.renderInlineAsText(token.children, options, env)
            elif token.type == "softbreak":
                result += "\n"

        return result

    ###################################################

    def list_item_open(
        self,
        tokens: Sequence[Token],
        idx: int,
        options: OptionsDict,
        env: EnvType,
    ) -> str:
        token = tokens[idx]
        result = self.renderToken(tokens, idx, options, env)
        if token.meta and "checked" in token.meta:
            checked_attr = ' checked=""' if token.meta["checked"] else ""
            disabled_attr = (
                "" if options.get("tasklists_editable", False) else ' disabled=""'
            )
            result += (
                ' '
            )
        return result

    def code_inline(
        self, tokens: Sequence[Token], idx: int, options: OptionsDict, env: EnvType
    ) -> str:
        token = tokens[idx]
        return (
            ""
            + escapeHtml(tokens[idx].content)
            + ""
        )

    def code_block(
        self,
        tokens: Sequence[Token],
        idx: int,
        options: OptionsDict,
        env: EnvType,
    ) -> str:
        token = tokens[idx]

        return (
            ""
            + escapeHtml(tokens[idx].content)
            + "
\n"
        )

    def fence(
        self,
        tokens: Sequence[Token],
        idx: int,
        options: OptionsDict,
        env: EnvType,
    ) -> str:
        token = tokens[idx]
        info = unescapeAll(token.info).strip() if token.info else ""
        langName = ""
        langAttrs = ""

        if info:
            arr = info.split(maxsplit=1)
            langName = arr[0]
            if len(arr) == 2:
                langAttrs = arr[1]

        if options.highlight:
            highlighted = options.highlight(
                token.content, langName, langAttrs
            ) or escapeHtml(token.content)
        else:
            highlighted = escapeHtml(token.content)

        if highlighted.startswith(""
                + highlighted
                + "
\n"
            )

        return (
            "
"
            + highlighted
            + "
\n"
        )

    def image(
        self,
        tokens: Sequence[Token],
        idx: int,
        options: OptionsDict,
        env: EnvType,
    ) -> str:
        token = tokens[idx]

        # "alt" attr MUST be set, even if empty. Because it's mandatory and
        # should be placed on proper position for tests.
        if token.children:
            token.attrSet("alt", self.renderInlineAsText(token.children, options, env))
        else:
            token.attrSet("alt", "")

        return self.renderToken(tokens, idx, options, env)

    def hardbreak(
        self, tokens: Sequence[Token], idx: int, options: OptionsDict, env: EnvType
    ) -> str:
        return "
\n" if options.xhtmlOut else "
\n"

    def softbreak(
        self, tokens: Sequence[Token], idx: int, options: OptionsDict, env: EnvType
    ) -> str:
        return (
            ("
\n" if options.xhtmlOut else "
\n") if options.breaks else "\n"
        )

    def text(
        self, tokens: Sequence[Token], idx: int, options: OptionsDict, env: EnvType
    ) -> str:
        return escapeHtml(tokens[idx].content)

    def html_block(
        self, tokens: Sequence[Token], idx: int, options: OptionsDict, env: EnvType
    ) -> str:
        return tokens[idx].content

    def html_inline(
        self, tokens: Sequence[Token], idx: int, options: OptionsDict, env: EnvType
    ) -> str:
        return tokens[idx].content
markdown-it-py-4.2.0/markdown_it/ruler.py000066400000000000000000000216661517710005200204310ustar00rootroot00000000000000"""
class Ruler

Helper class, used by [[MarkdownIt#core]], [[MarkdownIt#block]] and
[[MarkdownIt#inline]] to manage sequences of functions (rules):

- keep rules in defined order
- assign the name to each rule
- enable/disable rules
- add/replace rules
- allow assign rules to additional named chains (in the same)
- caching lists of active rules

You will not need use this class directly until write plugins. For simple
rules control use [[MarkdownIt.disable]], [[MarkdownIt.enable]] and
[[MarkdownIt.use]].
"""

from __future__ import annotations

from collections.abc import Iterable
from dataclasses import dataclass, field
from typing import TYPE_CHECKING, Generic, TypedDict, TypeVar
import warnings

from .utils import EnvType

if TYPE_CHECKING:
    from markdown_it import MarkdownIt


class StateBase:
    def __init__(self, src: str, md: MarkdownIt, env: EnvType):
        self.src = src
        self.env = env
        self.md = md

    @property
    def src(self) -> str:
        return self._src

    @src.setter
    def src(self, value: str) -> None:
        self._src = value
        self._srcCharCode: tuple[int, ...] | None = None

    @property
    def srcCharCode(self) -> tuple[int, ...]:
        warnings.warn(
            "StateBase.srcCharCode is deprecated. Use StateBase.src instead.",
            DeprecationWarning,
            stacklevel=2,
        )
        if self._srcCharCode is None:
            self._srcCharCode = tuple(ord(c) for c in self._src)
        return self._srcCharCode


class RuleOptionsType(TypedDict, total=False):
    alt: list[str]


RuleFuncTv = TypeVar("RuleFuncTv")
"""A rule function, whose signature is dependent on the state type."""


@dataclass(slots=True)
class Rule(Generic[RuleFuncTv]):
    name: str
    enabled: bool
    fn: RuleFuncTv = field(repr=False)
    alt: list[str]


class Ruler(Generic[RuleFuncTv]):
    def __init__(self) -> None:
        # List of added rules.
        self.__rules__: list[Rule[RuleFuncTv]] = []
        # Cached rule chains.
        # First level - chain name, '' for default.
        # Second level - diginal anchor for fast filtering by charcodes.
        self.__cache__: dict[str, list[RuleFuncTv]] | None = None

    def __find__(self, name: str) -> int:
        """Find rule index by name"""
        for i, rule in enumerate(self.__rules__):
            if rule.name == name:
                return i
        return -1

    def __compile__(self) -> None:
        """Build rules lookup cache"""
        chains = {""}
        # collect unique names
        for rule in self.__rules__:
            if not rule.enabled:
                continue
            for name in rule.alt:
                chains.add(name)
        self.__cache__ = {}
        for chain in chains:
            self.__cache__[chain] = []
            for rule in self.__rules__:
                if not rule.enabled:
                    continue
                if chain and (chain not in rule.alt):
                    continue
                self.__cache__[chain].append(rule.fn)

    def at(
        self, ruleName: str, fn: RuleFuncTv, options: RuleOptionsType | None = None
    ) -> None:
        """Replace rule by name with new function & options.

        :param ruleName: rule name to replace.
        :param fn: new rule function.
        :param options: new rule options (not mandatory).
        :raises: KeyError if name not found
        """
        index = self.__find__(ruleName)
        options = options or {}
        if index == -1:
            raise KeyError(f"Parser rule not found: {ruleName}")
        self.__rules__[index].fn = fn
        self.__rules__[index].alt = options.get("alt", [])
        self.__cache__ = None

    def before(
        self,
        beforeName: str,
        ruleName: str,
        fn: RuleFuncTv,
        options: RuleOptionsType | None = None,
    ) -> None:
        """Add new rule to chain before one with given name.

        :param beforeName: new rule will be added before this one.
        :param ruleName: new rule will be added before this one.
        :param fn: new rule function.
        :param options: new rule options (not mandatory).
        :raises: KeyError if name not found
        """
        index = self.__find__(beforeName)
        options = options or {}
        if index == -1:
            raise KeyError(f"Parser rule not found: {beforeName}")
        self.__rules__.insert(
            index, Rule[RuleFuncTv](ruleName, True, fn, options.get("alt", []))
        )
        self.__cache__ = None

    def after(
        self,
        afterName: str,
        ruleName: str,
        fn: RuleFuncTv,
        options: RuleOptionsType | None = None,
    ) -> None:
        """Add new rule to chain after one with given name.

        :param afterName: new rule will be added after this one.
        :param ruleName: new rule will be added after this one.
        :param fn: new rule function.
        :param options: new rule options (not mandatory).
        :raises: KeyError if name not found
        """
        index = self.__find__(afterName)
        options = options or {}
        if index == -1:
            raise KeyError(f"Parser rule not found: {afterName}")
        self.__rules__.insert(
            index + 1, Rule[RuleFuncTv](ruleName, True, fn, options.get("alt", []))
        )
        self.__cache__ = None

    def push(
        self, ruleName: str, fn: RuleFuncTv, options: RuleOptionsType | None = None
    ) -> None:
        """Push new rule to the end of chain.

        :param ruleName: new rule will be added to the end of chain.
        :param fn: new rule function.
        :param options: new rule options (not mandatory).

        """
        self.__rules__.append(
            Rule[RuleFuncTv](ruleName, True, fn, (options or {}).get("alt", []))
        )
        self.__cache__ = None

    def enable(
        self, names: str | Iterable[str], ignoreInvalid: bool = False
    ) -> list[str]:
        """Enable rules with given names.

        :param names: name or list of rule names to enable.
        :param ignoreInvalid: ignore errors when rule not found
        :raises: KeyError if name not found and not ignoreInvalid
        :return: list of found rule names
        """
        if isinstance(names, str):
            names = [names]
        result: list[str] = []
        for name in names:
            idx = self.__find__(name)
            if (idx < 0) and ignoreInvalid:
                continue
            if (idx < 0) and not ignoreInvalid:
                raise KeyError(f"Rules manager: invalid rule name {name}")
            self.__rules__[idx].enabled = True
            result.append(name)
        self.__cache__ = None
        return result

    def enableOnly(
        self, names: str | Iterable[str], ignoreInvalid: bool = False
    ) -> list[str]:
        """Enable rules with given names, and disable everything else.

        :param names: name or list of rule names to enable.
        :param ignoreInvalid: ignore errors when rule not found
        :raises: KeyError if name not found and not ignoreInvalid
        :return: list of found rule names
        """
        if isinstance(names, str):
            names = [names]
        for rule in self.__rules__:
            rule.enabled = False
        return self.enable(names, ignoreInvalid)

    def disable(
        self, names: str | Iterable[str], ignoreInvalid: bool = False
    ) -> list[str]:
        """Disable rules with given names.

        :param names: name or list of rule names to enable.
        :param ignoreInvalid: ignore errors when rule not found
        :raises: KeyError if name not found and not ignoreInvalid
        :return: list of found rule names
        """
        if isinstance(names, str):
            names = [names]
        result = []
        for name in names:
            idx = self.__find__(name)
            if (idx < 0) and ignoreInvalid:
                continue
            if (idx < 0) and not ignoreInvalid:
                raise KeyError(f"Rules manager: invalid rule name {name}")
            self.__rules__[idx].enabled = False
            result.append(name)
        self.__cache__ = None
        return result

    def getRules(self, chainName: str = "") -> list[RuleFuncTv]:
        """Return array of active functions (rules) for given chain name.
        It analyzes rules configuration, compiles caches if not exists and returns result.

        Default chain name is `''` (empty string). It can't be skipped.
        That's done intentionally, to keep signature monomorphic for high speed.

        """
        if self.__cache__ is None:
            self.__compile__()
            assert self.__cache__ is not None
        # Chain can be empty, if rules disabled. But we still have to return Array.
        return self.__cache__.get(chainName, []) or []

    def get_all_rules(self) -> list[str]:
        """Return all available rule names."""
        return [r.name for r in self.__rules__]

    def get_active_rules(self) -> list[str]:
        """Return the active rule names."""
        return [r.name for r in self.__rules__ if r.enabled]
markdown-it-py-4.2.0/markdown_it/rules_block/000077500000000000000000000000001517710005200212175ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/rules_block/__init__.py000066400000000000000000000011211517710005200233230ustar00rootroot00000000000000__all__ = (
    "StateBlock",
    "blockquote",
    "code",
    "fence",
    "heading",
    "hr",
    "html_block",
    "lheading",
    "list_block",
    "make_fence_rule",
    "paragraph",
    "reference",
    "table",
)

from .blockquote import blockquote
from .code import code
from .fence import fence, make_fence_rule
from .heading import heading
from .hr import hr
from .html_block import html_block
from .lheading import lheading
from .list import list_block
from .paragraph import paragraph
from .reference import reference
from .state_block import StateBlock
from .table import table
markdown-it-py-4.2.0/markdown_it/rules_block/blockquote.py000066400000000000000000000263621517710005200237520ustar00rootroot00000000000000# Block quotes
from __future__ import annotations

import logging

from ..common.utils import isStrSpace
from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def blockquote(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug(
        "entering blockquote: %s, %s, %s, %s", state, startLine, endLine, silent
    )

    oldLineMax = state.lineMax
    pos = state.bMarks[startLine] + state.tShift[startLine]
    max = state.eMarks[startLine]

    if state.is_code_block(startLine):
        return False

    # check the block quote marker
    try:
        if state.src[pos] != ">":
            return False
    except IndexError:
        return False
    pos += 1

    # we know that it's going to be a valid blockquote,
    # so no point trying to find the end of it in silent mode
    if silent:
        return True

    # set offset past spaces and ">"
    initial = offset = state.sCount[startLine] + 1

    try:
        second_char: str | None = state.src[pos]
    except IndexError:
        second_char = None

    # skip one optional space after '>'
    if second_char == " ":
        # ' >   test '
        #     ^ -- position start of line here:
        pos += 1
        initial += 1
        offset += 1
        adjustTab = False
        spaceAfterMarker = True
    elif second_char == "\t":
        spaceAfterMarker = True

        if (state.bsCount[startLine] + offset) % 4 == 3:
            # '  >\t  test '
            #       ^ -- position start of line here (tab has width==1)
            pos += 1
            initial += 1
            offset += 1
            adjustTab = False
        else:
            # ' >\t  test '
            #    ^ -- position start of line here + shift bsCount slightly
            #         to make extra space appear
            adjustTab = True

    else:
        spaceAfterMarker = False

    oldBMarks = [state.bMarks[startLine]]
    state.bMarks[startLine] = pos

    while pos < max:
        ch = state.src[pos]

        if isStrSpace(ch):
            if ch == "\t":
                offset += (
                    4
                    - (offset + state.bsCount[startLine] + (1 if adjustTab else 0)) % 4
                )
            else:
                offset += 1

        else:
            break

        pos += 1

    oldBSCount = [state.bsCount[startLine]]
    state.bsCount[startLine] = (
        state.sCount[startLine] + 1 + (1 if spaceAfterMarker else 0)
    )

    lastLineEmpty = pos >= max

    oldSCount = [state.sCount[startLine]]
    state.sCount[startLine] = offset - initial

    oldTShift = [state.tShift[startLine]]
    state.tShift[startLine] = pos - state.bMarks[startLine]

    terminatorRules = state.md.block.ruler.getRules("blockquote")

    oldParentType = state.parentType
    state.parentType = "blockquote"

    # Search the end of the block
    #
    # Block ends with either:
    #  1. an empty line outside:
    #     ```
    #     > test
    #
    #     ```
    #  2. an empty line inside:
    #     ```
    #     >
    #     test
    #     ```
    #  3. another tag:
    #     ```
    #     > test
    #      - - -
    #     ```

    # for (nextLine = startLine + 1; nextLine < endLine; nextLine++) {
    nextLine = startLine + 1
    while nextLine < endLine:
        # check if it's outdented, i.e. it's inside list item and indented
        # less than said list item:
        #
        # ```
        # 1. anything
        #    > current blockquote
        # 2. checking this line
        # ```
        isOutdented = state.sCount[nextLine] < state.blkIndent

        pos = state.bMarks[nextLine] + state.tShift[nextLine]
        max = state.eMarks[nextLine]

        if pos >= max:
            # Case 1: line is not inside the blockquote, and this line is empty.
            break

        evaluatesTrue = state.src[pos] == ">" and not isOutdented
        pos += 1
        if evaluatesTrue:
            # This line is inside the blockquote.

            # set offset past spaces and ">"
            initial = offset = state.sCount[nextLine] + 1

            try:
                next_char: str | None = state.src[pos]
            except IndexError:
                next_char = None

            # skip one optional space after '>'
            if next_char == " ":
                # ' >   test '
                #     ^ -- position start of line here:
                pos += 1
                initial += 1
                offset += 1
                adjustTab = False
                spaceAfterMarker = True
            elif next_char == "\t":
                spaceAfterMarker = True

                if (state.bsCount[nextLine] + offset) % 4 == 3:
                    # '  >\t  test '
                    #       ^ -- position start of line here (tab has width==1)
                    pos += 1
                    initial += 1
                    offset += 1
                    adjustTab = False
                else:
                    # ' >\t  test '
                    #    ^ -- position start of line here + shift bsCount slightly
                    #         to make extra space appear
                    adjustTab = True

            else:
                spaceAfterMarker = False

            oldBMarks.append(state.bMarks[nextLine])
            state.bMarks[nextLine] = pos

            while pos < max:
                ch = state.src[pos]

                if isStrSpace(ch):
                    if ch == "\t":
                        offset += (
                            4
                            - (
                                offset
                                + state.bsCount[nextLine]
                                + (1 if adjustTab else 0)
                            )
                            % 4
                        )
                    else:
                        offset += 1
                else:
                    break

                pos += 1

            lastLineEmpty = pos >= max

            oldBSCount.append(state.bsCount[nextLine])
            state.bsCount[nextLine] = (
                state.sCount[nextLine] + 1 + (1 if spaceAfterMarker else 0)
            )

            oldSCount.append(state.sCount[nextLine])
            state.sCount[nextLine] = offset - initial

            oldTShift.append(state.tShift[nextLine])
            state.tShift[nextLine] = pos - state.bMarks[nextLine]

            nextLine += 1
            continue

        # Case 2: line is not inside the blockquote, and the last line was empty.
        if lastLineEmpty:
            break

        # Case 3: another tag found.
        terminate = False

        for terminatorRule in terminatorRules:
            if terminatorRule(state, nextLine, endLine, True):
                terminate = True
                break

        if terminate:
            # Quirk to enforce "hard termination mode" for paragraphs;
            # normally if you call `tokenize(state, startLine, nextLine)`,
            # paragraphs will look below nextLine for paragraph continuation,
            # but if blockquote is terminated by another tag, they shouldn't
            state.lineMax = nextLine

            if state.blkIndent != 0:
                # state.blkIndent was non-zero, we now set it to zero,
                # so we need to re-calculate all offsets to appear as
                # if indent wasn't changed
                oldBMarks.append(state.bMarks[nextLine])
                oldBSCount.append(state.bsCount[nextLine])
                oldTShift.append(state.tShift[nextLine])
                oldSCount.append(state.sCount[nextLine])
                state.sCount[nextLine] -= state.blkIndent

            break

        oldBMarks.append(state.bMarks[nextLine])
        oldBSCount.append(state.bsCount[nextLine])
        oldTShift.append(state.tShift[nextLine])
        oldSCount.append(state.sCount[nextLine])

        # A negative indentation means that this is a paragraph continuation
        #
        state.sCount[nextLine] = -1

        nextLine += 1

    oldIndent = state.blkIndent
    state.blkIndent = 0

    # Detect GitHub-style alert marker on the first content line.
    # Note: `startLine` here refers to the first content line of the
    # blockquote, after the `>` prefix has already been stripped by the
    # blockquote parser above (bMarks/tShift adjusted to skip `> `).
    alert_kind = None
    if state.md.options.get("alerts", False) and nextLine > startLine:
        alert_kind = _detect_alert(state, startLine)

    lines = [startLine, 0]

    if alert_kind is not None:
        # Emit alert tokens instead of blockquote tokens
        alert_lower = alert_kind.lower()
        token = state.push("alert_open", "div", 1)
        token.markup = ">"
        token.attrSet("class", f"markdown-alert markdown-alert-{alert_lower}")
        token.map = lines
        token.info = alert_kind
        token.meta = {"kind": alert_kind}

        # Emit a title paragraph: 
Kind

        token = state.push("alert_title_open", "p", 1)
        token.attrSet("class", "markdown-alert-title")
        title_token = state.push("inline", "", 0)
        title_token.content = alert_kind.capitalize()
        title_token.children = []
        token = state.push("alert_title_close", "p", -1)

        # Skip the marker line (startLine) and tokenize from startLine + 1.
        contentStart = startLine + 1
        if contentStart < nextLine:
            # tokenize() updates state.line to nextLine as part of its
            # contract, consistent with the blockquote code path below.
            state.md.block.tokenize(state, contentStart, nextLine)
        else:
            state.line = nextLine

        token = state.push("alert_close", "div", -1)
        token.markup = ">"
    else:
        token = state.push("blockquote_open", "blockquote", 1)
        token.markup = ">"
        token.map = lines

        state.md.block.tokenize(state, startLine, nextLine)

        token = state.push("blockquote_close", "blockquote", -1)
        token.markup = ">"

    state.lineMax = oldLineMax
    state.parentType = oldParentType
    # Update the opening token map for both alert and blockquote containers.
    lines[1] = state.line

    # Restore original tShift; this might not be necessary since the parser
    # has already been here, but just to make sure we can do that.
    for i, item in enumerate(oldTShift):
        state.bMarks[i + startLine] = oldBMarks[i]
        state.tShift[i + startLine] = item
        state.sCount[i + startLine] = oldSCount[i]
        state.bsCount[i + startLine] = oldBSCount[i]

    state.blkIndent = oldIndent

    return True


_ALERT_TYPES = {"NOTE", "TIP", "IMPORTANT", "WARNING", "CAUTION"}


def _detect_alert(state: StateBlock, startLine: int) -> str | None:
    """Detect ``[!TYPE]`` on *startLine* (after ``>`` prefix has been stripped).

    Returns the alert type string (e.g. ``"NOTE"``) or ``None``.
    """
    pos = state.bMarks[startLine] + state.tShift[startLine]
    maximum = state.eMarks[startLine]
    src = state.src

    # Trim trailing whitespace
    while maximum > pos and src[maximum - 1] in (" ", "\t"):
        maximum -= 1

    if maximum - pos < 4:
        return None
    if src[pos] != "[" or src[pos + 1] != "!":
        return None
    if src[maximum - 1] != "]":
        return None
    type_str = src[pos + 2 : maximum - 1].upper()
    if type_str not in _ALERT_TYPES:
        return None
    return type_str
markdown-it-py-4.2.0/markdown_it/rules_block/code.py000066400000000000000000000015341517710005200225060ustar00rootroot00000000000000"""Code block (4 spaces padded)."""

import logging

from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def code(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug("entering code: %s, %s, %s, %s", state, startLine, endLine, silent)

    if not state.is_code_block(startLine):
        return False

    last = nextLine = startLine + 1

    while nextLine < endLine:
        if state.isEmpty(nextLine):
            nextLine += 1
            continue

        if state.is_code_block(nextLine):
            nextLine += 1
            last = nextLine
            continue

        break

    state.line = last

    token = state.push("code_block", "code", 0)
    token.content = state.getLines(startLine, last, 4 + state.blkIndent, False) + "\n"
    token.map = [startLine, state.line]

    return True
markdown-it-py-4.2.0/markdown_it/rules_block/fence.py000066400000000000000000000112601517710005200226510ustar00rootroot00000000000000# fences (``` lang, ~~~ lang)
from __future__ import annotations

from collections.abc import Callable
import logging

from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def make_fence_rule(
    *,
    markers: tuple[str, ...] = ("~", "`"),
    token_type: str = "fence",
    exact_match: bool = False,
    disallow_marker_in_info: tuple[str, ...] = ("`",),
    min_markers: int = 3,
) -> Callable[[StateBlock, int, int, bool], bool]:
    """Create a fence parsing rule with configurable options.

    :param markers: Tuple of single characters that can be used as fence markers.
    :param token_type: The token type name to emit (e.g. "fence", "colon_fence").
    :param exact_match: If True, the closing fence must have exactly the same
        number of marker characters as the opening fence (not "at least as many").
        This enables nesting of fences with different marker counts.
    :param disallow_marker_in_info: Tuple of marker characters that are not allowed
        to appear in the info string. The check only applies when the actual opening
        marker is in this tuple (e.g. a tilde fence is unaffected by ``"`"`` being
        listed). Per CommonMark, backtick fences cannot have backticks in the info
        string. Use ``()`` to disable this restriction.
    :param min_markers: Minimum number of marker characters to form a fence.
    :return: A block rule function with signature
        ``(state, startLine, endLine, silent) -> bool``.
    """

    closing_matcher: Callable[[int, int], bool]
    if exact_match:
        # closing code fence must have exactly the same number of markers as the opening one
        closing_matcher = lambda opening_len, closing_len: closing_len == opening_len  # noqa: E731
    else:
        # closing code fence must be at least as long as the opening one
        closing_matcher = lambda opening_len, closing_len: closing_len >= opening_len  # noqa: E731

    def _fence_rule(
        state: StateBlock, startLine: int, endLine: int, silent: bool
    ) -> bool:
        LOGGER.debug(
            "entering fence: %s, %s, %s, %s", state, startLine, endLine, silent
        )

        haveEndMarker = False
        pos = state.bMarks[startLine] + state.tShift[startLine]
        maximum = state.eMarks[startLine]

        if state.is_code_block(startLine):
            return False

        if pos + min_markers > maximum:
            return False

        marker = state.src[pos]

        if marker not in markers:
            return False

        # scan marker length
        mem = pos
        pos = state.skipCharsStr(pos, marker)

        length = pos - mem

        if length < min_markers:
            return False

        markup = state.src[mem:pos]
        params = state.src[pos:maximum]

        if marker in disallow_marker_in_info and marker in params:
            return False

        # Since start is found, we can report success here in validation mode
        if silent:
            return True

        # search end of block
        nextLine = startLine

        while True:
            nextLine += 1
            if nextLine >= endLine:
                # unclosed block should be autoclosed by end of document.
                # also block seems to be autoclosed by end of parent
                break

            pos = mem = state.bMarks[nextLine] + state.tShift[nextLine]
            maximum = state.eMarks[nextLine]

            if pos < maximum and state.sCount[nextLine] < state.blkIndent:
                # non-empty line with negative indent should stop the list:
                # - ```
                #  test
                break

            try:
                if state.src[pos] != marker:
                    continue
            except IndexError:
                break

            if state.is_code_block(nextLine):
                continue

            pos = state.skipCharsStr(pos, marker)

            if not closing_matcher(length, pos - mem):
                continue

            # make sure tail has spaces only
            pos = state.skipSpaces(pos)

            if pos < maximum:
                continue

            haveEndMarker = True
            # found!
            break

        # If a fence has heading spaces, they should be removed from its inner block
        length = state.sCount[startLine]

        state.line = nextLine + (1 if haveEndMarker else 0)

        token = state.push(token_type, "code", 0)
        token.info = params
        token.content = state.getLines(startLine + 1, nextLine, length, True)
        token.markup = markup
        token.map = [startLine, state.line]

        return True

    return _fence_rule


#: The default fence rule (backtick and tilde markers, CommonMark compliant).
fence = make_fence_rule()
markdown-it-py-4.2.0/markdown_it/rules_block/heading.py000066400000000000000000000033211517710005200231670ustar00rootroot00000000000000"""Atex heading (#, ##, ...)"""

from __future__ import annotations

import logging

from ..common.utils import isStrSpace
from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def heading(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug("entering heading: %s, %s, %s, %s", state, startLine, endLine, silent)

    pos = state.bMarks[startLine] + state.tShift[startLine]
    maximum = state.eMarks[startLine]

    if state.is_code_block(startLine):
        return False

    ch: str | None = state.src[pos]

    if ch != "#" or pos >= maximum:
        return False

    # count heading level
    level = 1
    pos += 1
    try:
        ch = state.src[pos]
    except IndexError:
        ch = None
    while ch == "#" and pos < maximum and level <= 6:
        level += 1
        pos += 1
        try:
            ch = state.src[pos]
        except IndexError:
            ch = None

    if level > 6 or (pos < maximum and not isStrSpace(ch)):
        return False

    if silent:
        return True

    # Let's cut tails like '    ###  ' from the end of string

    maximum = state.skipSpacesBack(maximum, pos)
    tmp = state.skipCharsStrBack(maximum, "#", pos)
    if tmp > pos and isStrSpace(state.src[tmp - 1]):
        maximum = tmp

    state.line = startLine + 1

    token = state.push("heading_open", "h" + str(level), 1)
    token.markup = "########"[:level]
    token.map = [startLine, state.line]

    token = state.push("inline", "", 0)
    token.content = state.src[pos:maximum].strip()
    token.map = [startLine, state.line]
    token.children = []

    token = state.push("heading_close", "h" + str(level), -1)
    token.markup = "########"[:level]

    return True
markdown-it-py-4.2.0/markdown_it/rules_block/hr.py000066400000000000000000000023131517710005200222010ustar00rootroot00000000000000"""Horizontal rule

At least 3 of these characters on a line * - _
"""

import logging

from ..common.utils import isStrSpace
from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def hr(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug("entering hr: %s, %s, %s, %s", state, startLine, endLine, silent)

    pos = state.bMarks[startLine] + state.tShift[startLine]
    maximum = state.eMarks[startLine]

    if state.is_code_block(startLine):
        return False

    try:
        marker = state.src[pos]
    except IndexError:
        return False
    pos += 1

    # Check hr marker
    if marker not in ("*", "-", "_"):
        return False

    # markers can be mixed with spaces, but there should be at least 3 of them

    cnt = 1
    while pos < maximum:
        ch = state.src[pos]
        pos += 1
        if ch != marker and not isStrSpace(ch):
            return False
        if ch == marker:
            cnt += 1

    if cnt < 3:
        return False

    if silent:
        return True

    state.line = startLine + 1

    token = state.push("hr", "hr", 0)
    token.map = [startLine, state.line]
    token.markup = marker * (cnt + 1)

    return True
markdown-it-py-4.2.0/markdown_it/rules_block/html_block.py000066400000000000000000000052411517710005200237110ustar00rootroot00000000000000# HTML block
from __future__ import annotations

import logging
import re

from ..common.html_blocks import block_names
from ..common.html_re import HTML_OPEN_CLOSE_TAG_STR
from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)

# An array of opening and corresponding closing sequences for html tags,
# last argument defines whether it can terminate a paragraph or not
HTML_SEQUENCES: list[tuple[re.Pattern[str], re.Pattern[str], bool]] = [
    (
        re.compile(r"^<(script|pre|style|textarea)(?=(\s|>|$))", re.IGNORECASE),
        re.compile(r"<\/(script|pre|style|textarea)>", re.IGNORECASE),
        True,
    ),
    (re.compile(r"^"), True),
    (re.compile(r"^<\?"), re.compile(r"\?>"), True),
    (re.compile(r"^"), True),
    (re.compile(r"^"), True),
    (
        re.compile("^|$))", re.IGNORECASE),
        re.compile(r"^$"),
        True,
    ),
    (re.compile(HTML_OPEN_CLOSE_TAG_STR + "\\s*$"), re.compile(r"^$"), False),
]


def html_block(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug(
        "entering html_block: %s, %s, %s, %s", state, startLine, endLine, silent
    )
    pos = state.bMarks[startLine] + state.tShift[startLine]
    maximum = state.eMarks[startLine]

    if state.is_code_block(startLine):
        return False

    if not state.md.options.get("html", None):
        return False

    if state.src[pos] != "<":
        return False

    lineText = state.src[pos:maximum]

    html_seq = None
    for HTML_SEQUENCE in HTML_SEQUENCES:
        if HTML_SEQUENCE[0].search(lineText):
            html_seq = HTML_SEQUENCE
            break

    if not html_seq:
        return False

    if silent:
        # true if this sequence can be a terminator, false otherwise
        return html_seq[2]

    nextLine = startLine + 1

    # If we are here - we detected HTML block.
    # Let's roll down till block end.
    if not html_seq[1].search(lineText):
        while nextLine < endLine:
            if state.sCount[nextLine] < state.blkIndent:
                break

            pos = state.bMarks[nextLine] + state.tShift[nextLine]
            maximum = state.eMarks[nextLine]
            lineText = state.src[pos:maximum]

            if html_seq[1].search(lineText):
                if len(lineText) != 0:
                    nextLine += 1
                break
            nextLine += 1

    state.line = nextLine

    token = state.push("html_block", "", 0)
    token.map = [startLine, nextLine]
    token.content = state.getLines(startLine, nextLine, state.blkIndent, True)

    return True
markdown-it-py-4.2.0/markdown_it/rules_block/lheading.py000066400000000000000000000051011517710005200233410ustar00rootroot00000000000000# lheading (---, ==)
import logging

from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def lheading(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug("entering lheading: %s, %s, %s, %s", state, startLine, endLine, silent)

    level = None
    nextLine = startLine + 1
    ruler = state.md.block.ruler
    terminatorRules = ruler.getRules("paragraph")

    if state.is_code_block(startLine):
        return False

    oldParentType = state.parentType
    state.parentType = "paragraph"  # use paragraph to match terminatorRules

    # jump line-by-line until empty one or EOF
    while nextLine < endLine and not state.isEmpty(nextLine):
        # this would be a code block normally, but after paragraph
        # it's considered a lazy continuation regardless of what's there
        if state.sCount[nextLine] - state.blkIndent > 3:
            nextLine += 1
            continue

        # Check for underline in setext header
        if state.sCount[nextLine] >= state.blkIndent:
            pos = state.bMarks[nextLine] + state.tShift[nextLine]
            maximum = state.eMarks[nextLine]

            if pos < maximum:
                marker = state.src[pos]

                if marker in ("-", "="):
                    pos = state.skipCharsStr(pos, marker)
                    pos = state.skipSpaces(pos)

                    # /* = */
                    if pos >= maximum:
                        level = 1 if marker == "=" else 2
                        break

        # quirk for blockquotes, this line should already be checked by that rule
        if state.sCount[nextLine] < 0:
            nextLine += 1
            continue

        # Some tags can terminate paragraph without empty line.
        terminate = False
        for terminatorRule in terminatorRules:
            if terminatorRule(state, nextLine, endLine, True):
                terminate = True
                break
        if terminate:
            break

        nextLine += 1

    if not level:
        # Didn't find valid underline
        return False

    content = state.getLines(startLine, nextLine, state.blkIndent, False).strip()

    state.line = nextLine + 1

    token = state.push("heading_open", "h" + str(level), 1)
    token.markup = marker
    token.map = [startLine, state.line]

    token = state.push("inline", "", 0)
    token.content = content
    token.map = [startLine, state.line - 1]
    token.children = []

    token = state.push("heading_close", "h" + str(level), -1)
    token.markup = marker

    state.parentType = oldParentType

    return True
markdown-it-py-4.2.0/markdown_it/rules_block/list.py000066400000000000000000000274071517710005200225560ustar00rootroot00000000000000# Lists
import logging

from ..common.utils import isStrSpace
from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


# Search `[-+*][\n ]`, returns next pos after marker on success
# or -1 on fail.
def skipBulletListMarker(state: StateBlock, startLine: int) -> int:
    pos = state.bMarks[startLine] + state.tShift[startLine]
    maximum = state.eMarks[startLine]

    try:
        marker = state.src[pos]
    except IndexError:
        return -1
    pos += 1

    if marker not in ("*", "-", "+"):
        return -1

    if pos < maximum:
        ch = state.src[pos]

        if not isStrSpace(ch):
            # " -test " - is not a list item
            return -1

    return pos


# Search `\d+[.)][\n ]`, returns next pos after marker on success
# or -1 on fail.
def skipOrderedListMarker(state: StateBlock, startLine: int) -> int:
    start = state.bMarks[startLine] + state.tShift[startLine]
    pos = start
    maximum = state.eMarks[startLine]

    # List marker should have at least 2 chars (digit + dot)
    if pos + 1 >= maximum:
        return -1

    ch = state.src[pos]
    pos += 1

    ch_ord = ord(ch)
    # /* 0 */  /* 9 */
    if ch_ord < 0x30 or ch_ord > 0x39:
        return -1

    while True:
        # EOL -> fail
        if pos >= maximum:
            return -1

        ch = state.src[pos]
        pos += 1

        # /* 0 */  /* 9 */
        ch_ord = ord(ch)
        if ch_ord >= 0x30 and ch_ord <= 0x39:
            # List marker should have no more than 9 digits
            # (prevents integer overflow in browsers)
            if pos - start >= 10:
                return -1

            continue

        # found valid marker
        if ch in (")", "."):
            break

        return -1

    if pos < maximum:
        ch = state.src[pos]

        if not isStrSpace(ch):
            # " 1.test " - is not a list item
            return -1

    return pos


def markTightParagraphs(state: StateBlock, idx: int) -> None:
    level = state.level + 2

    i = idx + 2
    length = len(state.tokens) - 2
    while i < length:
        if state.tokens[i].level == level and state.tokens[i].type == "paragraph_open":
            state.tokens[i + 2].hidden = True
            state.tokens[i].hidden = True
            i += 2
        i += 1


def list_block(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug("entering list: %s, %s, %s, %s", state, startLine, endLine, silent)

    isTerminatingParagraph = False
    tight = True

    if state.is_code_block(startLine):
        return False

    # Special case:
    #  - item 1
    #   - item 2
    #    - item 3
    #     - item 4
    #      - this one is a paragraph continuation
    if (
        state.listIndent >= 0
        and state.sCount[startLine] - state.listIndent >= 4
        and state.sCount[startLine] < state.blkIndent
    ):
        return False

    # limit conditions when list can interrupt
    # a paragraph (validation mode only)
    # Next list item should still terminate previous list item
    #
    # This code can fail if plugins use blkIndent as well as lists,
    # but I hope the spec gets fixed long before that happens.
    #
    if (
        silent
        and state.parentType == "paragraph"
        and state.sCount[startLine] >= state.blkIndent
    ):
        isTerminatingParagraph = True

    # Detect list type and position after marker
    posAfterMarker = skipOrderedListMarker(state, startLine)
    if posAfterMarker >= 0:
        isOrdered = True
        start = state.bMarks[startLine] + state.tShift[startLine]
        markerValue = int(state.src[start : posAfterMarker - 1])

        # If we're starting a new ordered list right after
        # a paragraph, it should start with 1.
        if isTerminatingParagraph and markerValue != 1:
            return False
    else:
        posAfterMarker = skipBulletListMarker(state, startLine)
        if posAfterMarker >= 0:
            isOrdered = False
        else:
            return False

    # If we're starting a new unordered list right after
    # a paragraph, first line should not be empty.
    if (
        isTerminatingParagraph
        and state.skipSpaces(posAfterMarker) >= state.eMarks[startLine]
    ):
        return False

    # We should terminate list on style change. Remember first one to compare.
    markerChar = state.src[posAfterMarker - 1]

    # For validation mode we can terminate immediately
    if silent:
        return True

    # Start list
    listTokIdx = len(state.tokens)

    if isOrdered:
        token = state.push("ordered_list_open", "ol", 1)
        if markerValue != 1:
            token.attrs = {"start": markerValue}

    else:
        token = state.push("bullet_list_open", "ul", 1)

    token.map = listLines = [startLine, 0]
    token.markup = markerChar

    #
    # Iterate list items
    #

    nextLine = startLine
    prevEmptyEnd = False
    terminatorRules = state.md.block.ruler.getRules("list")

    oldParentType = state.parentType
    state.parentType = "list"

    while nextLine < endLine:
        pos = posAfterMarker
        maximum = state.eMarks[nextLine]

        initial = offset = (
            state.sCount[nextLine]
            + posAfterMarker
            - (state.bMarks[startLine] + state.tShift[startLine])
        )

        while pos < maximum:
            ch = state.src[pos]

            if ch == "\t":
                offset += 4 - (offset + state.bsCount[nextLine]) % 4
            elif ch == " ":
                offset += 1
            else:
                break

            pos += 1

        contentStart = pos

        # trimming space in "-    \n  3" case, indent is 1 here
        indentAfterMarker = 1 if contentStart >= maximum else offset - initial

        # If we have more than 4 spaces, the indent is 1
        # (the rest is just indented code block)
        if indentAfterMarker > 4:
            indentAfterMarker = 1

        # "  -  test"
        #  ^^^^^ - calculating total length of this thing
        indent = initial + indentAfterMarker

        # Run subparser & write tokens
        token = state.push("list_item_open", "li", 1)
        token.markup = markerChar
        token.map = itemLines = [startLine, 0]
        if isOrdered:
            token.info = state.src[start : posAfterMarker - 1]

        # Detect GFM task checkbox: `[ ] ` or `[x] `/`[X] ` at content start
        checkboxLen = 0
        if state.md.options.get("tasklists", False) and contentStart < maximum:
            checked = _detect_task_checkbox(state.src, contentStart, maximum)
            if checked is not None:
                token.meta = {"checked": checked}
                # Advance content past the checkbox: `[x]` (3 chars) + whitespace.
                # `_detect_task_checkbox` already guarantees a whitespace char at
                # pos+3, so we always consume 4 characters.
                checkboxLen = 4

        # change current state, then restore it after parser subcall
        oldTight = state.tight
        oldBMark = state.bMarks[startLine]
        oldTShift = state.tShift[startLine]
        oldSCount = state.sCount[startLine]

        #  - example list
        # ^ listIndent position will be here
        #   ^ blkIndent position will be here
        #
        oldListIndent = state.listIndent
        state.listIndent = state.blkIndent
        state.blkIndent = indent

        state.tight = True
        state.tShift[startLine] = contentStart - state.bMarks[startLine]
        state.sCount[startLine] = offset

        # If we detected a checkbox, advance bMarks past it so that
        # getLines() doesn't include the checkbox text in the content.
        if checkboxLen:
            state.bMarks[startLine] = contentStart + checkboxLen
            state.tShift[startLine] = 0

        if contentStart >= maximum and state.isEmpty(startLine + 1):
            # workaround for this case
            # (list item is empty, list terminates before "foo"):
            # ~~~~~~~~
            #   -
            #
            #     foo
            # ~~~~~~~~
            state.line = min(state.line + 2, endLine)
        else:
            # NOTE in list.js this was:
            # state.md.block.tokenize(state, startLine, endLine, True)
            # but  tokeniz does not take the final parameter
            state.md.block.tokenize(state, startLine, endLine)

        # If any of list item is tight, mark list as tight
        if (not state.tight) or prevEmptyEnd:
            tight = False

        # Item become loose if finish with empty line,
        # but we should filter last element, because it means list finish
        prevEmptyEnd = (state.line - startLine) > 1 and state.isEmpty(state.line - 1)

        state.blkIndent = state.listIndent
        state.listIndent = oldListIndent
        if checkboxLen:
            state.bMarks[startLine] = oldBMark
        state.tShift[startLine] = oldTShift
        state.sCount[startLine] = oldSCount
        state.tight = oldTight

        token = state.push("list_item_close", "li", -1)
        token.markup = markerChar

        nextLine = startLine = state.line
        itemLines[1] = nextLine

        if nextLine >= endLine:
            break

        contentStart = state.bMarks[startLine]

        #
        # Try to check if list is terminated or continued.
        #
        if state.sCount[nextLine] < state.blkIndent:
            break

        if state.is_code_block(startLine):
            break

        # fail if terminating block found
        terminate = False
        for terminatorRule in terminatorRules:
            if terminatorRule(state, nextLine, endLine, True):
                terminate = True
                break

        if terminate:
            break

        # fail if list has another type
        if isOrdered:
            posAfterMarker = skipOrderedListMarker(state, nextLine)
            if posAfterMarker < 0:
                break
            start = state.bMarks[nextLine] + state.tShift[nextLine]
        else:
            posAfterMarker = skipBulletListMarker(state, nextLine)
            if posAfterMarker < 0:
                break

        if markerChar != state.src[posAfterMarker - 1]:
            break

    # Finalize list

    # If any direct list item has a task checkbox, add class to the list
    if state.md.options.get("tasklists", False):
        containsTask = False
        level = state.tokens[listTokIdx].level
        for j in range(listTokIdx + 1, len(state.tokens)):
            tok = state.tokens[j]
            if (
                tok.level == level + 1
                and tok.type == "list_item_open"
                and tok.meta
                and "checked" in tok.meta
            ):
                tok.attrJoin("class", "task-list-item")
                containsTask = True
        if containsTask:
            state.tokens[listTokIdx].attrJoin("class", "contains-task-list")

    if isOrdered:
        token = state.push("ordered_list_close", "ol", -1)
    else:
        token = state.push("bullet_list_close", "ul", -1)

    token.markup = markerChar

    listLines[1] = nextLine
    state.line = nextLine

    state.parentType = oldParentType

    # mark paragraphs tight if needed
    if tight:
        markTightParagraphs(state, listTokIdx)

    return True


def _detect_task_checkbox(src: str, pos: int, maximum: int) -> bool | None:
    """Detect ``[ ]``, ``[x]``, or ``[X]`` at *pos*, followed by whitespace.

    Returns ``True`` (checked), ``False`` (unchecked), or ``None`` (no match).
    """
    # Need at least 4 chars: `[`, char, `]`, whitespace
    if pos + 4 > maximum:
        return None
    if src[pos] != "[":
        return None
    inner = src[pos + 1]
    if src[pos + 2] != "]":
        return None
    if inner == " ":
        checked = False
    elif inner in ("x", "X"):
        checked = True
    else:
        return None
    # After `]`, must have whitespace
    if src[pos + 3] not in (" ", "\t"):
        return None
    return checked
markdown-it-py-4.2.0/markdown_it/rules_block/paragraph.py000066400000000000000000000034331517710005200235410ustar00rootroot00000000000000"""Paragraph."""

import logging

from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def paragraph(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    LOGGER.debug(
        "entering paragraph: %s, %s, %s, %s", state, startLine, endLine, silent
    )

    nextLine = startLine + 1
    ruler = state.md.block.ruler
    terminatorRules = ruler.getRules("paragraph")
    endLine = state.lineMax

    oldParentType = state.parentType
    state.parentType = "paragraph"

    # jump line-by-line until empty one or EOF
    while nextLine < endLine:
        if state.isEmpty(nextLine):
            break
        # this would be a code block normally, but after paragraph
        # it's considered a lazy continuation regardless of what's there
        if state.sCount[nextLine] - state.blkIndent > 3:
            nextLine += 1
            continue

        # quirk for blockquotes, this line should already be checked by that rule
        if state.sCount[nextLine] < 0:
            nextLine += 1
            continue

        # Some tags can terminate paragraph without empty line.
        terminate = False
        for terminatorRule in terminatorRules:
            if terminatorRule(state, nextLine, endLine, True):
                terminate = True
                break

        if terminate:
            break

        nextLine += 1

    content = state.getLines(startLine, nextLine, state.blkIndent, False).strip()

    state.line = nextLine

    token = state.push("paragraph_open", "p", 1)
    token.map = [startLine, state.line]

    token = state.push("inline", "", 0)
    token.content = content
    token.map = [startLine, state.line]
    token.children = []

    token = state.push("paragraph_close", "p", -1)

    state.parentType = oldParentType

    return True
markdown-it-py-4.2.0/markdown_it/rules_block/reference.py000066400000000000000000000155071517710005200235370ustar00rootroot00000000000000import logging

from ..common.utils import charCodeAt, isSpace, normalizeReference
from .state_block import StateBlock

LOGGER = logging.getLogger(__name__)


def reference(state: StateBlock, startLine: int, _endLine: int, silent: bool) -> bool:
    LOGGER.debug(
        "entering reference: %s, %s, %s, %s", state, startLine, _endLine, silent
    )

    pos = state.bMarks[startLine] + state.tShift[startLine]
    maximum = state.eMarks[startLine]
    nextLine = startLine + 1

    if state.is_code_block(startLine):
        return False

    if state.src[pos] != "[":
        return False

    string = state.src[pos : maximum + 1]

    # string = state.getLines(startLine, nextLine, state.blkIndent, False).strip()
    maximum = len(string)

    labelEnd = None
    pos = 1
    while pos < maximum:
        ch = charCodeAt(string, pos)
        if ch == 0x5B:  # /* [ */
            return False
        elif ch == 0x5D:  # /* ] */
            labelEnd = pos
            break
        elif ch == 0x0A:  # /* \n */
            if (lineContent := getNextLine(state, nextLine)) is not None:
                string += lineContent
                maximum = len(string)
                nextLine += 1
        elif ch == 0x5C:  # /* \ */
            pos += 1
            if (
                pos < maximum
                and charCodeAt(string, pos) == 0x0A
                and (lineContent := getNextLine(state, nextLine)) is not None
            ):
                string += lineContent
                maximum = len(string)
                nextLine += 1
        pos += 1

    if (
        labelEnd is None or labelEnd < 0 or charCodeAt(string, labelEnd + 1) != 0x3A
    ):  # /* : */
        return False

    # [label]:   destination   'title'
    #         ^^^ skip optional whitespace here
    pos = labelEnd + 2
    while pos < maximum:
        ch = charCodeAt(string, pos)
        if ch == 0x0A:
            if (lineContent := getNextLine(state, nextLine)) is not None:
                string += lineContent
                maximum = len(string)
                nextLine += 1
        elif isSpace(ch):
            pass
        else:
            break
        pos += 1

    # [label]:   destination   'title'
    #            ^^^^^^^^^^^ parse this
    destRes = state.md.helpers.parseLinkDestination(string, pos, maximum)
    if not destRes.ok:
        return False

    href = state.md.normalizeLink(destRes.str)
    if not state.md.validateLink(href):
        return False

    pos = destRes.pos

    # save cursor state, we could require to rollback later
    destEndPos = pos
    destEndLineNo = nextLine

    # [label]:   destination   'title'
    #                       ^^^ skipping those spaces
    start = pos
    while pos < maximum:
        ch = charCodeAt(string, pos)
        if ch == 0x0A:
            if (lineContent := getNextLine(state, nextLine)) is not None:
                string += lineContent
                maximum = len(string)
                nextLine += 1
        elif isSpace(ch):
            pass
        else:
            break
        pos += 1

    # [label]:   destination   'title'
    #                          ^^^^^^^ parse this
    titleRes = state.md.helpers.parseLinkTitle(string, pos, maximum, None)
    while titleRes.can_continue:
        if (lineContent := getNextLine(state, nextLine)) is None:
            break
        string += lineContent
        pos = maximum
        maximum = len(string)
        nextLine += 1
        titleRes = state.md.helpers.parseLinkTitle(string, pos, maximum, titleRes)

    if pos < maximum and start != pos and titleRes.ok:
        title = titleRes.str
        pos = titleRes.pos
    else:
        title = ""
        pos = destEndPos
        nextLine = destEndLineNo

    # skip trailing spaces until the rest of the line
    while pos < maximum:
        ch = charCodeAt(string, pos)
        if not isSpace(ch):
            break
        pos += 1

    if pos < maximum and charCodeAt(string, pos) != 0x0A and title:
        # garbage at the end of the line after title,
        # but it could still be a valid reference if we roll back
        title = ""
        pos = destEndPos
        nextLine = destEndLineNo
        while pos < maximum:
            ch = charCodeAt(string, pos)
            if not isSpace(ch):
                break
            pos += 1

    if pos < maximum and charCodeAt(string, pos) != 0x0A:
        # garbage at the end of the line
        return False

    label = normalizeReference(string[1:labelEnd])
    if not label:
        # CommonMark 0.20 disallows empty labels
        return False

    # Reference can not terminate anything. This check is for safety only.
    if silent:
        return True

    if "references" not in state.env:
        state.env["references"] = {}

    state.line = nextLine

    # note, this is not part of markdown-it JS, but is useful for renderers
    if state.md.options.get("inline_definitions", False):
        token = state.push("definition", "", 0)
        token.meta = {
            "id": label,
            "title": title,
            "url": href,
            "label": string[1:labelEnd],
        }
        token.map = [startLine, state.line]

    if label not in state.env["references"]:
        state.env["references"][label] = {
            "title": title,
            "href": href,
            "map": [startLine, state.line],
        }
    else:
        state.env.setdefault("duplicate_refs", []).append(
            {
                "title": title,
                "href": href,
                "label": label,
                "map": [startLine, state.line],
            }
        )

    return True


def getNextLine(state: StateBlock, nextLine: int) -> None | str:
    endLine = state.lineMax

    if nextLine >= endLine or state.isEmpty(nextLine):
        # empty line or end of input
        return None

    isContinuation = False

    # this would be a code block normally, but after paragraph
    # it's considered a lazy continuation regardless of what's there
    if state.is_code_block(nextLine):
        isContinuation = True

    # quirk for blockquotes, this line should already be checked by that rule
    if state.sCount[nextLine] < 0:
        isContinuation = True

    if not isContinuation:
        terminatorRules = state.md.block.ruler.getRules("reference")
        oldParentType = state.parentType
        state.parentType = "reference"

        # Some tags can terminate paragraph without empty line.
        terminate = False
        for terminatorRule in terminatorRules:
            if terminatorRule(state, nextLine, endLine, True):
                terminate = True
                break

        state.parentType = oldParentType

        if terminate:
            # terminated by another block
            return None

    pos = state.bMarks[nextLine] + state.tShift[nextLine]
    maximum = state.eMarks[nextLine]

    # max + 1 explicitly includes the newline
    return state.src[pos : maximum + 1]
markdown-it-py-4.2.0/markdown_it/rules_block/state_block.py000066400000000000000000000203461517710005200240700ustar00rootroot00000000000000from __future__ import annotations

from typing import TYPE_CHECKING, Literal

from ..common.utils import isStrSpace
from ..ruler import StateBase
from ..token import Token
from ..utils import EnvType

if TYPE_CHECKING:
    from markdown_it.main import MarkdownIt


class StateBlock(StateBase):
    def __init__(
        self, src: str, md: MarkdownIt, env: EnvType, tokens: list[Token]
    ) -> None:
        self.src = src

        # link to parser instance
        self.md = md

        self.env = env

        #
        # Internal state variables
        #

        self.tokens = tokens

        self.bMarks: list[int] = []  # line begin offsets for fast jumps
        self.eMarks: list[int] = []  # line end offsets for fast jumps
        # offsets of the first non-space characters (tabs not expanded)
        self.tShift: list[int] = []
        self.sCount: list[int] = []  # indents for each line (tabs expanded)

        # An amount of virtual spaces (tabs expanded) between beginning
        # of each line (bMarks) and real beginning of that line.
        #
        # It exists only as a hack because blockquotes override bMarks
        # losing information in the process.
        #
        # It's used only when expanding tabs, you can think about it as
        # an initial tab length, e.g. bsCount=21 applied to string `\t123`
        # means first tab should be expanded to 4-21%4 === 3 spaces.
        #
        self.bsCount: list[int] = []

        # block parser variables
        self.blkIndent = 0  # required block content indent (for example, if we are
        # inside a list, it would be positioned after list marker)
        self.line = 0  # line index in src
        self.lineMax = 0  # lines count
        self.tight = False  # loose/tight mode for lists
        self.ddIndent = -1  # indent of the current dd block (-1 if there isn't any)
        self.listIndent = -1  # indent of the current list block (-1 if there isn't any)

        # can be 'blockquote', 'list', 'root', 'paragraph' or 'reference'
        # used in lists to determine if they interrupt a paragraph
        self.parentType = "root"

        self.level = 0

        # renderer
        self.result = ""

        # Create caches
        # Generate markers.
        indent_found = False

        start = pos = indent = offset = 0
        length = len(self.src)

        for pos, character in enumerate(self.src):
            if not indent_found:
                if isStrSpace(character):
                    indent += 1

                    if character == "\t":
                        offset += 4 - offset % 4
                    else:
                        offset += 1
                    continue
                else:
                    indent_found = True

            if character == "\n" or pos == length - 1:
                if character != "\n":
                    pos += 1
                self.bMarks.append(start)
                self.eMarks.append(pos)
                self.tShift.append(indent)
                self.sCount.append(offset)
                self.bsCount.append(0)

                indent_found = False
                indent = 0
                offset = 0
                start = pos + 1

        # Push fake entry to simplify cache bounds checks
        self.bMarks.append(length)
        self.eMarks.append(length)
        self.tShift.append(0)
        self.sCount.append(0)
        self.bsCount.append(0)

        self.lineMax = len(self.bMarks) - 1  # don't count last fake line

        # pre-check if code blocks are enabled, to speed up is_code_block method
        self._code_enabled = "code" in self.md["block"].ruler.get_active_rules()

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__name__}"
            f"(line={self.line},level={self.level},tokens={len(self.tokens)})"
        )

    def push(self, ttype: str, tag: str, nesting: Literal[-1, 0, 1]) -> Token:
        """Push new token to "stream"."""
        token = Token(ttype, tag, nesting)
        token.block = True
        if nesting < 0:
            self.level -= 1  # closing tag
        token.level = self.level
        if nesting > 0:
            self.level += 1  # opening tag
        self.tokens.append(token)
        return token

    def isEmpty(self, line: int) -> bool:
        """."""
        return (self.bMarks[line] + self.tShift[line]) >= self.eMarks[line]

    def skipEmptyLines(self, from_pos: int) -> int:
        """."""
        while from_pos < self.lineMax:
            try:
                if (self.bMarks[from_pos] + self.tShift[from_pos]) < self.eMarks[
                    from_pos
                ]:
                    break
            except IndexError:
                pass
            from_pos += 1
        return from_pos

    def skipSpaces(self, pos: int) -> int:
        """Skip spaces from given position."""
        while True:
            try:
                current = self.src[pos]
            except IndexError:
                break
            if not isStrSpace(current):
                break
            pos += 1
        return pos

    def skipSpacesBack(self, pos: int, minimum: int) -> int:
        """Skip spaces from given position in reverse."""
        if pos <= minimum:
            return pos
        while pos > minimum:
            pos -= 1
            if not isStrSpace(self.src[pos]):
                return pos + 1
        return pos

    def skipChars(self, pos: int, code: int) -> int:
        """Skip character code from given position."""
        while True:
            try:
                current = self.srcCharCode[pos]
            except IndexError:
                break
            if current != code:
                break
            pos += 1
        return pos

    def skipCharsStr(self, pos: int, ch: str) -> int:
        """Skip character string from given position."""
        while True:
            try:
                current = self.src[pos]
            except IndexError:
                break
            if current != ch:
                break
            pos += 1
        return pos

    def skipCharsBack(self, pos: int, code: int, minimum: int) -> int:
        """Skip character code reverse from given position - 1."""
        if pos <= minimum:
            return pos
        while pos > minimum:
            pos -= 1
            if code != self.srcCharCode[pos]:
                return pos + 1
        return pos

    def skipCharsStrBack(self, pos: int, ch: str, minimum: int) -> int:
        """Skip character string reverse from given position - 1."""
        if pos <= minimum:
            return pos
        while pos > minimum:
            pos -= 1
            if ch != self.src[pos]:
                return pos + 1
        return pos

    def getLines(self, begin: int, end: int, indent: int, keepLastLF: bool) -> str:
        """Cut lines range from source."""
        line = begin
        if begin >= end:
            return ""

        queue = [""] * (end - begin)

        i = 1
        while line < end:
            lineIndent = 0
            lineStart = first = self.bMarks[line]
            last = (
                self.eMarks[line] + 1
                if line + 1 < end or keepLastLF
                else self.eMarks[line]
            )

            while (first < last) and (lineIndent < indent):
                ch = self.src[first]
                if isStrSpace(ch):
                    if ch == "\t":
                        lineIndent += 4 - (lineIndent + self.bsCount[line]) % 4
                    else:
                        lineIndent += 1
                elif first - lineStart < self.tShift[line]:
                    lineIndent += 1
                else:
                    break
                first += 1

            if lineIndent > indent:
                # partially expanding tabs in code blocks, e.g '\t\tfoobar'
                # with indent=2 becomes '  \tfoobar'
                queue[i - 1] = (" " * (lineIndent - indent)) + self.src[first:last]
            else:
                queue[i - 1] = self.src[first:last]

            line += 1
            i += 1

        return "".join(queue)

    def is_code_block(self, line: int) -> bool:
        """Check if line is a code block,
        i.e. the code block rule is enabled and text is indented by more than 3 spaces.
        """
        return self._code_enabled and (self.sCount[line] - self.blkIndent) >= 4
markdown-it-py-4.2.0/markdown_it/rules_block/table.py000066400000000000000000000170021517710005200226600ustar00rootroot00000000000000# GFM table, https://github.github.com/gfm/#tables-extension-
from __future__ import annotations

import re

from ..common.utils import charStrAt, isStrSpace
from .state_block import StateBlock

headerLineRe = re.compile(r"^:?-+:?$")
enclosingPipesRe = re.compile(r"^\||\|$")

# Limit the amount of empty autocompleted cells in a table,
# see https://github.com/markdown-it/markdown-it/issues/1000,
# Both pulldown-cmark and commonmark-hs limit the number of cells this way to ~200k.
# We set it to 65k, which can expand user input by a factor of x370
# (256x256 square is 1.8kB expanded into 650kB).
MAX_AUTOCOMPLETED_CELLS = 0x10000


def getLine(state: StateBlock, line: int) -> str:
    pos = state.bMarks[line] + state.tShift[line]
    maximum = state.eMarks[line]

    # return state.src.substr(pos, max - pos)
    return state.src[pos:maximum]


def escapedSplit(string: str) -> list[str]:
    result: list[str] = []
    pos = 0
    max = len(string)
    isEscaped = False
    lastPos = 0
    current = ""
    ch = charStrAt(string, pos)

    while pos < max:
        if ch == "|":
            if not isEscaped:
                # pipe separating cells, '|'
                result.append(current + string[lastPos:pos])
                current = ""
                lastPos = pos + 1
            else:
                # escaped pipe, '\|'
                current += string[lastPos : pos - 1]
                lastPos = pos

        isEscaped = ch == "\\"
        pos += 1

        ch = charStrAt(string, pos)

    result.append(current + string[lastPos:])

    return result


def table(state: StateBlock, startLine: int, endLine: int, silent: bool) -> bool:
    tbodyLines = None

    # should have at least two lines
    if startLine + 2 > endLine:
        return False

    nextLine = startLine + 1

    if state.sCount[nextLine] < state.blkIndent:
        return False

    if state.is_code_block(nextLine):
        return False

    # first character of the second line should be '|', '-', ':',
    # and no other characters are allowed but spaces;
    # basically, this is the equivalent of /^[-:|][-:|\s]*$/ regexp

    pos = state.bMarks[nextLine] + state.tShift[nextLine]
    if pos >= state.eMarks[nextLine]:
        return False
    first_ch = state.src[pos]
    pos += 1
    if first_ch not in ("|", "-", ":"):
        return False

    if pos >= state.eMarks[nextLine]:
        return False
    second_ch = state.src[pos]
    pos += 1
    if second_ch not in ("|", "-", ":") and not isStrSpace(second_ch):
        return False

    # if first character is '-', then second character must not be a space
    # (due to parsing ambiguity with list)
    if first_ch == "-" and isStrSpace(second_ch):
        return False

    while pos < state.eMarks[nextLine]:
        ch = state.src[pos]

        if ch not in ("|", "-", ":") and not isStrSpace(ch):
            return False

        pos += 1

    lineText = getLine(state, startLine + 1)

    columns = lineText.split("|")
    aligns = []
    for i in range(len(columns)):
        t = columns[i].strip()
        if not t:
            # allow empty columns before and after table, but not in between columns;
            # e.g. allow ` |---| `, disallow ` ---||--- `
            if i == 0 or i == len(columns) - 1:
                continue
            else:
                return False

        if not headerLineRe.search(t):
            return False
        if charStrAt(t, len(t) - 1) == ":":
            aligns.append("center" if charStrAt(t, 0) == ":" else "right")
        elif charStrAt(t, 0) == ":":
            aligns.append("left")
        else:
            aligns.append("")

    lineText = getLine(state, startLine).strip()
    if "|" not in lineText:
        return False
    if state.is_code_block(startLine):
        return False
    columns = escapedSplit(lineText)
    if columns and columns[0] == "":
        columns.pop(0)
    if columns and columns[-1] == "":
        columns.pop()

    # header row will define an amount of columns in the entire table,
    # and align row should be exactly the same (the rest of the rows can differ)
    columnCount = len(columns)
    if columnCount == 0 or columnCount != len(aligns):
        return False

    if silent:
        return True

    oldParentType = state.parentType
    state.parentType = "table"

    # use 'blockquote' lists for termination because it's
    # the most similar to tables
    terminatorRules = state.md.block.ruler.getRules("blockquote")

    token = state.push("table_open", "table", 1)
    token.map = tableLines = [startLine, 0]

    token = state.push("thead_open", "thead", 1)
    token.map = [startLine, startLine + 1]

    token = state.push("tr_open", "tr", 1)
    token.map = [startLine, startLine + 1]

    for i in range(len(columns)):
        token = state.push("th_open", "th", 1)
        if aligns[i]:
            token.attrs = {"style": "text-align:" + aligns[i]}

        token = state.push("inline", "", 0)
        # note in markdown-it this map was removed in v12.0.0 however, we keep it,
        # since it is helpful to propagate to children tokens
        token.map = [startLine, startLine + 1]
        token.content = columns[i].strip()
        token.children = []

        token = state.push("th_close", "th", -1)

    token = state.push("tr_close", "tr", -1)
    token = state.push("thead_close", "thead", -1)

    autocompleted_cells = 0
    nextLine = startLine + 2
    while nextLine < endLine:
        if state.sCount[nextLine] < state.blkIndent:
            break

        terminate = False
        for i in range(len(terminatorRules)):
            if terminatorRules[i](state, nextLine, endLine, True):
                terminate = True
                break

        if terminate:
            break
        lineText = getLine(state, nextLine).strip()
        if not lineText:
            break
        if state.is_code_block(nextLine):
            break
        columns = escapedSplit(lineText)
        if columns and columns[0] == "":
            columns.pop(0)
        if columns and columns[-1] == "":
            columns.pop()

        # note: autocomplete count can be negative if user specifies more columns than header,
        # but that does not affect intended use (which is limiting expansion)
        autocompleted_cells += columnCount - len(columns)
        if autocompleted_cells > MAX_AUTOCOMPLETED_CELLS:
            break

        if nextLine == startLine + 2:
            token = state.push("tbody_open", "tbody", 1)
            token.map = tbodyLines = [startLine + 2, 0]

        token = state.push("tr_open", "tr", 1)
        token.map = [nextLine, nextLine + 1]

        for i in range(columnCount):
            token = state.push("td_open", "td", 1)
            if aligns[i]:
                token.attrs = {"style": "text-align:" + aligns[i]}

            token = state.push("inline", "", 0)
            # note in markdown-it this map was removed in v12.0.0 however, we keep it,
            # since it is helpful to propagate to children tokens
            token.map = [nextLine, nextLine + 1]
            try:
                token.content = columns[i].strip() if columns[i] else ""
            except IndexError:
                token.content = ""
            token.children = []

            token = state.push("td_close", "td", -1)

        token = state.push("tr_close", "tr", -1)

        nextLine += 1

    if tbodyLines:
        token = state.push("tbody_close", "tbody", -1)
        tbodyLines[1] = nextLine

    token = state.push("table_close", "table", -1)

    tableLines[1] = nextLine
    state.parentType = oldParentType
    state.line = nextLine
    return True
markdown-it-py-4.2.0/markdown_it/rules_core/000077500000000000000000000000001517710005200210555ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/rules_core/__init__.py000066400000000000000000000006121517710005200231650ustar00rootroot00000000000000__all__ = (
    "StateCore",
    "block",
    "inline",
    "linkify",
    "normalize",
    "replace",
    "smartquotes",
    "text_join",
)

from .block import block
from .inline import inline
from .linkify import linkify
from .normalize import normalize
from .replacements import replace
from .smartquotes import smartquotes
from .state_core import StateCore
from .text_join import text_join
markdown-it-py-4.2.0/markdown_it/rules_core/block.py000066400000000000000000000005641517710005200225260ustar00rootroot00000000000000from ..token import Token
from .state_core import StateCore


def block(state: StateCore) -> None:
    if state.inlineMode:
        token = Token("inline", "", 0)
        token.content = state.src
        token.map = [0, 1]
        token.children = []
        state.tokens.append(token)
    else:
        state.md.block.parse(state.src, state.md, state.env, state.tokens)
markdown-it-py-4.2.0/markdown_it/rules_core/inline.py000066400000000000000000000005051517710005200227050ustar00rootroot00000000000000from .state_core import StateCore


def inline(state: StateCore) -> None:
    """Parse inlines"""
    for token in state.tokens:
        if token.type == "inline":
            if token.children is None:
                token.children = []
            state.md.inline.parse(token.content, state.md, state.env, token.children)
markdown-it-py-4.2.0/markdown_it/rules_core/linkify.py000066400000000000000000000120251517710005200230740ustar00rootroot00000000000000from __future__ import annotations

import re
from typing import Protocol

from ..common.utils import arrayReplaceAt, isLinkClose, isLinkOpen
from ..token import Token
from .state_core import StateCore

HTTP_RE = re.compile(r"^http://")
MAILTO_RE = re.compile(r"^mailto:")
TEST_MAILTO_RE = re.compile(r"^mailto:", flags=re.IGNORECASE)


def linkify(state: StateCore) -> None:
    """Rule for identifying plain-text links."""
    if not state.md.options.linkify:
        return

    if not state.md.linkify:
        raise ModuleNotFoundError("Linkify enabled but not installed.")

    for inline_token in state.tokens:
        if inline_token.type != "inline" or not state.md.linkify.pretest(
            inline_token.content
        ):
            continue

        tokens = inline_token.children

        htmlLinkLevel = 0

        # We scan from the end, to keep position when new tags added.
        # Use reversed logic in links start/end match
        assert tokens is not None
        i = len(tokens)
        while i >= 1:
            i -= 1
            assert isinstance(tokens, list)
            currentToken = tokens[i]

            # Skip content of markdown links
            if currentToken.type == "link_close":
                i -= 1
                while (
                    tokens[i].level != currentToken.level
                    and tokens[i].type != "link_open"
                ):
                    i -= 1
                continue

            # Skip content of html tag links
            if currentToken.type == "html_inline":
                if isLinkOpen(currentToken.content) and htmlLinkLevel > 0:
                    htmlLinkLevel -= 1
                if isLinkClose(currentToken.content):
                    htmlLinkLevel += 1
            if htmlLinkLevel > 0:
                continue

            if currentToken.type == "text" and state.md.linkify.test(
                currentToken.content
            ):
                text = currentToken.content
                links: list[_LinkType] = state.md.linkify.match(text) or []

                # Now split string to nodes
                nodes = []
                level = currentToken.level
                lastPos = 0

                # forbid escape sequence at the start of the string,
                # this avoids http\://example.com/ from being linkified as
                # http://example.com/
                if (
                    links
                    and links[0].index == 0
                    and i > 0
                    and tokens[i - 1].type == "text_special"
                ):
                    links = links[1:]

                for link in links:
                    url = link.url
                    fullUrl = state.md.normalizeLink(url)
                    if not state.md.validateLink(fullUrl):
                        continue

                    urlText = link.text

                    # Linkifier might send raw hostnames like "example.com", where url
                    # starts with domain name. So we prepend http:// in those cases,
                    # and remove it afterwards.
                    if not link.schema:
                        urlText = HTTP_RE.sub(
                            "", state.md.normalizeLinkText("http://" + urlText)
                        )
                    elif link.schema == "mailto:" and TEST_MAILTO_RE.search(urlText):
                        urlText = MAILTO_RE.sub(
                            "", state.md.normalizeLinkText("mailto:" + urlText)
                        )
                    else:
                        urlText = state.md.normalizeLinkText(urlText)

                    pos = link.index

                    if pos > lastPos:
                        token = Token("text", "", 0)
                        token.content = text[lastPos:pos]
                        token.level = level
                        nodes.append(token)

                    token = Token("link_open", "a", 1)
                    token.attrs = {"href": fullUrl}
                    token.level = level
                    level += 1
                    token.markup = "linkify"
                    token.info = "auto"
                    nodes.append(token)

                    token = Token("text", "", 0)
                    token.content = urlText
                    token.level = level
                    nodes.append(token)

                    token = Token("link_close", "a", -1)
                    level -= 1
                    token.level = level
                    token.markup = "linkify"
                    token.info = "auto"
                    nodes.append(token)

                    lastPos = link.last_index

                if lastPos < len(text):
                    token = Token("text", "", 0)
                    token.content = text[lastPos:]
                    token.level = level
                    nodes.append(token)

                inline_token.children = tokens = arrayReplaceAt(tokens, i, nodes)


class _LinkType(Protocol):
    url: str
    text: str
    index: int
    last_index: int
    schema: str | None
markdown-it-py-4.2.0/markdown_it/rules_core/normalize.py000066400000000000000000000006231517710005200234300ustar00rootroot00000000000000"""Normalize input string."""

import re

from .state_core import StateCore

# https://spec.commonmark.org/0.29/#line-ending
NEWLINES_RE = re.compile(r"\r\n?|\n")
NULL_RE = re.compile(r"\0")


def normalize(state: StateCore) -> None:
    # Normalize newlines
    string = NEWLINES_RE.sub("\n", state.src)

    # Replace NULL characters
    string = NULL_RE.sub("\ufffd", string)

    state.src = string
markdown-it-py-4.2.0/markdown_it/rules_core/replacements.py000066400000000000000000000066171517710005200241230ustar00rootroot00000000000000"""Simple typographic replacements

* ``(c)``, ``(C)`` → ©
* ``(tm)``, ``(TM)`` → ™
* ``(r)``, ``(R)`` → ®
* ``+-`` → ±
* ``...`` → …
* ``?....`` → ?..
* ``!....`` → !..
* ``????????`` → ???
* ``!!!!!`` → !!!
* ``,,,`` → ,
* ``--`` → &ndash
* ``---`` → &mdash
"""

from __future__ import annotations

import logging
import re

from ..token import Token
from .state_core import StateCore

LOGGER = logging.getLogger(__name__)

# TODO:
# - fractionals 1/2, 1/4, 3/4 -> ½, ¼, ¾
# - multiplication 2 x 4 -> 2 × 4

RARE_RE = re.compile(r"\+-|\.\.|\?\?\?\?|!!!!|,,|--")

# Workaround for phantomjs - need regex without /g flag,
# or root check will fail every second time
# SCOPED_ABBR_TEST_RE = r"\((c|tm|r)\)"

SCOPED_ABBR_RE = re.compile(r"\((c|tm|r)\)", flags=re.IGNORECASE)

PLUS_MINUS_RE = re.compile(r"\+-")

ELLIPSIS_RE = re.compile(r"\.{2,}")

ELLIPSIS_QUESTION_EXCLAMATION_RE = re.compile(r"([?!])…")

QUESTION_EXCLAMATION_RE = re.compile(r"([?!]){4,}")

COMMA_RE = re.compile(r",{2,}")

EM_DASH_RE = re.compile(r"(^|[^-])---(?=[^-]|$)", flags=re.MULTILINE)

EN_DASH_RE = re.compile(r"(^|\s)--(?=\s|$)", flags=re.MULTILINE)

EN_DASH_INDENT_RE = re.compile(r"(^|[^-\s])--(?=[^-\s]|$)", flags=re.MULTILINE)


SCOPED_ABBR = {"c": "©", "r": "®", "tm": "™"}


def replaceFn(match: re.Match[str]) -> str:
    return SCOPED_ABBR[match.group(1).lower()]


def replace_scoped(inlineTokens: list[Token]) -> None:
    inside_autolink = 0

    for token in inlineTokens:
        if token.type == "text" and not inside_autolink:
            token.content = SCOPED_ABBR_RE.sub(replaceFn, token.content)

        if token.type == "link_open" and token.info == "auto":
            inside_autolink -= 1

        if token.type == "link_close" and token.info == "auto":
            inside_autolink += 1


def replace_rare(inlineTokens: list[Token]) -> None:
    inside_autolink = 0

    for token in inlineTokens:
        if (
            token.type == "text"
            and (not inside_autolink)
            and RARE_RE.search(token.content)
        ):
            # +- -> ±
            token.content = PLUS_MINUS_RE.sub("±", token.content)

            # .., ..., ....... -> …
            token.content = ELLIPSIS_RE.sub("…", token.content)

            # but ?..... & !..... -> ?.. & !..
            token.content = ELLIPSIS_QUESTION_EXCLAMATION_RE.sub("\\1..", token.content)
            token.content = QUESTION_EXCLAMATION_RE.sub("\\1\\1\\1", token.content)

            # ,,  ,,,  ,,,, -> ,
            token.content = COMMA_RE.sub(",", token.content)

            # em-dash
            token.content = EM_DASH_RE.sub("\\1\u2014", token.content)

            # en-dash
            token.content = EN_DASH_RE.sub("\\1\u2013", token.content)
            token.content = EN_DASH_INDENT_RE.sub("\\1\u2013", token.content)

        if token.type == "link_open" and token.info == "auto":
            inside_autolink -= 1

        if token.type == "link_close" and token.info == "auto":
            inside_autolink += 1


def replace(state: StateCore) -> None:
    if not state.md.options.typographer:
        return

    for token in state.tokens:
        if token.type != "inline":
            continue
        if token.children is None:
            continue

        if SCOPED_ABBR_RE.search(token.content):
            replace_scoped(token.children)

        if RARE_RE.search(token.content):
            replace_rare(token.children)
markdown-it-py-4.2.0/markdown_it/rules_core/smartquotes.py000066400000000000000000000164231517710005200240240ustar00rootroot00000000000000"""Convert straight quotation marks to typographic ones"""

from __future__ import annotations

import re
from typing import Any

from ..common.utils import charCodeAt, isMdAsciiPunct, isPunctChar, isWhiteSpace
from ..token import Token
from .state_core import StateCore

QUOTE_TEST_RE = re.compile(r"['\"]")
QUOTE_RE = re.compile(r"['\"]")
APOSTROPHE = "\u2019"  # ’


def replaceAt(string: str, index: int, ch: str) -> str:
    # When the index is negative, the behavior is different from the js version.
    # But basically, the index will not be negative.
    assert index >= 0
    return string[:index] + ch + string[index + 1 :]


def process_inlines(tokens: list[Token], state: StateCore) -> None:
    stack: list[dict[str, Any]] = []

    for i, token in enumerate(tokens):
        thisLevel = token.level

        j = 0
        for j in range(len(stack))[::-1]:
            if stack[j]["level"] <= thisLevel:
                break
        else:
            # When the loop is terminated without a "break".
            # Subtract 1 to get the same index as the js version.
            j -= 1

        stack = stack[: j + 1]

        if token.type != "text":
            continue

        text = token.content
        pos = 0
        maximum = len(text)

        while pos < maximum:
            goto_outer = False
            lastIndex = pos
            t = QUOTE_RE.search(text[lastIndex:])
            if not t:
                break

            canOpen = canClose = True
            pos = t.start(0) + lastIndex + 1
            isSingle = t.group(0) == "'"

            # Find previous character,
            # default to space if it's the beginning of the line
            lastChar: None | int = 0x20

            if t.start(0) + lastIndex - 1 >= 0:
                lastChar = charCodeAt(text, t.start(0) + lastIndex - 1)
            else:
                for j in range(i)[::-1]:
                    if tokens[j].type == "softbreak" or tokens[j].type == "hardbreak":
                        break
                    # should skip all tokens except 'text', 'html_inline' or 'code_inline'
                    if not tokens[j].content:
                        continue

                    lastChar = charCodeAt(tokens[j].content, len(tokens[j].content) - 1)
                    break

            # Find next character,
            # default to space if it's the end of the line
            nextChar: None | int = 0x20

            if pos < maximum:
                nextChar = charCodeAt(text, pos)
            else:
                for j in range(i + 1, len(tokens)):
                    # nextChar defaults to 0x20
                    if tokens[j].type == "softbreak" or tokens[j].type == "hardbreak":
                        break
                    # should skip all tokens except 'text', 'html_inline' or 'code_inline'
                    if not tokens[j].content:
                        continue

                    nextChar = charCodeAt(tokens[j].content, 0)
                    break

            isLastPunctChar = lastChar is not None and (
                isMdAsciiPunct(lastChar) or isPunctChar(chr(lastChar))
            )
            isNextPunctChar = nextChar is not None and (
                isMdAsciiPunct(nextChar) or isPunctChar(chr(nextChar))
            )

            isLastWhiteSpace = lastChar is not None and isWhiteSpace(lastChar)
            isNextWhiteSpace = nextChar is not None and isWhiteSpace(nextChar)

            if isNextWhiteSpace:  # noqa: SIM114
                canOpen = False
            elif isNextPunctChar and not (isLastWhiteSpace or isLastPunctChar):
                canOpen = False

            if isLastWhiteSpace:  # noqa: SIM114
                canClose = False
            elif isLastPunctChar and not (isNextWhiteSpace or isNextPunctChar):
                canClose = False

            if nextChar == 0x22 and t.group(0) == '"':  # 0x22: "  # noqa: SIM102
                if (
                    lastChar is not None and lastChar >= 0x30 and lastChar <= 0x39
                ):  # 0x30: 0, 0x39: 9
                    # special case: 1"" - count first quote as an inch
                    canClose = canOpen = False

            if canOpen and canClose:
                # Replace quotes in the middle of punctuation sequence, but not
                # in the middle of the words, i.e.:
                #
                # 1. foo " bar " baz - not replaced
                # 2. foo-"-bar-"-baz - replaced
                # 3. foo"bar"baz     - not replaced
                canOpen = isLastPunctChar
                canClose = isNextPunctChar

            if not canOpen and not canClose:
                # middle of word
                if isSingle:
                    token.content = replaceAt(
                        token.content, t.start(0) + lastIndex, APOSTROPHE
                    )
                continue

            if canClose:
                # this could be a closing quote, rewind the stack to get a match
                for j in range(len(stack))[::-1]:
                    item = stack[j]
                    if stack[j]["level"] < thisLevel:
                        break
                    if item["single"] == isSingle and stack[j]["level"] == thisLevel:
                        item = stack[j]

                        if isSingle:
                            openQuote = state.md.options.quotes[2]
                            closeQuote = state.md.options.quotes[3]
                        else:
                            openQuote = state.md.options.quotes[0]
                            closeQuote = state.md.options.quotes[1]

                        # replace token.content *before* tokens[item.token].content,
                        # because, if they are pointing at the same token, replaceAt
                        # could mess up indices when quote length != 1
                        token.content = replaceAt(
                            token.content, t.start(0) + lastIndex, closeQuote
                        )
                        tokens[item["token"]].content = replaceAt(
                            tokens[item["token"]].content, item["pos"], openQuote
                        )

                        pos += len(closeQuote) - 1
                        if item["token"] == i:
                            pos += len(openQuote) - 1

                        text = token.content
                        maximum = len(text)

                        stack = stack[:j]
                        goto_outer = True
                        break
                if goto_outer:
                    goto_outer = False
                    continue

            if canOpen:
                stack.append(
                    {
                        "token": i,
                        "pos": t.start(0) + lastIndex,
                        "single": isSingle,
                        "level": thisLevel,
                    }
                )
            elif canClose and isSingle:
                token.content = replaceAt(
                    token.content, t.start(0) + lastIndex, APOSTROPHE
                )


def smartquotes(state: StateCore) -> None:
    if not state.md.options.typographer:
        return

    for token in state.tokens:
        if token.type != "inline" or not QUOTE_RE.search(token.content):
            continue
        if token.children is not None:
            process_inlines(token.children, state)
markdown-it-py-4.2.0/markdown_it/rules_core/state_core.py000066400000000000000000000010721517710005200235570ustar00rootroot00000000000000from __future__ import annotations

from typing import TYPE_CHECKING

from ..ruler import StateBase
from ..token import Token
from ..utils import EnvType

if TYPE_CHECKING:
    from markdown_it import MarkdownIt


class StateCore(StateBase):
    def __init__(
        self,
        src: str,
        md: MarkdownIt,
        env: EnvType,
        tokens: list[Token] | None = None,
    ) -> None:
        self.src = src
        self.md = md  # link to parser instance
        self.env = env
        self.tokens: list[Token] = tokens or []
        self.inlineMode = False
markdown-it-py-4.2.0/markdown_it/rules_core/text_join.py000066400000000000000000000037161517710005200234410ustar00rootroot00000000000000"""Join raw text tokens with the rest of the text

This is set as a separate rule to provide an opportunity for plugins
to run text replacements after text join, but before escape join.

For example, `\\:)` shouldn't be replaced with an emoji.
"""

from __future__ import annotations

from ..token import Token
from .state_core import StateCore


def text_join(state: StateCore) -> None:
    """Join raw text for escape sequences (`text_special`) tokens with the rest of the text"""

    for inline_token in state.tokens[:]:
        if inline_token.type != "inline":
            continue

        # convert text_special to text and join all adjacent text nodes
        new_tokens: list[Token] = []
        children = inline_token.children or []
        i = 0
        while i < len(children):
            child_token = children[i]
            if child_token.type == "text_special":
                child_token.type = "text"
            if (
                child_token.type == "text"
                and new_tokens
                and new_tokens[-1].type == "text"
            ):
                # Collapse a run of adjacent text nodes in a single join, instead
                # of pairwise `a + b` concatenation. The pairwise form is O(L*k)
                # in the size of the run because each step rebuilds the growing
                # prefix; "".join is O(L).
                parts = [new_tokens[-1].content, child_token.content]
                i += 1
                while i < len(children):
                    next_token = children[i]
                    if next_token.type == "text_special":
                        next_token.type = "text"
                    if next_token.type != "text":
                        break
                    parts.append(next_token.content)
                    i += 1
                new_tokens[-1].content = "".join(parts)
            else:
                new_tokens.append(child_token)
                i += 1
        inline_token.children = new_tokens
markdown-it-py-4.2.0/markdown_it/rules_inline/000077500000000000000000000000001517710005200214035ustar00rootroot00000000000000markdown-it-py-4.2.0/markdown_it/rules_inline/__init__.py000066400000000000000000000012701517710005200235140ustar00rootroot00000000000000__all__ = (
    "StateInline",
    "autolink",
    "backtick",
    "emphasis",
    "entity",
    "escape",
    "fragments_join",
    "html_inline",
    "image",
    "link",
    "link_pairs",
    "linkify",
    "newline",
    "strikethrough",
    "text",
)
from . import emphasis, strikethrough
from .autolink import autolink
from .backticks import backtick
from .balance_pairs import link_pairs
from .entity import entity
from .escape import escape
from .fragments_join import fragments_join
from .html_inline import html_inline
from .image import image
from .link import link
from .linkify import linkify
from .newline import newline
from .state_inline import StateInline
from .text import text
markdown-it-py-4.2.0/markdown_it/rules_inline/autolink.py000066400000000000000000000040211517710005200236000ustar00rootroot00000000000000# Process autolinks ''
import re

from .state_inline import StateInline

EMAIL_RE = re.compile(
    r"^([a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*)$"
)
AUTOLINK_RE = re.compile(r"^([a-zA-Z][a-zA-Z0-9+.\-]{1,31}):([^<>\x00-\x20]*)$")


def autolink(state: StateInline, silent: bool) -> bool:
    pos = state.pos

    if state.src[pos] != "<":
        return False

    start = state.pos
    maximum = state.posMax

    while True:
        pos += 1
        if pos >= maximum:
            return False

        ch = state.src[pos]

        if ch == "<":
            return False
        if ch == ">":
            break

    url = state.src[start + 1 : pos]

    if AUTOLINK_RE.search(url) is not None:
        fullUrl = state.md.normalizeLink(url)
        if not state.md.validateLink(fullUrl):
            return False

        if not silent:
            token = state.push("link_open", "a", 1)
            token.attrs = {"href": fullUrl}
            token.markup = "autolink"
            token.info = "auto"

            token = state.push("text", "", 0)
            token.content = state.md.normalizeLinkText(url)

            token = state.push("link_close", "a", -1)
            token.markup = "autolink"
            token.info = "auto"

        state.pos += len(url) + 2
        return True

    if EMAIL_RE.search(url) is not None:
        fullUrl = state.md.normalizeLink("mailto:" + url)
        if not state.md.validateLink(fullUrl):
            return False

        if not silent:
            token = state.push("link_open", "a", 1)
            token.attrs = {"href": fullUrl}
            token.markup = "autolink"
            token.info = "auto"

            token = state.push("text", "", 0)
            token.content = state.md.normalizeLinkText(url)

            token = state.push("link_close", "a", -1)
            token.markup = "autolink"
            token.info = "auto"

        state.pos += len(url) + 2
        return True

    return False
markdown-it-py-4.2.0/markdown_it/rules_inline/backticks.py000066400000000000000000000037651517710005200237260ustar00rootroot00000000000000# Parse backticks
import re

from .state_inline import StateInline

regex = re.compile("^ (.+) $")


def backtick(state: StateInline, silent: bool) -> bool:
    pos = state.pos

    if state.src[pos] != "`":
        return False

    start = pos
    pos += 1
    maximum = state.posMax

    # scan marker length
    while pos < maximum and (state.src[pos] == "`"):
        pos += 1

    marker = state.src[start:pos]
    openerLength = len(marker)

    if state.backticksScanned and state.backticks.get(openerLength, 0) <= start:
        if not silent:
            state.pending += marker
        state.pos += openerLength
        return True

    matchStart = matchEnd = pos

    # Nothing found in the cache, scan until the end of the line (or until marker is found)
    while True:
        try:
            matchStart = state.src.index("`", matchEnd)
        except ValueError:
            break
        matchEnd = matchStart + 1

        # scan marker length
        while matchEnd < maximum and (state.src[matchEnd] == "`"):
            matchEnd += 1

        closerLength = matchEnd - matchStart

        if closerLength == openerLength:
            # Found matching closer length.
            if not silent:
                token = state.push("code_inline", "code", 0)
                token.markup = marker
                token.content = state.src[pos:matchStart].replace("\n", " ")
                if (
                    token.content.startswith(" ")
                    and token.content.endswith(" ")
                    and len(token.content.strip()) > 0
                ):
                    token.content = token.content[1:-1]
            state.pos = matchEnd
            return True

        # Some different length found, put it in cache as upper limit of where closer can be found
        state.backticks[closerLength] = matchStart

    # Scanned through the end, didn't find anything
    state.backticksScanned = True

    if not silent:
        state.pending += marker
    state.pos += openerLength
    return True
markdown-it-py-4.2.0/markdown_it/rules_inline/balance_pairs.py000066400000000000000000000113641517710005200245450ustar00rootroot00000000000000"""Balance paired characters (*, _, etc) in inline tokens."""

from __future__ import annotations

from .state_inline import Delimiter, StateInline


def processDelimiters(state: StateInline, delimiters: list[Delimiter]) -> None:
    """For each opening emphasis-like marker find a matching closing one."""
    if not delimiters:
        return

    openersBottom = {}
    maximum = len(delimiters)

    # headerIdx is the first delimiter of the current (where closer is) delimiter run
    headerIdx = 0
    lastTokenIdx = -2  # needs any value lower than -1
    jumps: list[int] = []
    closerIdx = 0
    while closerIdx < maximum:
        closer = delimiters[closerIdx]

        jumps.append(0)

        # markers belong to same delimiter run if:
        #  - they have adjacent tokens
        #  - AND markers are the same
        #
        if (
            delimiters[headerIdx].marker != closer.marker
            or lastTokenIdx != closer.token - 1
        ):
            headerIdx = closerIdx
        lastTokenIdx = closer.token

        # Length is only used for emphasis-specific "rule of 3",
        # if it's not defined (in strikethrough or 3rd party plugins),
        # we can default it to 0 to disable those checks.
        #
        closer.length = closer.length or 0

        if not closer.close:
            closerIdx += 1
            continue

        # Previously calculated lower bounds (previous fails)
        # for each marker, each delimiter length modulo 3,
        # and for whether this closer can be an opener;
        # https://github.com/commonmark/cmark/commit/34250e12ccebdc6372b8b49c44fab57c72443460
        if closer.marker not in openersBottom:
            openersBottom[closer.marker] = [-1, -1, -1, -1, -1, -1]

        minOpenerIdx = openersBottom[closer.marker][
            (3 if closer.open else 0) + (closer.length % 3)
        ]

        openerIdx = headerIdx - jumps[headerIdx] - 1

        newMinOpenerIdx = openerIdx

        while openerIdx > minOpenerIdx:
            opener = delimiters[openerIdx]

            if opener.marker != closer.marker:
                openerIdx -= jumps[openerIdx] + 1
                continue

            if opener.open and opener.end < 0:
                isOddMatch = False

                # from spec:
                #
                # If one of the delimiters can both open and close emphasis, then the
                # sum of the lengths of the delimiter runs containing the opening and
                # closing delimiters must not be a multiple of 3 unless both lengths
                # are multiples of 3.
                #
                if (
                    (opener.close or closer.open)
                    and ((opener.length + closer.length) % 3 == 0)
                    and (opener.length % 3 != 0 or closer.length % 3 != 0)
                ):
                    isOddMatch = True

                if not isOddMatch:
                    # If previous delimiter cannot be an opener, we can safely skip
                    # the entire sequence in future checks. This is required to make
                    # sure algorithm has linear complexity (see *_*_*_*_*_... case).
                    #
                    if openerIdx > 0 and not delimiters[openerIdx - 1].open:
                        lastJump = jumps[openerIdx - 1] + 1
                    else:
                        lastJump = 0

                    jumps[closerIdx] = closerIdx - openerIdx + lastJump
                    jumps[openerIdx] = lastJump

                    closer.open = False
                    opener.end = closerIdx
                    opener.close = False
                    newMinOpenerIdx = -1

                    # treat next token as start of run,
                    # it optimizes skips in **<...>**a**<...>** pathological case
                    lastTokenIdx = -2

                    break

            openerIdx -= jumps[openerIdx] + 1

        if newMinOpenerIdx != -1:
            # If match for this delimiter run failed, we want to set lower bound for
            # future lookups. This is required to make sure algorithm has linear
            # complexity.
            #
            # See details here:
            # https:#github.com/commonmark/cmark/issues/178#issuecomment-270417442
            #
            openersBottom[closer.marker][
                (3 if closer.open else 0) + ((closer.length or 0) % 3)
            ] = newMinOpenerIdx

        closerIdx += 1


def link_pairs(state: StateInline) -> None:
    tokens_meta = state.tokens_meta
    maximum = len(state.tokens_meta)

    processDelimiters(state, state.delimiters)

    curr = 0
    while curr < maximum:
        curr_meta = tokens_meta[curr]
        if curr_meta and "delimiters" in curr_meta:
            processDelimiters(state, curr_meta["delimiters"])
        curr += 1
markdown-it-py-4.2.0/markdown_it/rules_inline/emphasis.py000066400000000000000000000060631517710005200235730ustar00rootroot00000000000000# Process *this* and _that_
#
from __future__ import annotations

from .state_inline import Delimiter, StateInline


def tokenize(state: StateInline, silent: bool) -> bool:
    """Insert each marker as a separate text token, and add it to delimiter list"""
    start = state.pos
    marker = state.src[start]

    if silent:
        return False

    if marker not in ("_", "*"):
        return False

    scanned = state.scanDelims(state.pos, marker == "*")

    for _ in range(scanned.length):
        token = state.push("text", "", 0)
        token.content = marker
        state.delimiters.append(
            Delimiter(
                marker=ord(marker),
                length=scanned.length,
                token=len(state.tokens) - 1,
                end=-1,
                open=scanned.can_open,
                close=scanned.can_close,
            )
        )

    state.pos += scanned.length

    return True


def _postProcess(state: StateInline, delimiters: list[Delimiter]) -> None:
    i = len(delimiters) - 1
    while i >= 0:
        startDelim = delimiters[i]

        # /* _ */  /* * */
        if startDelim.marker != 0x5F and startDelim.marker != 0x2A:
            i -= 1
            continue

        # Process only opening markers
        if startDelim.end == -1:
            i -= 1
            continue

        endDelim = delimiters[startDelim.end]

        # If the previous delimiter has the same marker and is adjacent to this one,
        # merge those into one strong delimiter.
        #
        # `whatever` -> `whatever`
        #
        isStrong = (
            i > 0
            and delimiters[i - 1].end == startDelim.end + 1
            # check that first two markers match and adjacent
            and delimiters[i - 1].marker == startDelim.marker
            and delimiters[i - 1].token == startDelim.token - 1
            # check that last two markers are adjacent (we can safely assume they match)
            and delimiters[startDelim.end + 1].token == endDelim.token + 1
        )

        ch = chr(startDelim.marker)

        token = state.tokens[startDelim.token]
        token.type = "strong_open" if isStrong else "em_open"
        token.tag = "strong" if isStrong else "em"
        token.nesting = 1
        token.markup = ch + ch if isStrong else ch
        token.content = ""

        token = state.tokens[endDelim.token]
        token.type = "strong_close" if isStrong else "em_close"
        token.tag = "strong" if isStrong else "em"
        token.nesting = -1
        token.markup = ch + ch if isStrong else ch
        token.content = ""

        if isStrong:
            state.tokens[delimiters[i - 1].token].content = ""
            state.tokens[delimiters[startDelim.end + 1].token].content = ""
            i -= 1

        i -= 1


def postProcess(state: StateInline) -> None:
    """Walk through delimiter list and replace text tokens with tags."""
    _postProcess(state, state.delimiters)

    for token in state.tokens_meta:
        if token and "delimiters" in token:
            _postProcess(state, token["delimiters"])
markdown-it-py-4.2.0/markdown_it/rules_inline/entity.py000066400000000000000000000031631517710005200232740ustar00rootroot00000000000000# Process html entity - {, ¯, ", ...
import re

from ..common.entities import entities
from ..common.utils import fromCodePoint, isValidEntityCode
from .state_inline import StateInline

DIGITAL_RE = re.compile(r"^&#((?:x[a-f0-9]{1,6}|[0-9]{1,7}));", re.IGNORECASE)
NAMED_RE = re.compile(r"^&([a-z][a-z0-9]{1,31});", re.IGNORECASE)


def entity(state: StateInline, silent: bool) -> bool:
    pos = state.pos
    maximum = state.posMax

    if state.src[pos] != "&":
        return False

    if pos + 1 >= maximum:
        return False

    if state.src[pos + 1] == "#":
        if match := DIGITAL_RE.search(state.src[pos:]):
            if not silent:
                match1 = match.group(1)
                code = (
                    int(match1[1:], 16) if match1[0].lower() == "x" else int(match1, 10)
                )

                token = state.push("text_special", "", 0)
                token.content = (
                    fromCodePoint(code)
                    if isValidEntityCode(code)
                    else fromCodePoint(0xFFFD)
                )
                token.markup = match.group(0)
                token.info = "entity"

            state.pos += len(match.group(0))
            return True

    else:
        if (match := NAMED_RE.search(state.src[pos:])) and match.group(1) in entities:
            if not silent:
                token = state.push("text_special", "", 0)
                token.content = entities[match.group(1)]
                token.markup = match.group(0)
                token.info = "entity"

            state.pos += len(match.group(0))
            return True

    return False
markdown-it-py-4.2.0/markdown_it/rules_inline/escape.py000066400000000000000000000031731517710005200232210ustar00rootroot00000000000000"""
Process escaped chars and hardbreaks
"""

from ..common.utils import isStrSpace
from .state_inline import StateInline


def escape(state: StateInline, silent: bool) -> bool:
    """Process escaped chars and hardbreaks."""
    pos = state.pos
    maximum = state.posMax

    if state.src[pos] != "\\":
        return False

    pos += 1

    # '\' at the end of the inline block
    if pos >= maximum:
        return False

    ch1 = state.src[pos]
    ch1_ord = ord(ch1)
    if ch1 == "\n":
        if not silent:
            state.push("hardbreak", "br", 0)
        pos += 1
        # skip leading whitespaces from next line
        while pos < maximum:
            ch = state.src[pos]
            if not isStrSpace(ch):
                break
            pos += 1

        state.pos = pos
        return True

    escapedStr = state.src[pos]

    if ch1_ord >= 0xD800 and ch1_ord <= 0xDBFF and pos + 1 < maximum:
        ch2 = state.src[pos + 1]
        ch2_ord = ord(ch2)
        if ch2_ord >= 0xDC00 and ch2_ord <= 0xDFFF:
            escapedStr += ch2
            pos += 1

    origStr = "\\" + escapedStr

    if not silent:
        token = state.push("text_special", "", 0)
        token.content = escapedStr if ch1 in _ESCAPED else origStr
        token.markup = origStr
        token.info = "escape"

    state.pos = pos + 1
    return True


_ESCAPED = {
    "!",
    '"',
    "#",
    "$",
    "%",
    "&",
    "'",
    "(",
    ")",
    "*",
    "+",
    ",",
    "-",
    ".",
    "/",
    ":",
    ";",
    "<",
    "=",
    ">",
    "?",
    "@",
    "[",
    "\\",
    "]",
    "^",
    "_",
    "`",
    "{",
    "|",
    "}",
    "~",
}
markdown-it-py-4.2.0/markdown_it/rules_inline/fragments_join.py000066400000000000000000000037001517710005200247620ustar00rootroot00000000000000from .state_inline import StateInline


def fragments_join(state: StateInline) -> None:
    """
    Clean up tokens after emphasis and strikethrough postprocessing:
    merge adjacent text nodes into one and re-calculate all token levels

    This is necessary because initially emphasis delimiter markers (``*, _, ~``)
    are treated as their own separate text tokens. Then emphasis rule either
    leaves them as text (needed to merge with adjacent text) or turns them
    into opening/closing tags (which messes up levels inside).
    """
    level = 0
    maximum = len(state.tokens)

    curr = last = 0
    while curr < maximum:
        # re-calculate levels after emphasis/strikethrough turns some text nodes
        # into opening/closing tags
        if state.tokens[curr].nesting < 0:
            level -= 1  # closing tag
        state.tokens[curr].level = level
        if state.tokens[curr].nesting > 0:
            level += 1  # opening tag

        if (
            state.tokens[curr].type == "text"
            and curr + 1 < maximum
            and state.tokens[curr + 1].type == "text"
        ):
            # Collapse a run of adjacent text nodes in a single join, instead
            # of pairwise `a + b` concatenation. The pairwise form is O(L*k)
            # in the size of the run because each step rebuilds the growing
            # prefix; "".join is O(L).
            parts = [state.tokens[curr].content]
            curr += 1
            while curr < maximum and state.tokens[curr].type == "text":
                parts.append(state.tokens[curr].content)
                curr += 1
            merged = state.tokens[curr - 1]
            merged.content = "".join(parts)
            merged.level = level
            state.tokens[last] = merged
            last += 1
            continue

        if curr != last:
            state.tokens[last] = state.tokens[curr]
        last += 1
        curr += 1

    if curr != last:
        del state.tokens[last:]
markdown-it-py-4.2.0/markdown_it/rules_inline/html_inline.py000066400000000000000000000021521517710005200242570ustar00rootroot00000000000000# Process html tags
from ..common.html_re import HTML_TAG_RE
from ..common.utils import isLinkClose, isLinkOpen
from .state_inline import StateInline


def isLetter(ch: int) -> bool:
    lc = ch | 0x20  # to lower case
    # /* a */ and /* z */
    return (lc >= 0x61) and (lc <= 0x7A)


def html_inline(state: StateInline, silent: bool) -> bool:
    pos = state.pos

    if not state.md.options.get("html", None):
        return False

    # Check start
    maximum = state.posMax
    if state.src[pos] != "<" or pos + 2 >= maximum:
        return False

    # Quick fail on second char
    ch = state.src[pos + 1]
    if ch not in ("!", "?", "/") and not isLetter(ord(ch)):  # /* / */
        return False

    match = HTML_TAG_RE.search(state.src[pos:])
    if not match:
        return False

    if not silent:
        token = state.push("html_inline", "", 0)
        token.content = state.src[pos : pos + len(match.group(0))]

        if isLinkOpen(token.content):
            state.linkLevel += 1
        if isLinkClose(token.content):
            state.linkLevel -= 1

    state.pos += len(match.group(0))
    return True
markdown-it-py-4.2.0/markdown_it/rules_inline/image.py000066400000000000000000000100551517710005200230400ustar00rootroot00000000000000# Process ![image]( "title")
from __future__ import annotations

from ..common.utils import isStrSpace, normalizeReference
from ..token import Token
from .state_inline import StateInline


def image(state: StateInline, silent: bool) -> bool:
    label = None
    href = ""
    oldPos = state.pos
    max = state.posMax

    if state.src[state.pos] != "!":
        return False

    if state.pos + 1 < state.posMax and state.src[state.pos + 1] != "[":
        return False

    labelStart = state.pos + 2
    labelEnd = state.md.helpers.parseLinkLabel(state, state.pos + 1, False)

    # parser failed to find ']', so it's not a valid link
    if labelEnd < 0:
        return False

    pos = labelEnd + 1

    if pos < max and state.src[pos] == "(":
        #
        # Inline link
        #

        # [link](    "title"  )
        #        ^^ skipping these spaces
        pos += 1
        while pos < max:
            ch = state.src[pos]
            if not isStrSpace(ch) and ch != "\n":
                break
            pos += 1

        if pos >= max:
            return False

        # [link](    "title"  )
        #          ^^^^^^ parsing link destination
        start = pos
        res = state.md.helpers.parseLinkDestination(state.src, pos, state.posMax)
        if res.ok:
            href = state.md.normalizeLink(res.str)
            if state.md.validateLink(href):
                pos = res.pos
            else:
                href = ""

        # [link](    "title"  )
        #                ^^ skipping these spaces
        start = pos
        while pos < max:
            ch = state.src[pos]
            if not isStrSpace(ch) and ch != "\n":
                break
            pos += 1

        # [link](    "title"  )
        #                  ^^^^^^^ parsing link title
        res = state.md.helpers.parseLinkTitle(state.src, pos, state.posMax, None)
        if pos < max and start != pos and res.ok:
            title = res.str
            pos = res.pos

            # [link](    "title"  )
            #                         ^^ skipping these spaces
            while pos < max:
                ch = state.src[pos]
                if not isStrSpace(ch) and ch != "\n":
                    break
                pos += 1
        else:
            title = ""

        if pos >= max or state.src[pos] != ")":
            state.pos = oldPos
            return False

        pos += 1

    else:
        #
        # Link reference
        #
        if "references" not in state.env:
            return False

        # /* [ */
        if pos < max and state.src[pos] == "[":
            start = pos + 1
            pos = state.md.helpers.parseLinkLabel(state, pos)
            if pos >= 0:
                label = state.src[start:pos]
                pos += 1
            else:
                pos = labelEnd + 1
        else:
            pos = labelEnd + 1

        # covers label == '' and label == undefined
        # (collapsed reference link and shortcut reference link respectively)
        if not label:
            label = state.src[labelStart:labelEnd]

        label = normalizeReference(label)

        ref = state.env["references"].get(label, None)
        if not ref:
            state.pos = oldPos
            return False

        href = ref["href"]
        title = ref["title"]

    #
    # We found the end of the link, and know for a fact it's a valid link
    # so all that's left to do is to call tokenizer.
    #
    if not silent:
        content = state.src[labelStart:labelEnd]

        tokens: list[Token] = []
        state.md.inline.parse(content, state.md, state.env, tokens)

        token = state.push("image", "img", 0)
        token.attrs = {"src": href, "alt": ""}
        token.children = tokens or None
        token.content = content

        if title:
            token.attrSet("title", title)

        # note, this is not part of markdown-it JS, but is useful for renderers
        if label and state.md.options.get("store_labels", False):
            token.meta["label"] = label

    state.pos = pos
    state.posMax = max
    return True
markdown-it-py-4.2.0/markdown_it/rules_inline/link.py000066400000000000000000000102421517710005200227110ustar00rootroot00000000000000# Process [link]( "stuff")

from ..common.utils import isStrSpace, normalizeReference
from .state_inline import StateInline


def link(state: StateInline, silent: bool) -> bool:
    href = ""
    title = ""
    label = None
    oldPos = state.pos
    maximum = state.posMax
    start = state.pos
    parseReference = True

    if state.src[state.pos] != "[":
        return False

    labelStart = state.pos + 1
    labelEnd = state.md.helpers.parseLinkLabel(state, state.pos, True)

    # parser failed to find ']', so it's not a valid link
    if labelEnd < 0:
        return False

    pos = labelEnd + 1

    if pos < maximum and state.src[pos] == "(":
        #
        # Inline link
        #

        # might have found a valid shortcut link, disable reference parsing
        parseReference = False

        # [link](    "title"  )
        #        ^^ skipping these spaces
        pos += 1
        while pos < maximum:
            ch = state.src[pos]
            if not isStrSpace(ch) and ch != "\n":
                break
            pos += 1

        if pos >= maximum:
            return False

        # [link](    "title"  )
        #          ^^^^^^ parsing link destination
        start = pos
        res = state.md.helpers.parseLinkDestination(state.src, pos, state.posMax)
        if res.ok:
            href = state.md.normalizeLink(res.str)
            if state.md.validateLink(href):
                pos = res.pos
            else:
                href = ""

            # [link](    "title"  )
            #                ^^ skipping these spaces
            start = pos
            while pos < maximum:
                ch = state.src[pos]
                if not isStrSpace(ch) and ch != "\n":
                    break
                pos += 1

            # [link](    "title"  )
            #                  ^^^^^^^ parsing link title
            res = state.md.helpers.parseLinkTitle(state.src, pos, state.posMax)
            if pos < maximum and start != pos and res.ok:
                title = res.str
                pos = res.pos

                # [link](    "title"  )
                #                         ^^ skipping these spaces
                while pos < maximum:
                    ch = state.src[pos]
                    if not isStrSpace(ch) and ch != "\n":
                        break
                    pos += 1

        if pos >= maximum or state.src[pos] != ")":
            # parsing a valid shortcut link failed, fallback to reference
            parseReference = True

        pos += 1

    if parseReference:
        #
        # Link reference
        #
        if "references" not in state.env:
            return False

        if pos < maximum and state.src[pos] == "[":
            start = pos + 1
            pos = state.md.helpers.parseLinkLabel(state, pos)
            if pos >= 0:
                label = state.src[start:pos]
                pos += 1
            else:
                pos = labelEnd + 1

        else:
            pos = labelEnd + 1

        # covers label == '' and label == undefined
        # (collapsed reference link and shortcut reference link respectively)
        if not label:
            label = state.src[labelStart:labelEnd]

        label = normalizeReference(label)

        ref = state.env["references"].get(label, None)
        if not ref:
            state.pos = oldPos
            return False

        href = ref["href"]
        title = ref["title"]

    #
    # We found the end of the link, and know for a fact it's a valid link
    # so all that's left to do is to call tokenizer.
    #
    if not silent:
        state.pos = labelStart
        state.posMax = labelEnd

        token = state.push("link_open", "a", 1)
        token.attrs = {"href": href}

        if title:
            token.attrSet("title", title)

        # note, this is not part of markdown-it JS, but is useful for renderers
        if label and state.md.options.get("store_labels", False):
            token.meta["label"] = label

        state.linkLevel += 1
        state.md.inline.tokenize(state)
        state.linkLevel -= 1

        token = state.push("link_close", "a", -1)

    state.pos = pos
    state.posMax = maximum
    return True
markdown-it-py-4.2.0/markdown_it/rules_inline/linkify.py000066400000000000000000000032521517710005200234240ustar00rootroot00000000000000"""Process links like https://example.org/"""

import re

from .state_inline import StateInline

# RFC3986: scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
SCHEME_RE = re.compile(r"(?:^|[^a-z0-9.+-])([a-z][a-z0-9.+-]*)$", re.IGNORECASE)


def linkify(state: StateInline, silent: bool) -> bool:
    """Rule for identifying plain-text links."""
    if not state.md.options.linkify:
        return False
    if state.linkLevel > 0:
        return False
    if not state.md.linkify:
        raise ModuleNotFoundError("Linkify enabled but not installed.")

    pos = state.pos
    maximum = state.posMax

    if (
        (pos + 3) > maximum
        or state.src[pos] != ":"
        or state.src[pos + 1] != "/"
        or state.src[pos + 2] != "/"
    ):
        return False

    if not (match := SCHEME_RE.search(state.pending)):
        return False

    proto = match.group(1)
    if not (link := state.md.linkify.match_at_start(state.src[pos - len(proto) :])):
        return False
    url: str = link.url

    # disallow '*' at the end of the link (conflicts with emphasis)
    url = url.rstrip("*")

    full_url = state.md.normalizeLink(url)
    if not state.md.validateLink(full_url):
        return False

    if not silent:
        state.pending = state.pending[: -len(proto)]

        token = state.push("link_open", "a", 1)
        token.attrs = {"href": full_url}
        token.markup = "linkify"
        token.info = "auto"

        token = state.push("text", "", 0)
        token.content = state.md.normalizeLinkText(url)

        token = state.push("link_close", "a", -1)
        token.markup = "linkify"
        token.info = "auto"

    state.pos += len(url) - len(proto)
    return True
markdown-it-py-4.2.0/markdown_it/rules_inline/newline.py000066400000000000000000000024211517710005200234150ustar00rootroot00000000000000"""Proceess '\n'."""

from ..common.utils import charStrAt, isStrSpace
from .state_inline import StateInline


def newline(state: StateInline, silent: bool) -> bool:
    pos = state.pos

    if state.src[pos] != "\n":
        return False

    pmax = len(state.pending) - 1
    maximum = state.posMax

    # '  \n' -> hardbreak
    # Lookup in pending chars is bad practice! Don't copy to other rules!
    # Pending string is stored in concat mode, indexed lookups will cause
    # conversion to flat mode.
    if not silent:
        if pmax >= 0 and charStrAt(state.pending, pmax) == " ":
            if pmax >= 1 and charStrAt(state.pending, pmax - 1) == " ":
                # Find whitespaces tail of pending chars.
                ws = pmax - 1
                while ws >= 1 and charStrAt(state.pending, ws - 1) == " ":
                    ws -= 1
                state.pending = state.pending[:ws]

                state.push("hardbreak", "br", 0)
            else:
                state.pending = state.pending[:-1]
                state.push("softbreak", "br", 0)

        else:
            state.push("softbreak", "br", 0)

    pos += 1

    # skip heading spaces for next line
    while pos < maximum and isStrSpace(state.src[pos]):
        pos += 1

    state.pos = pos
    return True
markdown-it-py-4.2.0/markdown_it/rules_inline/state_inline.py000066400000000000000000000116011517710005200244320ustar00rootroot00000000000000from __future__ import annotations

from dataclasses import dataclass
from typing import TYPE_CHECKING, Any, Literal, NamedTuple

from ..common.utils import isMdAsciiPunct, isPunctChar, isWhiteSpace
from ..ruler import StateBase
from ..token import Token
from ..utils import EnvType

if TYPE_CHECKING:
    from markdown_it import MarkdownIt


@dataclass(slots=True)
class Delimiter:
    # Char code of the starting marker (number).
    marker: int

    # Total length of these series of delimiters.
    length: int

    # A position of the token this delimiter corresponds to.
    token: int

    # If this delimiter is matched as a valid opener, `end` will be
    # equal to its position, otherwise it's `-1`.
    end: int

    # Boolean flags that determine if this delimiter could open or close
    # an emphasis.
    open: bool
    close: bool

    level: bool | None = None


class Scanned(NamedTuple):
    can_open: bool
    can_close: bool
    length: int


class StateInline(StateBase):
    def __init__(
        self, src: str, md: MarkdownIt, env: EnvType, outTokens: list[Token]
    ) -> None:
        self.src = src
        self.env = env
        self.md = md
        self.tokens = outTokens
        self.tokens_meta: list[dict[str, Any] | None] = [None] * len(outTokens)

        self.pos = 0
        self.posMax = len(self.src)
        self.level = 0
        self.pending = ""
        self.pendingLevel = 0

        # Stores { start: end } pairs. Useful for backtrack
        # optimization of pairs parse (emphasis, strikes).
        self.cache: dict[int, int] = {}

        # List of emphasis-like delimiters for current tag
        self.delimiters: list[Delimiter] = []

        # Stack of delimiter lists for upper level tags
        self._prev_delimiters: list[list[Delimiter]] = []

        # backticklength => last seen position
        self.backticks: dict[int, int] = {}
        self.backticksScanned = False

        # Counter used to disable inline linkify-it execution
        # inside  and markdown links
        self.linkLevel = 0

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__name__}"
            f"(pos=[{self.pos} of {self.posMax}], token={len(self.tokens)})"
        )

    def pushPending(self) -> Token:
        token = Token("text", "", 0)
        token.content = self.pending
        token.level = self.pendingLevel
        self.tokens.append(token)
        self.pending = ""
        return token

    def push(self, ttype: str, tag: str, nesting: Literal[-1, 0, 1]) -> Token:
        """Push new token to "stream".
        If pending text exists - flush it as text token
        """
        if self.pending:
            self.pushPending()

        token = Token(ttype, tag, nesting)
        token_meta = None

        if nesting < 0:
            # closing tag
            self.level -= 1
            self.delimiters = self._prev_delimiters.pop()

        token.level = self.level

        if nesting > 0:
            # opening tag
            self.level += 1
            self._prev_delimiters.append(self.delimiters)
            self.delimiters = []
            token_meta = {"delimiters": self.delimiters}

        self.pendingLevel = self.level
        self.tokens.append(token)
        self.tokens_meta.append(token_meta)
        return token

    def scanDelims(self, start: int, canSplitWord: bool) -> Scanned:
        """
        Scan a sequence of emphasis-like markers, and determine whether
        it can start an emphasis sequence or end an emphasis sequence.

         - start - position to scan from (it should point at a valid marker);
         - canSplitWord - determine if these markers can be found inside a word

        """
        pos = start
        maximum = self.posMax
        marker = self.src[start]

        # treat beginning of the line as a whitespace
        lastChar = self.src[start - 1] if start > 0 else " "

        while pos < maximum and self.src[pos] == marker:
            pos += 1

        count = pos - start

        # treat end of the line as a whitespace
        nextChar = self.src[pos] if pos < maximum else " "

        isLastPunctChar = isMdAsciiPunct(ord(lastChar)) or isPunctChar(lastChar)
        isNextPunctChar = isMdAsciiPunct(ord(nextChar)) or isPunctChar(nextChar)

        isLastWhiteSpace = isWhiteSpace(ord(lastChar))
        isNextWhiteSpace = isWhiteSpace(ord(nextChar))

        left_flanking = not (
            isNextWhiteSpace
            or (isNextPunctChar and not (isLastWhiteSpace or isLastPunctChar))
        )
        right_flanking = not (
            isLastWhiteSpace
            or (isLastPunctChar and not (isNextWhiteSpace or isNextPunctChar))
        )

        can_open = left_flanking and (
            canSplitWord or (not right_flanking) or isLastPunctChar
        )
        can_close = right_flanking and (
            canSplitWord or (not left_flanking) or isNextPunctChar
        )

        return Scanned(can_open, can_close, count)
markdown-it-py-4.2.0/markdown_it/rules_inline/strikethrough.py000066400000000000000000000120631517710005200246610ustar00rootroot00000000000000# ~~strike through~~ (and optionally ~single tilde~)
from __future__ import annotations

from .state_inline import Delimiter, StateInline


def tokenize(state: StateInline, silent: bool) -> bool:
    """Insert each marker as a separate text token, and add it to delimiter list.

    When the ``strikethrough_single_tilde`` option is enabled on the
    ``MarkdownIt`` instance, single ``~`` delimiters are also accepted and
    runs of three or more tildes are rejected (matching GitHub's rendering behaviour).
    """
    start = state.pos
    ch = state.src[start]

    if silent:
        return False

    if ch != "~":
        return False

    scanned = state.scanDelims(state.pos, True)
    length = scanned.length

    single_tilde = state.md.options.get("strikethrough_single_tilde", False)

    if single_tilde:
        # GitHub mode: only accept exactly 1 or 2 tildes.
        if length < 1:
            return False
        if length > 2:
            # Consume 3+ tildes as plain text so the parser doesn't
            # re-enter and match a subset of them.  This intentionally
            # matches GitHub's rendering, where ≥3 tildes are literal text.
            token = state.push("text", "", 0)
            token.content = ch * length
            state.pos += scanned.length
            return True

        token = state.push("text", "", 0)
        token.content = ch * length
        state.delimiters.append(
            Delimiter(
                marker=ord(ch),
                length=0,  # disable "rule of 3" length checks
                token=len(state.tokens) - 1,
                end=-1,
                open=scanned.can_open,
                close=scanned.can_close,
            )
        )
    else:
        # Original markdown-it behaviour: minimum 2, split odd runs.
        if length < 2:
            return False

        if length % 2:
            token = state.push("text", "", 0)
            token.content = ch
            length -= 1

        i = 0
        while i < length:
            token = state.push("text", "", 0)
            token.content = ch + ch
            state.delimiters.append(
                Delimiter(
                    marker=ord(ch),
                    length=0,  # disable "rule of 3" length checks
                    token=len(state.tokens) - 1,
                    end=-1,
                    open=scanned.can_open,
                    close=scanned.can_close,
                )
            )

            i += 2

    state.pos += scanned.length

    return True


def _postProcess(state: StateInline, delimiters: list[Delimiter]) -> None:
    loneMarkers = []
    maximum = len(delimiters)
    single_tilde = state.md.options.get("strikethrough_single_tilde", False)

    i = 0
    while i < maximum:
        startDelim = delimiters[i]

        if startDelim.marker != 0x7E:  # /* ~ */
            i += 1
            continue

        if startDelim.end == -1:
            i += 1
            continue

        endDelim = delimiters[startDelim.end]

        # In single-tilde mode, opener and closer must have the same width
        # (both `~` or both `~~`).  The width is stored in the text token.
        if single_tilde:
            opener_content = state.tokens[startDelim.token].content
            closer_content = state.tokens[endDelim.token].content
            if opener_content != closer_content:
                i += 1
                continue

        markup = state.tokens[startDelim.token].content

        token = state.tokens[startDelim.token]
        token.type = "s_open"
        token.tag = "s"
        token.nesting = 1
        token.markup = markup
        token.content = ""

        token = state.tokens[endDelim.token]
        token.type = "s_close"
        token.tag = "s"
        token.nesting = -1
        token.markup = markup
        token.content = ""

        if (
            state.tokens[endDelim.token - 1].type == "text"
            and state.tokens[endDelim.token - 1].content == "~"
        ):
            loneMarkers.append(endDelim.token - 1)

        i += 1

    # If a marker sequence has an odd number of characters, it's split
    # like this: `~~~~~` -> `~` + `~~` + `~~`, leaving one marker at the
    # start of the sequence.
    #
    # So, we have to move all those markers after subsequent s_close tags.
    #
    while loneMarkers:
        i = loneMarkers.pop()
        j = i + 1

        while (j < len(state.tokens)) and (state.tokens[j].type == "s_close"):
            j += 1

        j -= 1

        if i != j:
            token = state.tokens[j]
            state.tokens[j] = state.tokens[i]
            state.tokens[i] = token


def postProcess(state: StateInline) -> None:
    """Walk through delimiter list and replace text tokens with tags."""
    tokens_meta = state.tokens_meta
    maximum = len(state.tokens_meta)
    _postProcess(state, state.delimiters)

    curr = 0
    while curr < maximum:
        try:
            curr_meta = tokens_meta[curr]
        except IndexError:
            pass
        else:
            if curr_meta and "delimiters" in curr_meta:
                _postProcess(state, curr_meta["delimiters"])
        curr += 1
markdown-it-py-4.2.0/markdown_it/rules_inline/text.py000066400000000000000000000010571517710005200227440ustar00rootroot00000000000000# Skip text characters for text token, place those to pending buffer
# and increment current pos
from .state_inline import StateInline

# Rule to skip pure text


def text(state: StateInline, silent: bool) -> bool:
    pos = state.pos
    posMax = state.posMax

    terminator_char = state.md.inline.terminator_re.search(state.src, pos)
    pos = terminator_char.start() if terminator_char else posMax

    if pos == state.pos:
        return False

    if not silent:
        state.pending += state.src[state.pos : pos]

    state.pos = pos

    return True
markdown-it-py-4.2.0/markdown_it/token.py000066400000000000000000000143551517710005200204150ustar00rootroot00000000000000from __future__ import annotations

from collections.abc import Callable, MutableMapping
import dataclasses as dc
from typing import Any, Literal
import warnings


def convert_attrs(value: Any) -> Any:
    """Convert Token.attrs set as ``None`` or ``[[key, value], ...]`` to a dict.

    This improves compatibility with upstream markdown-it.
    """
    if not value:
        return {}
    if isinstance(value, list):
        return dict(value)
    return value


@dc.dataclass(slots=True)
class Token:
    type: str
    """Type of the token (string, e.g. "paragraph_open")"""

    tag: str
    """HTML tag name, e.g. 'p'"""

    nesting: Literal[-1, 0, 1]
    """Level change (number in {-1, 0, 1} set), where:
    -  `1` means the tag is opening
    -  `0` means the tag is self-closing
    - `-1` means the tag is closing
    """

    attrs: dict[str, str | int | float] = dc.field(default_factory=dict)
    """HTML attributes.
    Note this differs from the upstream "list of lists" format,
    although than an instance can still be initialised with this format.
    """

    map: list[int] | None = None
    """Source map info. Format: `[ line_begin, line_end ]`"""

    level: int = 0
    """Nesting level, the same as `state.level`"""

    children: list[Token] | None = None
    """Array of child nodes (inline and img tokens)."""

    content: str = ""
    """Inner content, in the case of a self-closing tag (code, html, fence, etc.),"""

    markup: str = ""
    """'*' or '_' for emphasis, fence string for fence, etc."""

    info: str = ""
    """Additional information:
    - Info string for "fence" tokens
    - The value "auto" for autolink "link_open" and "link_close" tokens
    - The string value of the item marker for ordered-list "list_item_open" tokens
    """

    meta: dict[Any, Any] = dc.field(default_factory=dict)
    """A place for plugins to store any arbitrary data"""

    block: bool = False
    """True for block-level tokens, false for inline tokens.
    Used in renderer to calculate line breaks
    """

    hidden: bool = False
    """If true, ignore this element when rendering.
    Used for tight lists to hide paragraphs.
    """

    def __post_init__(self) -> None:
        self.attrs = convert_attrs(self.attrs)

    def attrIndex(self, name: str) -> int:
        warnings.warn(  # noqa: B028
            "Token.attrIndex should not be used, since Token.attrs is a dictionary",
            UserWarning,
        )
        if name not in self.attrs:
            return -1
        return list(self.attrs.keys()).index(name)

    def attrItems(self) -> list[tuple[str, str | int | float]]:
        """Get (key, value) list of attrs."""
        return list(self.attrs.items())

    def attrPush(self, attrData: tuple[str, str | int | float]) -> None:
        """Add `[ name, value ]` attribute to list. Init attrs if necessary."""
        name, value = attrData
        self.attrSet(name, value)

    def attrSet(self, name: str, value: str | int | float) -> None:
        """Set `name` attribute to `value`. Override old value if exists."""
        self.attrs[name] = value

    def attrGet(self, name: str) -> None | str | int | float:
        """Get the value of attribute `name`, or null if it does not exist."""
        return self.attrs.get(name, None)

    def attrJoin(self, name: str, value: str) -> None:
        """Join value to existing attribute via space.
        Or create new attribute if not exists.
        Useful to operate with token classes.
        """
        if name in self.attrs:
            current = self.attrs[name]
            if not isinstance(current, str):
                raise TypeError(
                    f"existing attr 'name' is not a str: {self.attrs[name]}"
                )
            self.attrs[name] = f"{current} {value}"
        else:
            self.attrs[name] = value

    def copy(self, **changes: Any) -> Token:
        """Return a shallow copy of the instance."""
        return dc.replace(self, **changes)

    def as_dict(
        self,
        *,
        children: bool = True,
        as_upstream: bool = True,
        meta_serializer: Callable[[dict[Any, Any]], Any] | None = None,
        filter: Callable[[str, Any], bool] | None = None,
        dict_factory: Callable[..., MutableMapping[str, Any]] = dict,
    ) -> MutableMapping[str, Any]:
        """Return the token as a dictionary.

        :param children: Also convert children to dicts
        :param as_upstream: Ensure the output dictionary is equal to that created by markdown-it
            For example, attrs are converted to null or lists
        :param meta_serializer: hook for serializing ``Token.meta``
        :param filter: A callable whose return code determines whether an
            attribute or element is included (``True``) or dropped (``False``).
            Is called with the (key, value) pair.
        :param dict_factory: A callable to produce dictionaries from.
            For example, to produce ordered dictionaries instead of normal Python
            dictionaries, pass in ``collections.OrderedDict``.

        """
        mapping = dict_factory((f.name, getattr(self, f.name)) for f in dc.fields(self))
        if filter:
            mapping = dict_factory((k, v) for k, v in mapping.items() if filter(k, v))
        if as_upstream and "attrs" in mapping:
            mapping["attrs"] = (
                None
                if not mapping["attrs"]
                else [[k, v] for k, v in mapping["attrs"].items()]
            )
        if meta_serializer and "meta" in mapping:
            mapping["meta"] = meta_serializer(mapping["meta"])
        if children and mapping.get("children", None):
            mapping["children"] = [
                child.as_dict(
                    children=children,
                    filter=filter,
                    dict_factory=dict_factory,
                    as_upstream=as_upstream,
                    meta_serializer=meta_serializer,
                )
                for child in mapping["children"]
            ]
        return mapping

    @classmethod
    def from_dict(cls, dct: MutableMapping[str, Any]) -> Token:
        """Convert a dict to a Token."""
        token = cls(**dct)
        if token.children:
            token.children = [cls.from_dict(c) for c in token.children]  # type: ignore[arg-type]
        return token
markdown-it-py-4.2.0/markdown_it/tree.py000066400000000000000000000255461517710005200202400ustar00rootroot00000000000000"""A tree representation of a linear markdown-it token stream.

This module is not part of upstream JavaScript markdown-it.
"""

from __future__ import annotations

from collections.abc import Generator, Sequence
import textwrap
from typing import Any, NamedTuple, TypeVar, overload

from .token import Token


class _NesterTokens(NamedTuple):
    opening: Token
    closing: Token


_NodeType = TypeVar("_NodeType", bound="SyntaxTreeNode")


class SyntaxTreeNode:
    """A Markdown syntax tree node.

    A class that can be used to construct a tree representation of a linear
    `markdown-it-py` token stream.

    Each node in the tree represents either:
      - root of the Markdown document
      - a single unnested `Token`
      - a `Token` "_open" and "_close" token pair, and the tokens nested in
          between
    """

    def __init__(
        self, tokens: Sequence[Token] = (), *, create_root: bool = True
    ) -> None:
        """Initialize a `SyntaxTreeNode` from a token stream.

        If `create_root` is True, create a root node for the document.
        """
        # Only nodes representing an unnested token have self.token
        self.token: Token | None = None

        # Only containers have nester tokens
        self.nester_tokens: _NesterTokens | None = None

        # Root node does not have self.parent
        self._parent: Any = None

        # Empty list unless a non-empty container, or unnested token that has
        # children (i.e. inline or img)
        self._children: list[Any] = []

        if create_root:
            self._set_children_from_tokens(tokens)
            return

        if not tokens:
            raise ValueError(
                "Can only create root from empty token sequence."
                " Set `create_root=True`."
            )
        elif len(tokens) == 1:
            inline_token = tokens[0]
            if inline_token.nesting:
                raise ValueError(
                    "Unequal nesting level at the start and end of token stream."
                )
            self.token = inline_token
            if inline_token.children:
                self._set_children_from_tokens(inline_token.children)
        else:
            self.nester_tokens = _NesterTokens(tokens[0], tokens[-1])
            self._set_children_from_tokens(tokens[1:-1])

    def __repr__(self) -> str:
        return f"{type(self).__name__}({self.type})"

    @overload
    def __getitem__(self: _NodeType, item: int) -> _NodeType: ...

    @overload
    def __getitem__(self: _NodeType, item: slice) -> list[_NodeType]: ...

    def __getitem__(self: _NodeType, item: int | slice) -> _NodeType | list[_NodeType]:
        return self.children[item]

    def to_tokens(self: _NodeType) -> list[Token]:
        """Recover the linear token stream."""

        def recursive_collect_tokens(node: _NodeType, token_list: list[Token]) -> None:
            if node.type == "root":
                for child in node.children:
                    recursive_collect_tokens(child, token_list)
            elif node.token:
                token_list.append(node.token)
            else:
                assert node.nester_tokens
                token_list.append(node.nester_tokens.opening)
                for child in node.children:
                    recursive_collect_tokens(child, token_list)
                token_list.append(node.nester_tokens.closing)

        tokens: list[Token] = []
        recursive_collect_tokens(self, tokens)
        return tokens

    @property
    def children(self: _NodeType) -> list[_NodeType]:
        return self._children

    @children.setter
    def children(self: _NodeType, value: list[_NodeType]) -> None:
        self._children = value

    @property
    def parent(self: _NodeType) -> _NodeType | None:
        return self._parent  # type: ignore

    @parent.setter
    def parent(self: _NodeType, value: _NodeType | None) -> None:
        self._parent = value

    @property
    def is_root(self) -> bool:
        """Is the node a special root node?"""
        return not (self.token or self.nester_tokens)

    @property
    def is_nested(self) -> bool:
        """Is this node nested?.

        Returns `True` if the node represents a `Token` pair and tokens in the
        sequence between them, where `Token.nesting` of the first `Token` in
        the pair is 1 and nesting of the other `Token` is -1.
        """
        return bool(self.nester_tokens)

    @property
    def siblings(self: _NodeType) -> Sequence[_NodeType]:
        """Get siblings of the node.

        Gets the whole group of siblings, including self.
        """
        if not self.parent:
            return [self]
        return self.parent.children

    @property
    def type(self) -> str:
        """Get a string type of the represented syntax.

        - "root" for root nodes
        - `Token.type` if the node represents an unnested token
        - `Token.type` of the opening token, with "_open" suffix stripped, if
            the node represents a nester token pair
        """
        if self.is_root:
            return "root"
        if self.token:
            return self.token.type
        assert self.nester_tokens
        return self.nester_tokens.opening.type.removesuffix("_open")

    @property
    def next_sibling(self: _NodeType) -> _NodeType | None:
        """Get the next node in the sequence of siblings.

        Returns `None` if this is the last sibling.
        """
        self_index = self.siblings.index(self)
        if self_index + 1 < len(self.siblings):
            return self.siblings[self_index + 1]
        return None

    @property
    def previous_sibling(self: _NodeType) -> _NodeType | None:
        """Get the previous node in the sequence of siblings.

        Returns `None` if this is the first sibling.
        """
        self_index = self.siblings.index(self)
        if self_index - 1 >= 0:
            return self.siblings[self_index - 1]
        return None

    def _add_child(
        self,
        tokens: Sequence[Token],
    ) -> None:
        """Make a child node for `self`."""
        child = type(self)(tokens, create_root=False)
        child.parent = self
        self.children.append(child)

    def _set_children_from_tokens(self, tokens: Sequence[Token]) -> None:
        """Convert the token stream to a tree structure and set the resulting
        nodes as children of `self`."""
        reversed_tokens = list(reversed(tokens))
        while reversed_tokens:
            token = reversed_tokens.pop()

            if not token.nesting:
                self._add_child([token])
                continue
            if token.nesting != 1:
                raise ValueError("Invalid token nesting")

            nested_tokens = [token]
            nesting = 1
            while reversed_tokens and nesting:
                token = reversed_tokens.pop()
                nested_tokens.append(token)
                nesting += token.nesting
            if nesting:
                raise ValueError(f"unclosed tokens starting {nested_tokens[0]}")

            self._add_child(nested_tokens)

    def pretty(
        self, *, indent: int = 2, show_text: bool = False, _current: int = 0
    ) -> str:
        """Create an XML style string of the tree."""
        prefix = " " * _current
        text = prefix + f"<{self.type}"
        if not self.is_root and self.attrs:
            text += " " + " ".join(f"{k}={v!r}" for k, v in self.attrs.items())
        text += ">"
        if (
            show_text
            and not self.is_root
            and self.type in ("text", "text_special")
            and self.content
        ):
            text += "\n" + textwrap.indent(self.content, prefix + " " * indent)
        for child in self.children:
            text += "\n" + child.pretty(
                indent=indent, show_text=show_text, _current=_current + indent
            )
        return text

    def walk(
        self: _NodeType, *, include_self: bool = True
    ) -> Generator[_NodeType, None, None]:
        """Recursively yield all descendant nodes in the tree starting at self.

        The order mimics the order of the underlying linear token
        stream (i.e. depth first).
        """
        if include_self:
            yield self
        for child in self.children:
            yield from child.walk(include_self=True)

    # NOTE:
    # The values of the properties defined below directly map to properties
    # of the underlying `Token`s. A root node does not translate to a `Token`
    # object, so calling these property getters on a root node will raise an
    # `AttributeError`.
    #
    # There is no mapping for `Token.nesting` because the `is_nested` property
    # provides that data, and can be called on any node type, including root.

    def _attribute_token(self) -> Token:
        """Return the `Token` that is used as the data source for the
        properties defined below."""
        if self.token:
            return self.token
        if self.nester_tokens:
            return self.nester_tokens.opening
        raise AttributeError("Root node does not have the accessed attribute")

    @property
    def tag(self) -> str:
        """html tag name, e.g. \"p\""""
        return self._attribute_token().tag

    @property
    def attrs(self) -> dict[str, str | int | float]:
        """Html attributes."""
        return self._attribute_token().attrs

    def attrGet(self, name: str) -> None | str | int | float:
        """Get the value of attribute `name`, or null if it does not exist."""
        return self._attribute_token().attrGet(name)

    @property
    def map(self) -> tuple[int, int] | None:
        """Source map info. Format: `tuple[ line_begin, line_end ]`"""
        map_ = self._attribute_token().map
        if map_:
            # Type ignore because `Token`s attribute types are not perfect
            return tuple(map_)  # type: ignore
        return None

    @property
    def level(self) -> int:
        """nesting level, the same as `state.level`"""
        return self._attribute_token().level

    @property
    def content(self) -> str:
        """In a case of self-closing tag (code, html, fence, etc.), it
        has contents of this tag."""
        return self._attribute_token().content

    @property
    def markup(self) -> str:
        """'*' or '_' for emphasis, fence string for fence, etc."""
        return self._attribute_token().markup

    @property
    def info(self) -> str:
        """fence infostring"""
        return self._attribute_token().info

    @property
    def meta(self) -> dict[Any, Any]:
        """A place for plugins to store an arbitrary data."""
        return self._attribute_token().meta

    @property
    def block(self) -> bool:
        """True for block-level tokens, false for inline tokens."""
        return self._attribute_token().block

    @property
    def hidden(self) -> bool:
        """If it's true, ignore this element when rendering.
        Used for tight lists to hide paragraphs."""
        return self._attribute_token().hidden
markdown-it-py-4.2.0/markdown_it/utils.py000066400000000000000000000137761517710005200204430ustar00rootroot00000000000000from __future__ import annotations

from collections.abc import Callable, Iterable, MutableMapping
from collections.abc import MutableMapping as MutableMappingABC
from pathlib import Path
from typing import TYPE_CHECKING, Any, TypedDict, cast

if TYPE_CHECKING:
    from typing_extensions import NotRequired


EnvType = MutableMapping[str, Any]  # note: could use TypeAlias in python 3.10
"""Type for the environment sandbox used in parsing and rendering,
which stores mutable variables for use by plugins and rules.
"""


class OptionsType(TypedDict):
    """Options for parsing."""

    maxNesting: int
    """Internal protection, recursion limit."""
    html: bool
    """Enable HTML tags in source."""
    linkify: bool
    """Enable autoconversion of URL-like texts to links."""
    typographer: bool
    """Enable smartquotes and replacements."""
    quotes: str
    """Quote characters."""
    xhtmlOut: bool
    """Use '/' to close single tags (
)."""
    breaks: bool
    """Convert newlines in paragraphs into 
."""
    langPrefix: str
    """CSS language prefix for fenced blocks."""
    highlight: Callable[[str, str, str], str] | None
    """Highlighter function: (content, lang, attrs) -> str."""
    store_labels: NotRequired[bool]
    """Store link label in link/image token's metadata (under Token.meta['label']).

    This is a Python only option, and is intended for the use of round-trip parsing.
    """
    tasklists: NotRequired[bool]
    """Enable GFM task list checkbox detection in list items."""
    alerts: NotRequired[bool]
    """Enable GitHub-style alert detection in blockquotes."""
    tasklists_editable: NotRequired[bool]
    """When True, rendered task list checkboxes are interactive (no disabled attribute)."""
    strikethrough_single_tilde: NotRequired[bool]
    """Allow single tilde ``~text~`` for strikethrough in addition to double."""


class PresetType(TypedDict):
    """Preset configuration for markdown-it."""

    options: OptionsType
    """Options for parsing."""
    components: MutableMapping[str, MutableMapping[str, list[str]]]
    """Components for parsing and rendering."""


class OptionsDict(MutableMappingABC):  # type: ignore
    """A dictionary, with attribute access to core markdownit configuration options."""

    # Note: ideally we would probably just remove attribute access entirely,
    # but we keep it for backwards compatibility.

    def __init__(self, options: OptionsType) -> None:
        self._options = cast(OptionsType, dict(options))

    def __getitem__(self, key: str) -> Any:
        return self._options[key]  # type: ignore[literal-required]

    def __setitem__(self, key: str, value: Any) -> None:
        self._options[key] = value  # type: ignore[literal-required]

    def __delitem__(self, key: str) -> None:
        del self._options[key]  # type: ignore

    def __iter__(self) -> Iterable[str]:  # type: ignore
        return iter(self._options)

    def __len__(self) -> int:
        return len(self._options)

    def __repr__(self) -> str:
        return repr(self._options)

    def __str__(self) -> str:
        return str(self._options)

    @property
    def maxNesting(self) -> int:
        """Internal protection, recursion limit."""
        return self._options["maxNesting"]

    @maxNesting.setter
    def maxNesting(self, value: int) -> None:
        self._options["maxNesting"] = value

    @property
    def html(self) -> bool:
        """Enable HTML tags in source."""
        return self._options["html"]

    @html.setter
    def html(self, value: bool) -> None:
        self._options["html"] = value

    @property
    def linkify(self) -> bool:
        """Enable autoconversion of URL-like texts to links."""
        return self._options["linkify"]

    @linkify.setter
    def linkify(self, value: bool) -> None:
        self._options["linkify"] = value

    @property
    def typographer(self) -> bool:
        """Enable smartquotes and replacements."""
        return self._options["typographer"]

    @typographer.setter
    def typographer(self, value: bool) -> None:
        self._options["typographer"] = value

    @property
    def quotes(self) -> str:
        """Quote characters."""
        return self._options["quotes"]

    @quotes.setter
    def quotes(self, value: str) -> None:
        self._options["quotes"] = value

    @property
    def xhtmlOut(self) -> bool:
        """Use '/' to close single tags (
)."""
        return self._options["xhtmlOut"]

    @xhtmlOut.setter
    def xhtmlOut(self, value: bool) -> None:
        self._options["xhtmlOut"] = value

    @property
    def breaks(self) -> bool:
        """Convert newlines in paragraphs into 
."""
        return self._options["breaks"]

    @breaks.setter
    def breaks(self, value: bool) -> None:
        self._options["breaks"] = value

    @property
    def langPrefix(self) -> str:
        """CSS language prefix for fenced blocks."""
        return self._options["langPrefix"]

    @langPrefix.setter
    def langPrefix(self, value: str) -> None:
        self._options["langPrefix"] = value

    @property
    def highlight(self) -> Callable[[str, str, str], str] | None:
        """Highlighter function: (content, langName, langAttrs) -> escaped HTML."""
        return self._options["highlight"]

    @highlight.setter
    def highlight(self, value: Callable[[str, str, str], str] | None) -> None:
        self._options["highlight"] = value


def read_fixture_file(path: str | Path) -> list[list[Any]]:
    text = Path(path).read_text(encoding="utf-8")
    tests = []
    section = 0
    last_pos = 0
    lines = text.splitlines(keepends=True)
    for i in range(len(lines)):
        if lines[i].rstrip() == ".":
            if section == 0:
                tests.append([i, lines[i - 1].strip()])
                section = 1
            elif section == 1:
                tests[-1].append("".join(lines[last_pos + 1 : i]))
                section = 2
            elif section == 2:
                tests[-1].append("".join(lines[last_pos + 1 : i]))
                section = 0

            last_pos = i
    return tests
markdown-it-py-4.2.0/pyproject.toml000066400000000000000000000054731517710005200173220ustar00rootroot00000000000000[build-system]
requires = ["flit_core >=3.4,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "markdown-it-py"
dynamic = ["version"]
description = "Python port of markdown-it. Markdown parsing, done right!"
readme = "README.md"
authors = [{name = "Chris Sewell", email = "chrisj_sewell@hotmail.com"}]
license = {file = "LICENSE"}
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: Python :: Implementation :: PyPy",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Text Processing :: Markup",
]
keywords = ["markdown", "lexer", "parser", "commonmark", "markdown-it"]
requires-python = ">=3.10"
dependencies = [
    "mdurl~=0.1",
]

[project.urls]
Homepage = "https://github.com/executablebooks/markdown-it-py"
Documentation = "https://markdown-it-py.readthedocs.io"

[project.optional-dependencies]
compare = [
    "commonmark~=0.9",
    "markdown~=3.4",
    "mistletoe~=1.0",
    "mistune~=3.0",
    "panflute~=2.3",
    "markdown-it-pyrs",
]
linkify = ["linkify-it-py>=1,<3"]
plugins = ["mdit-py-plugins>=0.5.0"]
rtd = [
    "mdit-py-plugins>=0.5.0",
    "myst-parser",
    "pyyaml",
    "sphinx",
    "sphinx-copybutton",
    "sphinx-design",
    "sphinx-book-theme~=1.0",
    "jupyter_sphinx",
    "ipykernel",
]
testing = [
    "coverage",
    "pytest",
    "pytest-cov",
    "pytest-regressions",
    "pytest-timeout",
    "requests",
]
benchmarking = [
    "psutil",
    "pytest",
    "pytest-benchmark",
]
profiling = ["gprof2dot"]

[dependency-groups]
pre_commit = ["pre-commit"]
mypy = ["mypy", "mdurl", "typing-extensions"]

[project.scripts]
markdown-it = "markdown_it.cli.parse:main"

[tool.flit.module]
name = "markdown_it"

[tool.flit.sdist]
exclude = [
    "docs/",
    "tests/",
    "benchmarking/"
]

[tool.ruff.lint]
extend-select = ["B0", "C4", "I", "ICN", "ISC", "N", "RUF", "SIM", "UP"]
extend-ignore = ["ISC001", "ISC003", "N802", "N803", "N806", "N816", "RUF003"]

[tool.ruff.lint.isort]
force-sort-within-sections = true

[tool.mypy]
show_error_codes = true
warn_unused_ignores = true
warn_redundant_casts = true
strict = true

[[tool.mypy.overrides]]
module = ["tests.*"]
disallow_untyped_calls = false
disallow_untyped_defs = false

[[tool.mypy.overrides]]
module = ["tests.test_plugins.*", "markdown.*"]
ignore_errors = true

[[tool.mypy.overrides]]
module = ["markdown.*", "linkify_it.*"]
ignore_missing_imports = true

[tool.pytest.ini_options]
xfail_strict = true
timeout = 10
markdown-it-py-4.2.0/scripts/000077500000000000000000000000001517710005200160645ustar00rootroot00000000000000markdown-it-py-4.2.0/scripts/build_fuzzers.py000066400000000000000000000022121517710005200213220ustar00rootroot00000000000000"""Build fuzzers idempotently in a given folder."""

import argparse
from pathlib import Path
import subprocess


def main():
    """Build fuzzers idempotently in a given folder."""
    parser = argparse.ArgumentParser()
    parser.add_argument("folder")
    args = parser.parse_args()
    folder = Path(args.folder)
    if not folder.exists():
        print(f"Cloning google/oss-fuzz into: {folder}")
        folder.mkdir(parents=True)
        subprocess.check_call(
            [
                "git",
                "clone",
                "--single-branch",
                "https://github.com/google/oss-fuzz",
                str(folder),
            ]
        )
    else:
        print(f"Using google/oss-fuzz in: {folder}")
    if not (folder / "build").exists():
        print(f"Building fuzzers in: {folder / 'build'}")
        subprocess.check_call(
            [
                "python",
                str(folder / "infra" / "helper.py"),
                "build_fuzzers",
                "markdown-it-py",
            ]
        )
    else:
        print(f"Using existing fuzzers in: {folder / 'build'}")


if __name__ == "__main__":
    main()
markdown-it-py-4.2.0/scripts/profiler.py000066400000000000000000000007001517710005200202550ustar00rootroot00000000000000"""A script for profiling.

To generate and read results:
  - `tox -e profile`
  - `firefox .tox/prof/output.svg`
"""

from pathlib import Path

from markdown_it import MarkdownIt

commonmark_spec = (
    (Path(__file__).parent.parent / "tests" / "test_cmark_spec" / "spec.md")
    .read_bytes()
    .decode()
)

# Run this a few times to emphasize over imports and other overhead above
for _ in range(10):
    MarkdownIt().render(commonmark_spec)
markdown-it-py-4.2.0/tests/000077500000000000000000000000001517710005200155375ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/__init__.py000066400000000000000000000000001517710005200176360ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/fuzz/000077500000000000000000000000001517710005200165355ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/fuzz/README.md000066400000000000000000000035621517710005200200220ustar00rootroot00000000000000# OSS-Fuzz integration

In principle, core Markdown parsing is designed to never except/crash on any input,
and so [fuzzing](https://en.wikipedia.org/wiki/Fuzzing) can be used to test this conformance.
This folder contains fuzzers which are principally run downstream as part of the  infrastructure.

Any file that matches `fuzz_*.py` in this repository will be built and run on OSS-Fuzz
(see ).

See  for full details.

## CI integration

Fuzzing essentially runs forever, or until a crash is found, therefore it cannot be fully integrated into local continous integration testing.
The workflow in `.github/workflows/fuzz.yml` though runs a brief fuzzing on code changed in a PR,
which can be used to provide early warning on code changes.

## Reproducing crash failures

If OSS-Fuzz (or the CI workflow) identifies a crash, it will produce a "minimized testcase" file
(e.g. ).

To reproduce this crash locally, the easiest way is to run the [tox](https://tox.wiki/) environment, provided in this repository, against the test file (see `tox.ini`):

```
tox -e fuzz path/to/testcase
```

This idempotently sets up a local python environment with markdown-it-py (local dev) and [Atheris](https://pypi.org/project/atheris/) installed,
clones  into it,
and builds the fuzzers.
Then the testcase is run within this environment.

If you wish to simply run the full fuzzing process,
you can activate this environment, then run e.g.:

```
python .tox/fuzz/oss-fuzz/infra/helper.py run_fuzzer markdown-it-py fuzz_markdown
```

For a more thorough guide on reproducing, see: https://google.github.io/oss-fuzz/advanced-topics/reproducing/
markdown-it-py-4.2.0/tests/fuzz/fuzz_markdown.py000066400000000000000000000006401517710005200220070ustar00rootroot00000000000000import sys

import atheris

from markdown_it import MarkdownIt


def TestOneInput(data):
    fdp = atheris.FuzzedDataProvider(data)
    md = MarkdownIt()
    raw_markdown = fdp.ConsumeUnicodeNoSurrogates(sys.maxsize)
    md.parse(raw_markdown)
    md.render(raw_markdown)


def main():
    atheris.instrument_all()
    atheris.Setup(sys.argv, TestOneInput)
    atheris.Fuzz()


if __name__ == "__main__":
    main()
markdown-it-py-4.2.0/tests/fuzz/fuzz_markdown_extended.py000066400000000000000000000032311517710005200236660ustar00rootroot00000000000000import sys

import atheris

# Beautified from auto-generated fuzzer at:
# https://github.com/ossf/fuzz-introspector/pull/872#issuecomment-1450847118
# Auto-fuzz heuristics used: py-autofuzz-heuristics-4.1
# Imports by the generated code
import markdown_it


def TestOneInput(data):
    fdp = atheris.FuzzedDataProvider(data)
    val_1 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 1024))
    val_2 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 1024))
    val_3 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))
    val_4 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))
    val_5 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))
    val_6 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))
    val_7 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))
    val_8 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))
    val_9 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))
    val_10 = fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(0, 256))

    try:
        c1 = markdown_it.main.MarkdownIt()
        c1.render(val_1)
        c1.parse(val_2)
        c1.renderInline(val_3)
        c1.parseInline(val_4)
        c1.normalizeLink(val_5)
        c1.normalizeLinkText(val_6)
        c1.disable(val_7)
        c1.enable(val_8)
        c1.validateLink(val_9)
        c1.configure(val_10)
    except (
        ValueError,
        KeyError,
        TypeError,
    ):
        # Exceptions thrown by the hit code.
        pass


def main():
    atheris.instrument_all()
    atheris.Setup(sys.argv, TestOneInput)
    atheris.Fuzz()


if __name__ == "__main__":
    main()
markdown-it-py-4.2.0/tests/test_api/000077500000000000000000000000001517710005200173475ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_api/test_main.py000066400000000000000000000252041517710005200217070ustar00rootroot00000000000000from markdown_it import MarkdownIt
from markdown_it.token import Token


def test_get_rules():
    md = MarkdownIt("zero")
    # print(md.get_all_rules())
    assert md.get_all_rules() == {
        "core": [
            "normalize",
            "block",
            "inline",
            "linkify",
            "replacements",
            "smartquotes",
            "text_join",
        ],
        "block": [
            "table",
            "code",
            "fence",
            "blockquote",
            "hr",
            "list",
            "reference",
            "html_block",
            "heading",
            "lheading",
            "paragraph",
        ],
        "inline": [
            "text",
            "linkify",
            "newline",
            "escape",
            "backticks",
            "strikethrough",
            "emphasis",
            "link",
            "image",
            "autolink",
            "html_inline",
            "entity",
        ],
        "inline2": ["balance_pairs", "strikethrough", "emphasis", "fragments_join"],
    }


def test_load_presets():
    md = MarkdownIt("zero")
    assert md.get_active_rules() == {
        "block": ["paragraph"],
        "core": ["normalize", "block", "inline", "text_join"],
        "inline": ["text"],
        "inline2": ["balance_pairs", "fragments_join"],
    }
    md = MarkdownIt("commonmark")
    assert md.get_active_rules() == {
        "core": ["normalize", "block", "inline", "text_join"],
        "block": [
            "code",
            "fence",
            "blockquote",
            "hr",
            "list",
            "reference",
            "html_block",
            "heading",
            "lheading",
            "paragraph",
        ],
        "inline": [
            "text",
            "newline",
            "escape",
            "backticks",
            "emphasis",
            "link",
            "image",
            "autolink",
            "html_inline",
            "entity",
        ],
        "inline2": ["balance_pairs", "emphasis", "fragments_join"],
    }


def test_override_options():
    md = MarkdownIt("zero")
    assert md.options["maxNesting"] == 20
    md = MarkdownIt("zero", {"maxNesting": 99})
    assert md.options["maxNesting"] == 99


def test_gfm_like2_tasklists_editable():
    md_default = MarkdownIt("gfm-like2")
    assert md_default.options["tasklists_editable"] is False
    assert (
        ''
        in md_default.render("- [x] done")
    )

    md_editable = MarkdownIt("gfm-like2", {"tasklists_editable": True})
    assert md_editable.options["tasklists_editable"] is True
    assert (
        ''
        in md_editable.render("- [x] done")
    )


def test_gfm_like2_alert_token_map():
    md = MarkdownIt("gfm-like2")
    tokens = md.parse("> [!NOTE]\n> body")
    assert tokens[0].type == "alert_open"
    assert tokens[0].map == [0, 2]


def test_enable():
    md = MarkdownIt("zero").enable("heading")
    assert md.get_active_rules() == {
        "block": ["heading", "paragraph"],
        "core": ["normalize", "block", "inline", "text_join"],
        "inline": ["text"],
        "inline2": ["balance_pairs", "fragments_join"],
    }
    md.enable(["backticks", "autolink"])
    assert md.get_active_rules() == {
        "block": ["heading", "paragraph"],
        "core": ["normalize", "block", "inline", "text_join"],
        "inline": ["text", "backticks", "autolink"],
        "inline2": ["balance_pairs", "fragments_join"],
    }


def test_disable():
    md = MarkdownIt("zero").disable("inline")
    assert md.get_active_rules() == {
        "block": ["paragraph"],
        "core": ["normalize", "block", "text_join"],
        "inline": ["text"],
        "inline2": ["balance_pairs", "fragments_join"],
    }
    md.disable(["text"])
    assert md.get_active_rules() == {
        "block": ["paragraph"],
        "core": ["normalize", "block", "text_join"],
        "inline": [],
        "inline2": ["balance_pairs", "fragments_join"],
    }


def test_reset():
    md = MarkdownIt("zero")
    with md.reset_rules():
        md.disable("inline")
        assert md.get_active_rules() == {
            "block": ["paragraph"],
            "core": ["normalize", "block", "text_join"],
            "inline": ["text"],
            "inline2": ["balance_pairs", "fragments_join"],
        }
    assert md.get_active_rules() == {
        "block": ["paragraph"],
        "core": ["normalize", "block", "inline", "text_join"],
        "inline": ["text"],
        "inline2": ["balance_pairs", "fragments_join"],
    }


def test_parseInline():
    md = MarkdownIt()
    tokens = md.parseInline("abc\n\n> xyz")
    assert tokens == [
        Token(
            type="inline",
            tag="",
            nesting=0,
            attrs={},
            map=[0, 1],
            level=0,
            children=[
                Token(
                    type="text",
                    tag="",
                    nesting=0,
                    attrs={},
                    map=None,
                    level=0,
                    children=None,
                    content="abc",
                    markup="",
                    info="",
                    meta={},
                    block=False,
                    hidden=False,
                ),
                Token(
                    type="softbreak",
                    tag="br",
                    nesting=0,
                    attrs={},
                    map=None,
                    level=0,
                    children=None,
                    content="",
                    markup="",
                    info="",
                    meta={},
                    block=False,
                    hidden=False,
                ),
                Token(
                    type="softbreak",
                    tag="br",
                    nesting=0,
                    attrs={},
                    map=None,
                    level=0,
                    children=None,
                    content="",
                    markup="",
                    info="",
                    meta={},
                    block=False,
                    hidden=False,
                ),
                Token(
                    type="text",
                    tag="",
                    nesting=0,
                    attrs={},
                    map=None,
                    level=0,
                    children=None,
                    content="> xyz",
                    markup="",
                    info="",
                    meta={},
                    block=False,
                    hidden=False,
                ),
            ],
            content="abc\n\n> xyz",
            markup="",
            info="",
            meta={},
            block=False,
            hidden=False,
        )
    ]


def test_renderInline():
    md = MarkdownIt("zero")
    tokens = md.renderInline("abc\n\n*xyz*")
    assert tokens == "abc\n\n*xyz*"


def test_emptyStr():
    md = MarkdownIt()
    tokens = md.parseInline("")
    assert tokens == [
        Token(
            type="inline",
            tag="",
            nesting=0,
            attrs={},
            map=[0, 1],
            level=0,
            children=[],
            content="",
            markup="",
            info="",
            meta={},
            block=False,
            hidden=False,
        )
    ]


def test_empty_env():
    """Test that an empty `env` is mutated, not copied and mutated."""
    md = MarkdownIt()

    env = {}  # type: ignore
    md.render("[foo]: /url\n[foo]", env)
    assert "references" in env

    env = {}
    md.parse("[foo]: /url\n[foo]", env)
    assert "references" in env


def test_table_tokens(data_regression):
    md = MarkdownIt("js-default")
    tokens = md.parse(
        """
| Heading 1 | Heading 2
| --------- | ---------
| Cell 1    | Cell 2
| Cell 3    | Cell 4
    """
    )
    data_regression.check([t.as_dict() for t in tokens])


def test_fragments_join_merges_adjacent_text_tokens():
    """fragments_join should merge runs of adjacent text tokens into one.

    Underscore characters flanked by word characters (e.g. ``a_b``) are not
    valid emphasis delimiters in CommonMark, so the emphasis rule leaves each
    ``_`` as a plain text token adjacent to the surrounding text tokens,
    giving a run of five tokens: text("a"), text("_"), text("b c"),
    text("_"), text("d").

    Note: there is also a core-level ``text_join`` rule that collapses adjacent
    text tokens as a fallback.  We disable it here so that the assertions are
    sensitive only to ``fragments_join``.
    """
    src = "a_b c_d"

    # --- both rules disabled: five separate text tokens must survive ---
    md_both_off = MarkdownIt()
    md_both_off.disable(["text_join", "fragments_join"])
    children_both_off = md_both_off.parseInline(src)[0].children
    assert children_both_off is not None
    assert len(children_both_off) > 1, "expected multiple text tokens with no merging"
    assert all(t.type == "text" for t in children_both_off)

    # --- only fragments_join enabled (text_join still off): run must collapse ---
    md_fj_on = MarkdownIt()
    md_fj_on.disable("text_join")
    children_fj_on = md_fj_on.parseInline(src)[0].children
    assert children_fj_on is not None
    assert len(children_fj_on) == 1
    assert children_fj_on[0].type == "text"
    assert children_fj_on[0].content == "a_b c_d"


def test_text_join_merges_adjacent_text_special_tokens():
    """text_join should convert text_special tokens and merge runs into one.

    Backslash-escaped characters each produce a ``text_special`` token.
    ``fragments_join`` only merges ``text`` tokens, so a run of
    ``text_special`` tokens passes through it untouched.  ``text_join``
    must then convert them to ``text`` and collapse the run in a single
    pass rather than via pairwise concatenation.
    """
    # Three consecutive backslash escapes → three text_special tokens before
    # text_join runs.
    src = r"\*\*\*"

    # --- text_join disabled: three text_special tokens must survive ---
    md_off = MarkdownIt()
    md_off.disable("text_join")
    children_off = md_off.parseInline(src)[0].children
    assert children_off is not None
    assert len(children_off) > 1, "expected multiple text_special tokens before merging"
    assert all(t.type == "text_special" for t in children_off)

    # --- text_join enabled (default): must collapse to a single text token ---
    md_on = MarkdownIt()
    children_on = md_on.parseInline(src)[0].children
    assert children_on is not None
    assert len(children_on) == 1
    assert children_on[0].type == "text"
    assert children_on[0].content == "***"
markdown-it-py-4.2.0/tests/test_api/test_main/000077500000000000000000000000001517710005200213325ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_api/test_main/test_table_tokens.yml000066400000000000000000000145501517710005200255730ustar00rootroot00000000000000- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map:
  - 1
  - 5
  markup: ''
  meta: {}
  nesting: 1
  tag: table
  type: table_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 1
  map:
  - 1
  - 2
  markup: ''
  meta: {}
  nesting: 1
  tag: thead
  type: thead_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 2
  map:
  - 1
  - 2
  markup: ''
  meta: {}
  nesting: 1
  tag: tr
  type: tr_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: 1
  tag: th
  type: th_open
- attrs: null
  block: true
  children:
  - attrs: null
    block: false
    children: null
    content: Heading 1
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  content: Heading 1
  hidden: false
  info: ''
  level: 4
  map:
  - 1
  - 2
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: th
  type: th_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: 1
  tag: th
  type: th_open
- attrs: null
  block: true
  children:
  - attrs: null
    block: false
    children: null
    content: Heading 2
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  content: Heading 2
  hidden: false
  info: ''
  level: 4
  map:
  - 1
  - 2
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: th
  type: th_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 2
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: tr
  type: tr_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 1
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: thead
  type: thead_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 1
  map:
  - 3
  - 5
  markup: ''
  meta: {}
  nesting: 1
  tag: tbody
  type: tbody_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 2
  map:
  - 3
  - 4
  markup: ''
  meta: {}
  nesting: 1
  tag: tr
  type: tr_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: 1
  tag: td
  type: td_open
- attrs: null
  block: true
  children:
  - attrs: null
    block: false
    children: null
    content: Cell 1
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  content: Cell 1
  hidden: false
  info: ''
  level: 4
  map:
  - 3
  - 4
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: td
  type: td_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: 1
  tag: td
  type: td_open
- attrs: null
  block: true
  children:
  - attrs: null
    block: false
    children: null
    content: Cell 2
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  content: Cell 2
  hidden: false
  info: ''
  level: 4
  map:
  - 3
  - 4
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: td
  type: td_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 2
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: tr
  type: tr_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 2
  map:
  - 4
  - 5
  markup: ''
  meta: {}
  nesting: 1
  tag: tr
  type: tr_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: 1
  tag: td
  type: td_open
- attrs: null
  block: true
  children:
  - attrs: null
    block: false
    children: null
    content: Cell 3
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  content: Cell 3
  hidden: false
  info: ''
  level: 4
  map:
  - 4
  - 5
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: td
  type: td_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: 1
  tag: td
  type: td_open
- attrs: null
  block: true
  children:
  - attrs: null
    block: false
    children: null
    content: Cell 4
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  content: Cell 4
  hidden: false
  info: ''
  level: 4
  map:
  - 4
  - 5
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 3
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: td
  type: td_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 2
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: tr
  type: tr_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 1
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: tbody
  type: tbody_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: table
  type: table_close
markdown-it-py-4.2.0/tests/test_api/test_make_fence_rule.py000066400000000000000000000231621517710005200240700ustar00rootroot00000000000000"""Tests for make_fence_rule factory function."""

from __future__ import annotations

from markdown_it import MarkdownIt
from markdown_it.rules_block.fence import make_fence_rule


def _make_colon_fence_md() -> MarkdownIt:
    """Create a MarkdownIt instance with a colon fence rule (like colon_fence plugin)."""
    md = MarkdownIt()
    colon_rule = make_fence_rule(
        markers=(":",),
        token_type="colon_fence",
        disallow_marker_in_info=(),
    )
    md.block.ruler.before(
        "fence",
        "colon_fence",
        colon_rule,
        {"alt": ["paragraph", "reference", "blockquote", "list"]},
    )
    return md


class TestColonFenceMarker:
    """Test colon fence behavior (`:` marker, like mdit-py-plugins colon_fence)."""

    def test_basic(self):
        md = _make_colon_fence_md()
        tokens = md.parse(":::\nfoo\n:::\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        assert tokens[0].content == "foo\n"
        assert tokens[0].markup == ":::"

    def test_with_info(self):
        md = _make_colon_fence_md()
        tokens = md.parse(":::python\nfoo\n:::\n")
        assert tokens[0].type == "colon_fence"
        assert tokens[0].info == "python"
        assert tokens[0].content == "foo\n"

    def test_colon_in_info_allowed(self):
        """Colons in info string should be allowed (unlike backticks in backtick fences)."""
        md = _make_colon_fence_md()
        tokens = md.parse(":::{note}\nfoo\n:::\n")
        assert tokens[0].type == "colon_fence"
        assert tokens[0].info == "{note}"

    def test_longer_closing(self):
        """Closing fence can be longer than opening (default, not exact_match)."""
        md = _make_colon_fence_md()
        tokens = md.parse(":::\nfoo\n::::\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        assert tokens[0].content == "foo\n"

    def test_shorter_closing_no_match(self):
        """Closing fence shorter than opening does not close the block."""
        md = _make_colon_fence_md()
        tokens = md.parse("::::\nfoo\n:::\nbar\n::::\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        # The inner ::: is content, not a closing fence
        assert ":::" in tokens[0].content
        assert "foo" in tokens[0].content
        assert "bar" in tokens[0].content

    def test_does_not_interfere_with_backtick(self):
        """Standard backtick fences still work alongside colon fences."""
        md = _make_colon_fence_md()
        tokens = md.parse("```\nfoo\n```\n")
        assert tokens[0].type == "fence"
        assert tokens[0].content == "foo\n"

    def test_unclosed_block(self):
        """Unclosed colon fence is autoclosed at end of document."""
        md = _make_colon_fence_md()
        tokens = md.parse(":::\nfoo\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        assert tokens[0].content == "foo\n"


class TestExactMatch:
    """Test exact_match option for fence closing."""

    def _make_exact_md(self) -> MarkdownIt:
        """Create MarkdownIt with exact-match colon fence."""
        md = MarkdownIt()
        colon_rule = make_fence_rule(
            markers=(":",),
            token_type="colon_fence",
            disallow_marker_in_info=(),
            exact_match=True,
        )
        md.block.ruler.before(
            "fence",
            "colon_fence",
            colon_rule,
            {"alt": ["paragraph", "reference", "blockquote", "list"]},
        )
        return md

    def test_exact_match_same_length(self):
        """Closing fence with same length closes the block."""
        md = self._make_exact_md()
        tokens = md.parse(":::\nfoo\n:::\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        assert tokens[0].content == "foo\n"

    def test_exact_match_longer_no_close(self):
        """Closing fence with more markers does NOT close (exact match required)."""
        md = self._make_exact_md()
        tokens = md.parse(":::\nfoo\n::::\n:::\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        # :::: is content, not a closer; ::: at the end is the real closer
        assert "::::" in tokens[0].content
        assert tokens[0].content == "foo\n::::\n"

    def test_exact_match_shorter_no_close(self):
        """Closing fence with fewer markers does NOT close (exact match required)."""
        md = self._make_exact_md()
        tokens = md.parse("::::\nfoo\n:::\nbar\n::::\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        assert ":::" in tokens[0].content
        assert tokens[0].content == "foo\n:::\nbar\n"

    def test_nesting_pattern(self):
        """Demonstrate nested fences with exact match (outer 4, inner 3)."""
        md = self._make_exact_md()
        tokens = md.parse(
            "::::{note}\nouter\n:::{warning}\ninner\n:::\nouter again\n::::\n"
        )
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        assert tokens[0].info == "{note}"
        assert tokens[0].markup == "::::"
        # The inner ::: fence is captured as content
        assert ":::{warning}" in tokens[0].content
        assert "inner" in tokens[0].content
        assert ":::" in tokens[0].content
        assert "outer again" in tokens[0].content

    def test_unclosed_exact_match(self):
        """Unclosed exact-match fence is autoclosed at end of document."""
        md = self._make_exact_md()
        tokens = md.parse(":::\nfoo\n::::\n")
        assert len(tokens) == 1
        assert tokens[0].type == "colon_fence"
        # :::: doesn't close (wrong length), so content includes it
        assert tokens[0].content == "foo\n::::\n"


class TestOverrideStandardFence:
    """Test overriding the standard fence rule with make_fence_rule."""

    def test_override_with_exact_match(self):
        """Override standard fence to use exact matching."""
        md = MarkdownIt()
        md.block.ruler.at("fence", make_fence_rule(exact_match=True))
        tokens = md.parse("```\nfoo\n````\n```\n")
        assert tokens[0].type == "fence"
        # ```` doesn't close (exact match), ``` does
        assert tokens[0].content == "foo\n````\n"

    def test_override_add_colon_marker(self):
        """Override standard fence to also accept colon markers."""
        md = MarkdownIt()
        md.block.ruler.at(
            "fence",
            make_fence_rule(markers=("~", "`", ":")),
        )
        tokens = md.parse(":::\nfoo\n:::\n")
        assert tokens[0].type == "fence"
        assert tokens[0].content == "foo\n"
        assert tokens[0].markup == ":::"

    def test_override_preserves_backtick_info_restriction(self):
        """Backtick info string restriction still works with custom markers."""
        md = MarkdownIt()
        md.block.ruler.at(
            "fence",
            make_fence_rule(markers=("~", "`", ":")),
        )
        # Backtick in info string of backtick fence → not a fence
        tokens = md.parse("``` foo`bar\ntest\n```\n")
        assert not any(t.type == "fence" for t in tokens)

        # Colon in info string of colon fence → allowed (not in disallow list)
        tokens = md.parse(":::foo:bar\ntest\n:::\n")
        assert tokens[0].type == "fence"
        assert tokens[0].info == "foo:bar"


class TestMinMarkers:
    """Test min_markers parameter."""

    def test_min_markers_default(self):
        """Default min_markers is 3."""
        md = MarkdownIt()
        tokens = md.parse("``\nfoo\n``\n")
        # 2 backticks is not a fence
        assert not any(t.type == "fence" for t in tokens)

    def test_min_markers_custom(self):
        """Custom min_markers allows changing the threshold."""
        md = MarkdownIt()
        md.block.ruler.at("fence", make_fence_rule(min_markers=4))
        # 3 backticks is now below threshold
        tokens = md.parse("```\nfoo\n```\n")
        assert not any(t.type == "fence" for t in tokens)
        # 4 backticks works
        tokens = md.parse("````\nfoo\n````\n")
        assert tokens[0].type == "fence"
        assert tokens[0].content == "foo\n"


class TestDisallowMarkerInInfo:
    """Test disallow_marker_in_info parameter."""

    def test_default_backtick_disallowed(self):
        """By default, backtick in backtick-fence info string is rejected."""
        md = MarkdownIt()
        tokens = md.parse("```foo`bar\ntest\n```\n")
        # Not parsed as a fence (`` ` `` in info rejects it as opener)
        assert not any(t.type == "fence" and "foo`bar" in t.info for t in tokens)

    def test_tilde_in_tilde_info_allowed(self):
        """By default, tilde in tilde-fence info string is allowed."""
        md = MarkdownIt()
        tokens = md.parse("~~~ foo~bar\ntest\n~~~\n")
        assert tokens[0].type == "fence"
        assert tokens[0].info == " foo~bar"

    def test_disallow_all(self):
        """Can disallow marker in info for all marker types."""
        md = MarkdownIt()
        md.block.ruler.at(
            "fence",
            make_fence_rule(disallow_marker_in_info=("~", "`")),
        )
        tokens = md.parse("~~~ foo~bar\ntest\n~~~\n")
        # Tilde in info string of tilde fence → rejected
        assert not any(t.type == "fence" for t in tokens)

    def test_disallow_none(self):
        """Can allow marker in info for all marker types."""
        md = MarkdownIt()
        md.block.ruler.at(
            "fence",
            make_fence_rule(disallow_marker_in_info=()),
        )
        # Backtick in backtick-fence info string → now allowed
        tokens = md.parse("``` foo`bar\ntest\n```\n")
        assert tokens[0].type == "fence"
        assert tokens[0].info == " foo`bar"
markdown-it-py-4.2.0/tests/test_api/test_plugin_creation.py000066400000000000000000000073171517710005200241520ustar00rootroot00000000000000"""Test basic plugin creation functionality:
that they can be added and are called correctly
"""

from markdown_it import MarkdownIt


def inline_rule(state, silent):
    print("plugin called")
    return False


def test_inline_after(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.inline.ruler.after("text", "new_rule", inline_rule)

    MarkdownIt().use(_plugin).parse("[")
    assert "plugin called" in capsys.readouterr().out


def test_inline_before(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.inline.ruler.before("text", "new_rule", inline_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def test_inline_at(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.inline.ruler.at("text", inline_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def block_rule(state, startLine, endLine, silent):
    print("plugin called")
    return False


def test_block_after(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.block.ruler.after("hr", "new_rule", block_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def test_block_before(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.block.ruler.before("hr", "new_rule", block_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def test_block_at(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.block.ruler.at("hr", block_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def core_rule(state):
    print("plugin called")


def test_core_after(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.core.ruler.after("normalize", "new_rule", core_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def test_core_before(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.core.ruler.before("normalize", "new_rule", core_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def test_core_at(capsys):
    def _plugin(_md: MarkdownIt) -> None:
        _md.core.ruler.at("normalize", core_rule)

    MarkdownIt().use(_plugin).parse("a")
    assert "plugin called" in capsys.readouterr().out


def test_add_terminator_char():
    """Test that add_terminator_char stops the text rule on a new character."""
    hit_positions = []

    def w_rule(state, silent):
        if state.src[state.pos] != "w":
            return False
        hit_positions.append(state.pos)
        state.pos += 1
        return True

    def _plugin(_md: MarkdownIt) -> None:
        _md.inline.add_terminator_char("w")
        _md.inline.ruler.before("text", "w_rule", w_rule)

    md = MarkdownIt().use(_plugin)

    # Without the terminator 'w' would be consumed as plain text;
    # with it the rule fires exactly for the 'w' at position 1 in "awb".
    md.render("awb")
    assert hit_positions == [1]


def test_add_terminator_char_idempotent():
    """add_terminator_char with an already-present char should not rebuild the regex."""
    md = MarkdownIt()
    original_re = md.inline.terminator_re

    # '\n' is already in the default set – adding it again must not rebuild
    md.inline.add_terminator_char("\n")
    assert md.inline.terminator_re is original_re


def test_add_terminator_char_rebuilds():
    """add_terminator_char with a new char should rebuild the regex."""
    md = MarkdownIt()
    original_re = md.inline.terminator_re

    md.inline.add_terminator_char("w")
    assert md.inline.terminator_re is not original_re
    assert "w" in md.inline._extra_terminator_chars
markdown-it-py-4.2.0/tests/test_api/test_token.py000066400000000000000000000017431517710005200221050ustar00rootroot00000000000000import warnings

from markdown_it.token import Token


def test_token():
    token = Token("name", "tag", 0)
    assert token.as_dict() == {
        "type": "name",
        "tag": "tag",
        "nesting": 0,
        "attrs": None,
        "map": None,
        "level": 0,
        "children": None,
        "content": "",
        "markup": "",
        "info": "",
        "meta": {},
        "block": False,
        "hidden": False,
    }
    token.attrSet("a", "b")
    assert token.attrGet("a") == "b"
    token.attrJoin("a", "c")
    assert token.attrGet("a") == "b c"
    token.attrPush(("x", "y"))
    assert token.attrGet("x") == "y"
    with warnings.catch_warnings():
        warnings.simplefilter("ignore")
        assert token.attrIndex("a") == 0
        assert token.attrIndex("x") == 1
        assert token.attrIndex("j") == -1


def test_serialization():
    token = Token("name", "tag", 0, children=[Token("other", "tag2", 0)])
    assert token == Token.from_dict(token.as_dict())
markdown-it-py-4.2.0/tests/test_cli.py000066400000000000000000000057251517710005200177300ustar00rootroot00000000000000from contextlib import redirect_stdout
import io
import pathlib
import tempfile
from unittest.mock import patch

import pytest

from markdown_it.cli import parse


def test_parse():
    with tempfile.TemporaryDirectory() as tempdir:
        path = pathlib.Path(tempdir).joinpath("test.md")
        path.write_text("a b c")
        assert parse.main([str(path)]) == 0


def test_parse_fail():
    with pytest.raises(SystemExit) as exc_info:
        parse.main(["/tmp/nonexistant_path/for_cli_test.md"])
    assert exc_info.value.code == 1


def test_non_utf8():
    with tempfile.TemporaryDirectory() as tempdir:
        path = pathlib.Path(tempdir).joinpath("test.md")
        path.write_bytes(b"\x80abc")
        assert parse.main([str(path)]) == 0


def test_print_heading():
    with patch("builtins.print") as patched:
        parse.print_heading()
    patched.assert_called()


def test_interactive():
    def mock_input(prompt):
        raise KeyboardInterrupt

    with patch("builtins.print") as patched, patch("builtins.input", mock_input):
        parse.interactive()
    patched.assert_called()


def test_main_no_args_is_interactive():
    with patch("markdown_it.cli.parse.interactive") as mock_interactive:
        assert parse.main([]) == 0
    mock_interactive.assert_called_once()


def test_parse_output():
    with tempfile.TemporaryDirectory() as tempdir:
        path = pathlib.Path(tempdir).joinpath("test.md")
        path.write_text("# a b c")
        string_io = io.StringIO()
        with redirect_stdout(string_io):
            assert parse.main([str(path)]) == 0
        assert string_io.getvalue() == "
a b c
\n"


def test_stdin():
    with patch("sys.stdin", io.StringIO("# a b c")):
        string_io = io.StringIO()
        with redirect_stdout(string_io):
            assert parse.main(["--stdin"]) == 0
        assert string_io.getvalue() == "
a b c
\n"


def test_multiple_files():
    with tempfile.TemporaryDirectory() as tempdir:
        path1 = pathlib.Path(tempdir).joinpath("test1.md")
        path1.write_text("# file 1")
        path2 = pathlib.Path(tempdir).joinpath("test2.md")
        path2.write_text("* file 2")
        string_io = io.StringIO()
        with redirect_stdout(string_io):
            assert parse.main([str(path1), str(path2)]) == 0
        assert string_io.getvalue() == "
file 1
\n
    \n
  • file 2
    • \n
\n"


def test_interactive_render():
    # Simulate user typing '# hello', pressing Ctrl-D (renders), then Ctrl-C (exits)
    # This is needed to break the infinite loop in interactive mode on EOF.
    mock_input = patch(
        "builtins.input", side_effect=["# hello", EOFError, KeyboardInterrupt]
    )
    string_io = io.StringIO()
    with redirect_stdout(string_io), mock_input:
        parse.interactive()

    output = string_io.getvalue()
    assert "markdown-it-py" in output  # from print_heading
    # The rendered output is prefixed by a newline
    assert "\n
hello
\n" in output
    assert "Exiting" in output
markdown-it-py-4.2.0/tests/test_cmark_spec/000077500000000000000000000000001517710005200207055ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_cmark_spec/commonmark.json000066400000000000000000004223071517710005200237530ustar00rootroot00000000000000[
  {
    "markdown": "\tfoo\tbaz\t\tbim\n",
    "html": "
foo\tbaz\t\tbim\n
\n",
    "example": 1,
    "start_line": 355,
    "end_line": 360,
    "section": "Tabs"
  },
  {
    "markdown": "  \tfoo\tbaz\t\tbim\n",
    "html": "
foo\tbaz\t\tbim\n
\n",
    "example": 2,
    "start_line": 362,
    "end_line": 367,
    "section": "Tabs"
  },
  {
    "markdown": "    a\ta\n    ὐ\ta\n",
    "html": "
a\ta\nὐ\ta\n
\n",
    "example": 3,
    "start_line": 369,
    "end_line": 376,
    "section": "Tabs"
  },
  {
    "markdown": "  - foo\n\n\tbar\n",
    "html": "
    \n
  • \n
    foo
    \n
    bar
    \n
    • \n
\n",
    "example": 4,
    "start_line": 382,
    "end_line": 393,
    "section": "Tabs"
  },
  {
    "markdown": "- foo\n\n\t\tbar\n",
    "html": "
    \n
  • \n
    foo
    \n
      bar\n
    \n
    • \n
\n",
    "example": 5,
    "start_line": 395,
    "end_line": 407,
    "section": "Tabs"
  },
  {
    "markdown": ">\t\tfoo\n",
    "html": "
\n
  foo\n
\n
\n",
    "example": 6,
    "start_line": 418,
    "end_line": 425,
    "section": "Tabs"
  },
  {
    "markdown": "-\t\tfoo\n",
    "html": "
    \n
  • \n
      foo\n
    \n
    • \n
\n",
    "example": 7,
    "start_line": 427,
    "end_line": 436,
    "section": "Tabs"
  },
  {
    "markdown": "    foo\n\tbar\n",
    "html": "
foo\nbar\n
\n",
    "example": 8,
    "start_line": 439,
    "end_line": 446,
    "section": "Tabs"
  },
  {
    "markdown": " - foo\n   - bar\n\t - baz\n",
    "html": "
    \n
  • foo\n
      \n
    • bar\n
        \n
      • baz
        • \n
      \n
      • \n
    \n
    • \n
\n",
    "example": 9,
    "start_line": 448,
    "end_line": 464,
    "section": "Tabs"
  },
  {
    "markdown": "#\tFoo\n",
    "html": "
Foo
\n",
    "example": 10,
    "start_line": 466,
    "end_line": 470,
    "section": "Tabs"
  },
  {
    "markdown": "*\t*\t*\t\n",
    "html": "
\n",
    "example": 11,
    "start_line": 472,
    "end_line": 476,
    "section": "Tabs"
  },
  {
    "markdown": "\\!\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\?\\@\\[\\\\\\]\\^\\_\\`\\{\\|\\}\\~\n",
    "html": "
!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
\n",
    "example": 12,
    "start_line": 489,
    "end_line": 493,
    "section": "Backslash escapes"
  },
  {
    "markdown": "\\\t\\A\\a\\ \\3\\φ\\«\n",
    "html": "
\\\t\\A\\a\\ \\3\\φ\\«
\n",
    "example": 13,
    "start_line": 499,
    "end_line": 503,
    "section": "Backslash escapes"
  },
  {
    "markdown": "\\*not emphasized*\n\\
 not a tag\n\\[not a link](/foo)\n\\`not code`\n1\\. not a list\n\\* not a list\n\\# not a heading\n\\[foo]: /url \"not a reference\"\n\\ö not a character entity\n",
    "html": "
*not emphasized*\n<br/> not a tag\n[not a link](/foo)\n`not code`\n1. not a list\n* not a list\n# not a heading\n[foo]: /url "not a reference"\n&ouml; not a character entity
\n",
    "example": 14,
    "start_line": 509,
    "end_line": 529,
    "section": "Backslash escapes"
  },
  {
    "markdown": "\\\\*emphasis*\n",
    "html": "
\\emphasis
\n",
    "example": 15,
    "start_line": 534,
    "end_line": 538,
    "section": "Backslash escapes"
  },
  {
    "markdown": "foo\\\nbar\n",
    "html": "
foo
\nbar
\n",
    "example": 16,
    "start_line": 543,
    "end_line": 549,
    "section": "Backslash escapes"
  },
  {
    "markdown": "`` \\[\\` ``\n",
    "html": "
\\[\\`
\n",
    "example": 17,
    "start_line": 555,
    "end_line": 559,
    "section": "Backslash escapes"
  },
  {
    "markdown": "    \\[\\]\n",
    "html": "
\\[\\]\n
\n",
    "example": 18,
    "start_line": 562,
    "end_line": 567,
    "section": "Backslash escapes"
  },
  {
    "markdown": "~~~\n\\[\\]\n~~~\n",
    "html": "
\\[\\]\n
\n",
    "example": 19,
    "start_line": 570,
    "end_line": 577,
    "section": "Backslash escapes"
  },
  {
    "markdown": "\n",
    "html": "
https://example.com?find=\\*
\n",
    "example": 20,
    "start_line": 580,
    "end_line": 584,
    "section": "Backslash escapes"
  },
  {
    "markdown": "\n",
    "html": "\n",
    "example": 21,
    "start_line": 587,
    "end_line": 591,
    "section": "Backslash escapes"
  },
  {
    "markdown": "[foo](/bar\\* \"ti\\*tle\")\n",
    "html": "
foo
\n",
    "example": 22,
    "start_line": 597,
    "end_line": 601,
    "section": "Backslash escapes"
  },
  {
    "markdown": "[foo]\n\n[foo]: /bar\\* \"ti\\*tle\"\n",
    "html": "
foo
\n",
    "example": 23,
    "start_line": 604,
    "end_line": 610,
    "section": "Backslash escapes"
  },
  {
    "markdown": "``` foo\\+bar\nfoo\n```\n",
    "html": "
foo\n
\n",
    "example": 24,
    "start_line": 613,
    "end_line": 620,
    "section": "Backslash escapes"
  },
  {
    "markdown": "  & © Æ Ď\n¾ ℋ ⅆ\n∲ ≧̸\n",
    "html": "
  & © Æ Ď\n¾ ℋ ⅆ\n∲ ≧̸
\n",
    "example": 25,
    "start_line": 649,
    "end_line": 657,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "# Ӓ Ϡ �\n",
    "html": "
# Ӓ Ϡ �
\n",
    "example": 26,
    "start_line": 668,
    "end_line": 672,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "" ആ ಫ\n",
    "html": "
" ആ ಫ
\n",
    "example": 27,
    "start_line": 681,
    "end_line": 685,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "  &x; &#; &#x;\n�\n&#abcdef0;\n&ThisIsNotDefined; &hi?;\n",
    "html": "
&nbsp &x; &#; &#x;\n&#87654321;\n&#abcdef0;\n&ThisIsNotDefined; &hi?;
\n",
    "example": 28,
    "start_line": 690,
    "end_line": 700,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "©\n",
    "html": "
&copy
\n",
    "example": 29,
    "start_line": 707,
    "end_line": 711,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "&MadeUpEntity;\n",
    "html": "
&MadeUpEntity;
\n",
    "example": 30,
    "start_line": 717,
    "end_line": 721,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "\n",
    "html": "\n",
    "example": 31,
    "start_line": 728,
    "end_line": 732,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "[foo](/föö \"föö\")\n",
    "html": "
foo
\n",
    "example": 32,
    "start_line": 735,
    "end_line": 739,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "[foo]\n\n[foo]: /föö \"föö\"\n",
    "html": "
foo
\n",
    "example": 33,
    "start_line": 742,
    "end_line": 748,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "``` föö\nfoo\n```\n",
    "html": "
foo\n
\n",
    "example": 34,
    "start_line": 751,
    "end_line": 758,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "`föö`\n",
    "html": "
f&ouml;&ouml;
\n",
    "example": 35,
    "start_line": 764,
    "end_line": 768,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "    föfö\n",
    "html": "
f&ouml;f&ouml;\n
\n",
    "example": 36,
    "start_line": 771,
    "end_line": 776,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "*foo*\n*foo*\n",
    "html": "
*foo*\nfoo
\n",
    "example": 37,
    "start_line": 783,
    "end_line": 789,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "* foo\n\n* foo\n",
    "html": "
* foo
\n
    \n
  • foo
    • \n
\n",
    "example": 38,
    "start_line": 791,
    "end_line": 800,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "foo

bar\n",
    "html": "
foo\n\nbar
\n",
    "example": 39,
    "start_line": 802,
    "end_line": 808,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "	foo\n",
    "html": "
\tfoo
\n",
    "example": 40,
    "start_line": 810,
    "end_line": 814,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "[a](url "tit")\n",
    "html": "
[a](url "tit")
\n",
    "example": 41,
    "start_line": 817,
    "end_line": 821,
    "section": "Entity and numeric character references"
  },
  {
    "markdown": "- `one\n- two`\n",
    "html": "
    \n
  • `one
    • \n
  • two`
    • \n
\n",
    "example": 42,
    "start_line": 840,
    "end_line": 848,
    "section": "Precedence"
  },
  {
    "markdown": "***\n---\n___\n",
    "html": "
\n
\n
\n",
    "example": 43,
    "start_line": 879,
    "end_line": 887,
    "section": "Thematic breaks"
  },
  {
    "markdown": "+++\n",
    "html": "
+++
\n",
    "example": 44,
    "start_line": 892,
    "end_line": 896,
    "section": "Thematic breaks"
  },
  {
    "markdown": "===\n",
    "html": "
===
\n",
    "example": 45,
    "start_line": 899,
    "end_line": 903,
    "section": "Thematic breaks"
  },
  {
    "markdown": "--\n**\n__\n",
    "html": "
--\n**\n__
\n",
    "example": 46,
    "start_line": 908,
    "end_line": 916,
    "section": "Thematic breaks"
  },
  {
    "markdown": " ***\n  ***\n   ***\n",
    "html": "
\n
\n
\n",
    "example": 47,
    "start_line": 921,
    "end_line": 929,
    "section": "Thematic breaks"
  },
  {
    "markdown": "    ***\n",
    "html": "
***\n
\n",
    "example": 48,
    "start_line": 934,
    "end_line": 939,
    "section": "Thematic breaks"
  },
  {
    "markdown": "Foo\n    ***\n",
    "html": "
Foo\n***
\n",
    "example": 49,
    "start_line": 942,
    "end_line": 948,
    "section": "Thematic breaks"
  },
  {
    "markdown": "_____________________________________\n",
    "html": "
\n",
    "example": 50,
    "start_line": 953,
    "end_line": 957,
    "section": "Thematic breaks"
  },
  {
    "markdown": " - - -\n",
    "html": "
\n",
    "example": 51,
    "start_line": 962,
    "end_line": 966,
    "section": "Thematic breaks"
  },
  {
    "markdown": " **  * ** * ** * **\n",
    "html": "
\n",
    "example": 52,
    "start_line": 969,
    "end_line": 973,
    "section": "Thematic breaks"
  },
  {
    "markdown": "-     -      -      -\n",
    "html": "
\n",
    "example": 53,
    "start_line": 976,
    "end_line": 980,
    "section": "Thematic breaks"
  },
  {
    "markdown": "- - - -    \n",
    "html": "
\n",
    "example": 54,
    "start_line": 985,
    "end_line": 989,
    "section": "Thematic breaks"
  },
  {
    "markdown": "_ _ _ _ a\n\na------\n\n---a---\n",
    "html": "
_ _ _ _ a
\n
a------
\n
---a---
\n",
    "example": 55,
    "start_line": 994,
    "end_line": 1004,
    "section": "Thematic breaks"
  },
  {
    "markdown": " *-*\n",
    "html": "
-
\n",
    "example": 56,
    "start_line": 1010,
    "end_line": 1014,
    "section": "Thematic breaks"
  },
  {
    "markdown": "- foo\n***\n- bar\n",
    "html": "
    \n
  • foo
    • \n
\n
\n
    \n
  • bar
    • \n
\n",
    "example": 57,
    "start_line": 1019,
    "end_line": 1031,
    "section": "Thematic breaks"
  },
  {
    "markdown": "Foo\n***\nbar\n",
    "html": "
Foo
\n
\n
bar
\n",
    "example": 58,
    "start_line": 1036,
    "end_line": 1044,
    "section": "Thematic breaks"
  },
  {
    "markdown": "Foo\n---\nbar\n",
    "html": "
Foo
\n
bar
\n",
    "example": 59,
    "start_line": 1053,
    "end_line": 1060,
    "section": "Thematic breaks"
  },
  {
    "markdown": "* Foo\n* * *\n* Bar\n",
    "html": "
    \n
  • Foo
    • \n
\n
\n
    \n
  • Bar
    • \n
\n",
    "example": 60,
    "start_line": 1066,
    "end_line": 1078,
    "section": "Thematic breaks"
  },
  {
    "markdown": "- Foo\n- * * *\n",
    "html": "
    \n
  • Foo
    • \n
  • \n
    \n
    • \n
\n",
    "example": 61,
    "start_line": 1083,
    "end_line": 1093,
    "section": "Thematic breaks"
  },
  {
    "markdown": "# foo\n## foo\n### foo\n#### foo\n##### foo\n###### foo\n",
    "html": "
foo
\n
foo
\n
foo
\n
foo
\n
foo
\n
foo
\n",
    "example": 62,
    "start_line": 1112,
    "end_line": 1126,
    "section": "ATX headings"
  },
  {
    "markdown": "####### foo\n",
    "html": "
####### foo
\n",
    "example": 63,
    "start_line": 1131,
    "end_line": 1135,
    "section": "ATX headings"
  },
  {
    "markdown": "#5 bolt\n\n#hashtag\n",
    "html": "
#5 bolt
\n
#hashtag
\n",
    "example": 64,
    "start_line": 1146,
    "end_line": 1153,
    "section": "ATX headings"
  },
  {
    "markdown": "\\## foo\n",
    "html": "
## foo
\n",
    "example": 65,
    "start_line": 1158,
    "end_line": 1162,
    "section": "ATX headings"
  },
  {
    "markdown": "# foo *bar* \\*baz\\*\n",
    "html": "
foo bar *baz*
\n",
    "example": 66,
    "start_line": 1167,
    "end_line": 1171,
    "section": "ATX headings"
  },
  {
    "markdown": "#                  foo                     \n",
    "html": "
foo
\n",
    "example": 67,
    "start_line": 1176,
    "end_line": 1180,
    "section": "ATX headings"
  },
  {
    "markdown": " ### foo\n  ## foo\n   # foo\n",
    "html": "
foo
\n
foo
\n
foo
\n",
    "example": 68,
    "start_line": 1185,
    "end_line": 1193,
    "section": "ATX headings"
  },
  {
    "markdown": "    # foo\n",
    "html": "
# foo\n
\n",
    "example": 69,
    "start_line": 1198,
    "end_line": 1203,
    "section": "ATX headings"
  },
  {
    "markdown": "foo\n    # bar\n",
    "html": "
foo\n# bar
\n",
    "example": 70,
    "start_line": 1206,
    "end_line": 1212,
    "section": "ATX headings"
  },
  {
    "markdown": "## foo ##\n  ###   bar    ###\n",
    "html": "
foo
\n
bar
\n",
    "example": 71,
    "start_line": 1217,
    "end_line": 1223,
    "section": "ATX headings"
  },
  {
    "markdown": "# foo ##################################\n##### foo ##\n",
    "html": "
foo
\n
foo
\n",
    "example": 72,
    "start_line": 1228,
    "end_line": 1234,
    "section": "ATX headings"
  },
  {
    "markdown": "### foo ###     \n",
    "html": "
foo
\n",
    "example": 73,
    "start_line": 1239,
    "end_line": 1243,
    "section": "ATX headings"
  },
  {
    "markdown": "### foo ### b\n",
    "html": "
foo ### b
\n",
    "example": 74,
    "start_line": 1250,
    "end_line": 1254,
    "section": "ATX headings"
  },
  {
    "markdown": "# foo#\n",
    "html": "
foo#
\n",
    "example": 75,
    "start_line": 1259,
    "end_line": 1263,
    "section": "ATX headings"
  },
  {
    "markdown": "### foo \\###\n## foo #\\##\n# foo \\#\n",
    "html": "
foo ###
\n
foo ###
\n
foo #
\n",
    "example": 76,
    "start_line": 1269,
    "end_line": 1277,
    "section": "ATX headings"
  },
  {
    "markdown": "****\n## foo\n****\n",
    "html": "
\n
foo
\n
\n",
    "example": 77,
    "start_line": 1283,
    "end_line": 1291,
    "section": "ATX headings"
  },
  {
    "markdown": "Foo bar\n# baz\nBar foo\n",
    "html": "
Foo bar
\n
baz
\n
Bar foo
\n",
    "example": 78,
    "start_line": 1294,
    "end_line": 1302,
    "section": "ATX headings"
  },
  {
    "markdown": "## \n#\n### ###\n",
    "html": "
\n
\n
\n",
    "example": 79,
    "start_line": 1307,
    "end_line": 1315,
    "section": "ATX headings"
  },
  {
    "markdown": "Foo *bar*\n=========\n\nFoo *bar*\n---------\n",
    "html": "
Foo bar
\n
Foo bar
\n",
    "example": 80,
    "start_line": 1347,
    "end_line": 1356,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo *bar\nbaz*\n====\n",
    "html": "
Foo bar\nbaz
\n",
    "example": 81,
    "start_line": 1361,
    "end_line": 1368,
    "section": "Setext headings"
  },
  {
    "markdown": "  Foo *bar\nbaz*\t\n====\n",
    "html": "
Foo bar\nbaz
\n",
    "example": 82,
    "start_line": 1375,
    "end_line": 1382,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\n-------------------------\n\nFoo\n=\n",
    "html": "
Foo
\n
Foo
\n",
    "example": 83,
    "start_line": 1387,
    "end_line": 1396,
    "section": "Setext headings"
  },
  {
    "markdown": "   Foo\n---\n\n  Foo\n-----\n\n  Foo\n  ===\n",
    "html": "
Foo
\n
Foo
\n
Foo
\n",
    "example": 84,
    "start_line": 1402,
    "end_line": 1415,
    "section": "Setext headings"
  },
  {
    "markdown": "    Foo\n    ---\n\n    Foo\n---\n",
    "html": "
Foo\n---\n\nFoo\n
\n
\n",
    "example": 85,
    "start_line": 1420,
    "end_line": 1433,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\n   ----      \n",
    "html": "
Foo
\n",
    "example": 86,
    "start_line": 1439,
    "end_line": 1444,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\n    ---\n",
    "html": "
Foo\n---
\n",
    "example": 87,
    "start_line": 1449,
    "end_line": 1455,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\n= =\n\nFoo\n--- -\n",
    "html": "
Foo\n= =
\n
Foo
\n
\n",
    "example": 88,
    "start_line": 1460,
    "end_line": 1471,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo  \n-----\n",
    "html": "
Foo
\n",
    "example": 89,
    "start_line": 1476,
    "end_line": 1481,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\\\n----\n",
    "html": "
Foo\\
\n",
    "example": 90,
    "start_line": 1486,
    "end_line": 1491,
    "section": "Setext headings"
  },
  {
    "markdown": "`Foo\n----\n`\n\n\n",
    "html": "
`Foo
\n
`
\n
<a title="a lot
\n
of dashes"/>
\n",
    "example": 91,
    "start_line": 1497,
    "end_line": 1510,
    "section": "Setext headings"
  },
  {
    "markdown": "> Foo\n---\n",
    "html": "
\n
Foo
\n
\n
\n",
    "example": 92,
    "start_line": 1516,
    "end_line": 1524,
    "section": "Setext headings"
  },
  {
    "markdown": "> foo\nbar\n===\n",
    "html": "
\n
foo\nbar\n===
\n
\n",
    "example": 93,
    "start_line": 1527,
    "end_line": 1537,
    "section": "Setext headings"
  },
  {
    "markdown": "- Foo\n---\n",
    "html": "
    \n
  • Foo
    • \n
\n
\n",
    "example": 94,
    "start_line": 1540,
    "end_line": 1548,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\nBar\n---\n",
    "html": "
Foo\nBar
\n",
    "example": 95,
    "start_line": 1555,
    "end_line": 1562,
    "section": "Setext headings"
  },
  {
    "markdown": "---\nFoo\n---\nBar\n---\nBaz\n",
    "html": "
\n
Foo
\n
Bar
\n
Baz
\n",
    "example": 96,
    "start_line": 1568,
    "end_line": 1580,
    "section": "Setext headings"
  },
  {
    "markdown": "\n====\n",
    "html": "
====
\n",
    "example": 97,
    "start_line": 1585,
    "end_line": 1590,
    "section": "Setext headings"
  },
  {
    "markdown": "---\n---\n",
    "html": "
\n
\n",
    "example": 98,
    "start_line": 1597,
    "end_line": 1603,
    "section": "Setext headings"
  },
  {
    "markdown": "- foo\n-----\n",
    "html": "
    \n
  • foo
    • \n
\n
\n",
    "example": 99,
    "start_line": 1606,
    "end_line": 1614,
    "section": "Setext headings"
  },
  {
    "markdown": "    foo\n---\n",
    "html": "
foo\n
\n
\n",
    "example": 100,
    "start_line": 1617,
    "end_line": 1624,
    "section": "Setext headings"
  },
  {
    "markdown": "> foo\n-----\n",
    "html": "
\n
foo
\n
\n
\n",
    "example": 101,
    "start_line": 1627,
    "end_line": 1635,
    "section": "Setext headings"
  },
  {
    "markdown": "\\> foo\n------\n",
    "html": "
> foo
\n",
    "example": 102,
    "start_line": 1641,
    "end_line": 1646,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\n\nbar\n---\nbaz\n",
    "html": "
Foo
\n
bar
\n
baz
\n",
    "example": 103,
    "start_line": 1672,
    "end_line": 1682,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\nbar\n\n---\n\nbaz\n",
    "html": "
Foo\nbar
\n
\n
baz
\n",
    "example": 104,
    "start_line": 1688,
    "end_line": 1700,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\nbar\n* * *\nbaz\n",
    "html": "
Foo\nbar
\n
\n
baz
\n",
    "example": 105,
    "start_line": 1706,
    "end_line": 1716,
    "section": "Setext headings"
  },
  {
    "markdown": "Foo\nbar\n\\---\nbaz\n",
    "html": "
Foo\nbar\n---\nbaz
\n",
    "example": 106,
    "start_line": 1721,
    "end_line": 1731,
    "section": "Setext headings"
  },
  {
    "markdown": "    a simple\n      indented code block\n",
    "html": "
a simple\n  indented code block\n
\n",
    "example": 107,
    "start_line": 1749,
    "end_line": 1756,
    "section": "Indented code blocks"
  },
  {
    "markdown": "  - foo\n\n    bar\n",
    "html": "
    \n
  • \n
    foo
    \n
    bar
    \n
    • \n
\n",
    "example": 108,
    "start_line": 1763,
    "end_line": 1774,
    "section": "Indented code blocks"
  },
  {
    "markdown": "1.  foo\n\n    - bar\n",
    "html": "
    \n
  1. \n
    foo
    \n
      \n
    • bar
      • \n
    \n
    2. \n
\n",
    "example": 109,
    "start_line": 1777,
    "end_line": 1790,
    "section": "Indented code blocks"
  },
  {
    "markdown": "    \n    *hi*\n\n    - one\n",
    "html": "
<a/>\n*hi*\n\n- one\n
\n",
    "example": 110,
    "start_line": 1797,
    "end_line": 1808,
    "section": "Indented code blocks"
  },
  {
    "markdown": "    chunk1\n\n    chunk2\n  \n \n \n    chunk3\n",
    "html": "
chunk1\n\nchunk2\n\n\n\nchunk3\n
\n",
    "example": 111,
    "start_line": 1813,
    "end_line": 1830,
    "section": "Indented code blocks"
  },
  {
    "markdown": "    chunk1\n      \n      chunk2\n",
    "html": "
chunk1\n  \n  chunk2\n
\n",
    "example": 112,
    "start_line": 1836,
    "end_line": 1845,
    "section": "Indented code blocks"
  },
  {
    "markdown": "Foo\n    bar\n\n",
    "html": "
Foo\nbar
\n",
    "example": 113,
    "start_line": 1851,
    "end_line": 1858,
    "section": "Indented code blocks"
  },
  {
    "markdown": "    foo\nbar\n",
    "html": "
foo\n
\n
bar
\n",
    "example": 114,
    "start_line": 1865,
    "end_line": 1872,
    "section": "Indented code blocks"
  },
  {
    "markdown": "# Heading\n    foo\nHeading\n------\n    foo\n----\n",
    "html": "
Heading
\n
foo\n
\n
Heading
\n
foo\n
\n
\n",
    "example": 115,
    "start_line": 1878,
    "end_line": 1893,
    "section": "Indented code blocks"
  },
  {
    "markdown": "        foo\n    bar\n",
    "html": "
    foo\nbar\n
\n",
    "example": 116,
    "start_line": 1898,
    "end_line": 1905,
    "section": "Indented code blocks"
  },
  {
    "markdown": "\n    \n    foo\n    \n\n",
    "html": "
foo\n
\n",
    "example": 117,
    "start_line": 1911,
    "end_line": 1920,
    "section": "Indented code blocks"
  },
  {
    "markdown": "    foo  \n",
    "html": "
foo  \n
\n",
    "example": 118,
    "start_line": 1925,
    "end_line": 1930,
    "section": "Indented code blocks"
  },
  {
    "markdown": "```\n<\n >\n```\n",
    "html": "
<\n >\n
\n",
    "example": 119,
    "start_line": 1980,
    "end_line": 1989,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "~~~\n<\n >\n~~~\n",
    "html": "
<\n >\n
\n",
    "example": 120,
    "start_line": 1994,
    "end_line": 2003,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "``\nfoo\n``\n",
    "html": "
foo
\n",
    "example": 121,
    "start_line": 2007,
    "end_line": 2013,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```\naaa\n~~~\n```\n",
    "html": "
aaa\n~~~\n
\n",
    "example": 122,
    "start_line": 2018,
    "end_line": 2027,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "~~~\naaa\n```\n~~~\n",
    "html": "
aaa\n```\n
\n",
    "example": 123,
    "start_line": 2030,
    "end_line": 2039,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "````\naaa\n```\n``````\n",
    "html": "
aaa\n```\n
\n",
    "example": 124,
    "start_line": 2044,
    "end_line": 2053,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "~~~~\naaa\n~~~\n~~~~\n",
    "html": "
aaa\n~~~\n
\n",
    "example": 125,
    "start_line": 2056,
    "end_line": 2065,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```\n",
    "html": "
\n",
    "example": 126,
    "start_line": 2071,
    "end_line": 2075,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "`````\n\n```\naaa\n",
    "html": "
\n```\naaa\n
\n",
    "example": 127,
    "start_line": 2078,
    "end_line": 2088,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "> ```\n> aaa\n\nbbb\n",
    "html": "
\n
aaa\n
\n
\n
bbb
\n",
    "example": 128,
    "start_line": 2091,
    "end_line": 2102,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```\n\n  \n```\n",
    "html": "
\n  \n
\n",
    "example": 129,
    "start_line": 2107,
    "end_line": 2116,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```\n```\n",
    "html": "
\n",
    "example": 130,
    "start_line": 2121,
    "end_line": 2126,
    "section": "Fenced code blocks"
  },
  {
    "markdown": " ```\n aaa\naaa\n```\n",
    "html": "
aaa\naaa\n
\n",
    "example": 131,
    "start_line": 2133,
    "end_line": 2142,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "  ```\naaa\n  aaa\naaa\n  ```\n",
    "html": "
aaa\naaa\naaa\n
\n",
    "example": 132,
    "start_line": 2145,
    "end_line": 2156,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "   ```\n   aaa\n    aaa\n  aaa\n   ```\n",
    "html": "
aaa\n aaa\naaa\n
\n",
    "example": 133,
    "start_line": 2159,
    "end_line": 2170,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "    ```\n    aaa\n    ```\n",
    "html": "
```\naaa\n```\n
\n",
    "example": 134,
    "start_line": 2175,
    "end_line": 2184,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```\naaa\n  ```\n",
    "html": "
aaa\n
\n",
    "example": 135,
    "start_line": 2190,
    "end_line": 2197,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "   ```\naaa\n  ```\n",
    "html": "
aaa\n
\n",
    "example": 136,
    "start_line": 2200,
    "end_line": 2207,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```\naaa\n    ```\n",
    "html": "
aaa\n    ```\n
\n",
    "example": 137,
    "start_line": 2212,
    "end_line": 2220,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "``` ```\naaa\n",
    "html": "
 \naaa
\n",
    "example": 138,
    "start_line": 2226,
    "end_line": 2232,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "~~~~~~\naaa\n~~~ ~~\n",
    "html": "
aaa\n~~~ ~~\n
\n",
    "example": 139,
    "start_line": 2235,
    "end_line": 2243,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "foo\n```\nbar\n```\nbaz\n",
    "html": "
foo
\n
bar\n
\n
baz
\n",
    "example": 140,
    "start_line": 2249,
    "end_line": 2260,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "foo\n---\n~~~\nbar\n~~~\n# baz\n",
    "html": "
foo
\n
bar\n
\n
baz
\n",
    "example": 141,
    "start_line": 2266,
    "end_line": 2278,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```ruby\ndef foo(x)\n  return 3\nend\n```\n",
    "html": "
def foo(x)\n  return 3\nend\n
\n",
    "example": 142,
    "start_line": 2288,
    "end_line": 2299,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "~~~~    ruby startline=3 $%@#$\ndef foo(x)\n  return 3\nend\n~~~~~~~\n",
    "html": "
def foo(x)\n  return 3\nend\n
\n",
    "example": 143,
    "start_line": 2302,
    "end_line": 2313,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "````;\n````\n",
    "html": "
\n",
    "example": 144,
    "start_line": 2316,
    "end_line": 2321,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "``` aa ```\nfoo\n",
    "html": "
aa\nfoo
\n",
    "example": 145,
    "start_line": 2326,
    "end_line": 2332,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "~~~ aa ``` ~~~\nfoo\n~~~\n",
    "html": "
foo\n
\n",
    "example": 146,
    "start_line": 2337,
    "end_line": 2344,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "```\n``` aaa\n```\n",
    "html": "
``` aaa\n
\n",
    "example": 147,
    "start_line": 2349,
    "end_line": 2356,
    "section": "Fenced code blocks"
  },
  {
    "markdown": "
\n
\n**Hello**,\n\n_world_.\n
\n
\n",
    "html": "
\n
\n**Hello**,\n
world.\n
\n
\n",
    "example": 148,
    "start_line": 2428,
    "end_line": 2443,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n  \n    \n  \n
\n           hi\n    
\n\nokay.\n",
    "html": "\n  \n    \n  \n
\n           hi\n    
\n
okay.
\n",
    "example": 149,
    "start_line": 2457,
    "end_line": 2476,
    "section": "HTML blocks"
  },
  {
    "markdown": " \n*foo*\n",
    "example": 151,
    "start_line": 2492,
    "end_line": 2498,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\n\n*Markdown*\n\n
\n",
    "html": "
\n
Markdown
\n
\n",
    "example": 152,
    "start_line": 2503,
    "end_line": 2513,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\n
\n",
    "html": "
\n
\n",
    "example": 153,
    "start_line": 2519,
    "end_line": 2527,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\n
\n",
    "html": "
\n
\n",
    "example": 154,
    "start_line": 2530,
    "end_line": 2538,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\n*foo*\n\n*bar*\n",
    "html": "
\n*foo*\n
bar
\n",
    "example": 155,
    "start_line": 2542,
    "end_line": 2551,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n",
    "html": "\n",
    "example": 159,
    "start_line": 2591,
    "end_line": 2595,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\nfoo\n
\n",
    "html": "
\nfoo\n
\n",
    "example": 160,
    "start_line": 2598,
    "end_line": 2606,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\n``` c\nint x = 33;\n```\n",
    "html": "
\n``` c\nint x = 33;\n```\n",
    "example": 161,
    "start_line": 2615,
    "end_line": 2625,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n*bar*\n\n",
    "html": "\n*bar*\n\n",
    "example": 162,
    "start_line": 2632,
    "end_line": 2640,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n*bar*\n\n",
    "html": "\n*bar*\n\n",
    "example": 163,
    "start_line": 2645,
    "end_line": 2653,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n*bar*\n\n",
    "html": "\n*bar*\n\n",
    "example": 164,
    "start_line": 2656,
    "end_line": 2664,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n*bar*\n",
    "html": "\n*bar*\n",
    "example": 165,
    "start_line": 2667,
    "end_line": 2673,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n*foo*\n\n",
    "html": "\n*foo*\n\n",
    "example": 166,
    "start_line": 2682,
    "end_line": 2690,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n\n*foo*\n\n\n",
    "html": "\n
foo
\n\n",
    "example": 167,
    "start_line": 2697,
    "end_line": 2707,
    "section": "HTML blocks"
  },
  {
    "markdown": "*foo*\n",
    "html": "
foo
\n",
    "example": 168,
    "start_line": 2715,
    "end_line": 2719,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\nimport Text.HTML.TagSoup\n\nmain :: IO ()\nmain = print $ parseTags tags\n
\nokay\n",
    "html": "
\nimport Text.HTML.TagSoup\n\nmain :: IO ()\nmain = print $ parseTags tags\n
\n
okay
\n",
    "example": 169,
    "start_line": 2731,
    "end_line": 2747,
    "section": "HTML blocks"
  },
  {
    "markdown": "\nokay\n",
    "html": "\n
okay
\n",
    "example": 170,
    "start_line": 2752,
    "end_line": 2766,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n",
    "html": "\n",
    "example": 171,
    "start_line": 2771,
    "end_line": 2787,
    "section": "HTML blocks"
  },
  {
    "markdown": "\nh1 {color:red;}\n\np {color:blue;}\n\nokay\n",
    "html": "\nh1 {color:red;}\n\np {color:blue;}\n\n
okay
\n",
    "example": 172,
    "start_line": 2791,
    "end_line": 2807,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n\nfoo\n",
    "html": "\n\nfoo\n",
    "example": 173,
    "start_line": 2814,
    "end_line": 2824,
    "section": "HTML blocks"
  },
  {
    "markdown": "> 
\n> foo\n\nbar\n",
    "html": "
\n
\nfoo\n
\n
bar
\n",
    "example": 174,
    "start_line": 2827,
    "end_line": 2838,
    "section": "HTML blocks"
  },
  {
    "markdown": "- 
\n- foo\n",
    "html": "
    \n
  • \n
    \n
    • \n
  • foo
    • \n
\n",
    "example": 175,
    "start_line": 2841,
    "end_line": 2851,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n*foo*\n",
    "html": "\n
foo
\n",
    "example": 176,
    "start_line": 2856,
    "end_line": 2862,
    "section": "HTML blocks"
  },
  {
    "markdown": "*bar*\n*baz*\n",
    "html": "*bar*\n
baz
\n",
    "example": 177,
    "start_line": 2865,
    "end_line": 2871,
    "section": "HTML blocks"
  },
  {
    "markdown": "1. *bar*\n",
    "html": "1. *bar*\n",
    "example": 178,
    "start_line": 2877,
    "end_line": 2885,
    "section": "HTML blocks"
  },
  {
    "markdown": "\nokay\n",
    "html": "\n
okay
\n",
    "example": 179,
    "start_line": 2890,
    "end_line": 2902,
    "section": "HTML blocks"
  },
  {
    "markdown": "';\n\n?>\nokay\n",
    "html": "';\n\n?>\n
okay
\n",
    "example": 180,
    "start_line": 2908,
    "end_line": 2922,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n",
    "html": "\n",
    "example": 181,
    "start_line": 2927,
    "end_line": 2931,
    "section": "HTML blocks"
  },
  {
    "markdown": "\nokay\n",
    "html": "\n
okay
\n",
    "example": 182,
    "start_line": 2936,
    "end_line": 2964,
    "section": "HTML blocks"
  },
  {
    "markdown": "  \n\n    \n",
    "html": "  \n
<!-- foo -->\n
\n",
    "example": 183,
    "start_line": 2970,
    "end_line": 2978,
    "section": "HTML blocks"
  },
  {
    "markdown": "  
\n\n    
\n",
    "html": "  
\n
<div>\n
\n",
    "example": 184,
    "start_line": 2981,
    "end_line": 2989,
    "section": "HTML blocks"
  },
  {
    "markdown": "Foo\n
\nbar\n
\n",
    "html": "
Foo
\n
\nbar\n
\n",
    "example": 185,
    "start_line": 2995,
    "end_line": 3005,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\nbar\n
\n*foo*\n",
    "html": "
\nbar\n
\n*foo*\n",
    "example": 186,
    "start_line": 3012,
    "end_line": 3022,
    "section": "HTML blocks"
  },
  {
    "markdown": "Foo\n\nbaz\n",
    "html": "
Foo\n\nbaz
\n",
    "example": 187,
    "start_line": 3027,
    "end_line": 3035,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\n\n*Emphasized* text.\n\n
\n",
    "html": "
\n
Emphasized text.
\n
\n",
    "example": 188,
    "start_line": 3068,
    "end_line": 3078,
    "section": "HTML blocks"
  },
  {
    "markdown": "
\n*Emphasized* text.\n
\n",
    "html": "
\n*Emphasized* text.\n
\n",
    "example": 189,
    "start_line": 3081,
    "end_line": 3089,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n\n\n\n\n\n\n\n
\nHi\n
\n",
    "html": "\n\n\n\n
\nHi\n
\n",
    "example": 190,
    "start_line": 3103,
    "end_line": 3123,
    "section": "HTML blocks"
  },
  {
    "markdown": "\n\n  \n\n    \n\n  \n\n
\n      Hi\n    
\n",
    "html": "\n  \n
<td>\n  Hi\n</td>\n
\n  \n
\n",
    "example": 191,
    "start_line": 3130,
    "end_line": 3151,
    "section": "HTML blocks"
  },
  {
    "markdown": "[foo]: /url \"title\"\n\n[foo]\n",
    "html": "
foo
\n",
    "example": 192,
    "start_line": 3179,
    "end_line": 3185,
    "section": "Link reference definitions"
  },
  {
    "markdown": "   [foo]: \n      /url  \n           'the title'  \n\n[foo]\n",
    "html": "
foo
\n",
    "example": 193,
    "start_line": 3188,
    "end_line": 3196,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[Foo*bar\\]]:my_(url) 'title (with parens)'\n\n[Foo*bar\\]]\n",
    "html": "
Foo*bar]
\n",
    "example": 194,
    "start_line": 3199,
    "end_line": 3205,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[Foo bar]:\n\n'title'\n\n[Foo bar]\n",
    "html": "
Foo bar
\n",
    "example": 195,
    "start_line": 3208,
    "end_line": 3216,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url '\ntitle\nline1\nline2\n'\n\n[foo]\n",
    "html": "
foo
\n",
    "example": 196,
    "start_line": 3221,
    "end_line": 3235,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url 'title\n\nwith blank line'\n\n[foo]\n",
    "html": "
[foo]: /url 'title
\n
with blank line'
\n
[foo]
\n",
    "example": 197,
    "start_line": 3240,
    "end_line": 3250,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]:\n/url\n\n[foo]\n",
    "html": "
foo
\n",
    "example": 198,
    "start_line": 3255,
    "end_line": 3262,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]:\n\n[foo]\n",
    "html": "
[foo]:
\n
[foo]
\n",
    "example": 199,
    "start_line": 3267,
    "end_line": 3274,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: <>\n\n[foo]\n",
    "html": "
foo
\n",
    "example": 200,
    "start_line": 3279,
    "end_line": 3285,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: (baz)\n\n[foo]\n",
    "html": "
[foo]: (baz)
\n
[foo]
\n",
    "example": 201,
    "start_line": 3290,
    "end_line": 3297,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url\\bar\\*baz \"foo\\\"bar\\baz\"\n\n[foo]\n",
    "html": "
foo
\n",
    "example": 202,
    "start_line": 3303,
    "end_line": 3309,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]\n\n[foo]: url\n",
    "html": "
foo
\n",
    "example": 203,
    "start_line": 3314,
    "end_line": 3320,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]\n\n[foo]: first\n[foo]: second\n",
    "html": "
foo
\n",
    "example": 204,
    "start_line": 3326,
    "end_line": 3333,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[FOO]: /url\n\n[Foo]\n",
    "html": "
Foo
\n",
    "example": 205,
    "start_line": 3339,
    "end_line": 3345,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[ΑΓΩ]: /φου\n\n[αγω]\n",
    "html": "
αγω
\n",
    "example": 206,
    "start_line": 3348,
    "end_line": 3354,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url\n",
    "html": "",
    "example": 207,
    "start_line": 3363,
    "end_line": 3366,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[\nfoo\n]: /url\nbar\n",
    "html": "
bar
\n",
    "example": 208,
    "start_line": 3371,
    "end_line": 3378,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url \"title\" ok\n",
    "html": "
[foo]: /url "title" ok
\n",
    "example": 209,
    "start_line": 3384,
    "end_line": 3388,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url\n\"title\" ok\n",
    "html": "
"title" ok
\n",
    "example": 210,
    "start_line": 3393,
    "end_line": 3398,
    "section": "Link reference definitions"
  },
  {
    "markdown": "    [foo]: /url \"title\"\n\n[foo]\n",
    "html": "
[foo]: /url "title"\n
\n
[foo]
\n",
    "example": 211,
    "start_line": 3404,
    "end_line": 3412,
    "section": "Link reference definitions"
  },
  {
    "markdown": "```\n[foo]: /url\n```\n\n[foo]\n",
    "html": "
[foo]: /url\n
\n
[foo]
\n",
    "example": 212,
    "start_line": 3418,
    "end_line": 3428,
    "section": "Link reference definitions"
  },
  {
    "markdown": "Foo\n[bar]: /baz\n\n[bar]\n",
    "html": "
Foo\n[bar]: /baz
\n
[bar]
\n",
    "example": 213,
    "start_line": 3433,
    "end_line": 3442,
    "section": "Link reference definitions"
  },
  {
    "markdown": "# [Foo]\n[foo]: /url\n> bar\n",
    "html": "
Foo
\n
\n
bar
\n
\n",
    "example": 214,
    "start_line": 3448,
    "end_line": 3457,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url\nbar\n===\n[foo]\n",
    "html": "
bar
\n
foo
\n",
    "example": 215,
    "start_line": 3459,
    "end_line": 3467,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /url\n===\n[foo]\n",
    "html": "
===\nfoo
\n",
    "example": 216,
    "start_line": 3469,
    "end_line": 3476,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]: /foo-url \"foo\"\n[bar]: /bar-url\n  \"bar\"\n[baz]: /baz-url\n\n[foo],\n[bar],\n[baz]\n",
    "html": "
foo,\nbar,\nbaz
\n",
    "example": 217,
    "start_line": 3482,
    "end_line": 3495,
    "section": "Link reference definitions"
  },
  {
    "markdown": "[foo]\n\n> [foo]: /url\n",
    "html": "
foo
\n
\n
\n",
    "example": 218,
    "start_line": 3503,
    "end_line": 3511,
    "section": "Link reference definitions"
  },
  {
    "markdown": "aaa\n\nbbb\n",
    "html": "
aaa
\n
bbb
\n",
    "example": 219,
    "start_line": 3525,
    "end_line": 3532,
    "section": "Paragraphs"
  },
  {
    "markdown": "aaa\nbbb\n\nccc\nddd\n",
    "html": "
aaa\nbbb
\n
ccc\nddd
\n",
    "example": 220,
    "start_line": 3537,
    "end_line": 3548,
    "section": "Paragraphs"
  },
  {
    "markdown": "aaa\n\n\nbbb\n",
    "html": "
aaa
\n
bbb
\n",
    "example": 221,
    "start_line": 3553,
    "end_line": 3561,
    "section": "Paragraphs"
  },
  {
    "markdown": "  aaa\n bbb\n",
    "html": "
aaa\nbbb
\n",
    "example": 222,
    "start_line": 3566,
    "end_line": 3572,
    "section": "Paragraphs"
  },
  {
    "markdown": "aaa\n             bbb\n                                       ccc\n",
    "html": "
aaa\nbbb\nccc
\n",
    "example": 223,
    "start_line": 3578,
    "end_line": 3586,
    "section": "Paragraphs"
  },
  {
    "markdown": "   aaa\nbbb\n",
    "html": "
aaa\nbbb
\n",
    "example": 224,
    "start_line": 3592,
    "end_line": 3598,
    "section": "Paragraphs"
  },
  {
    "markdown": "    aaa\nbbb\n",
    "html": "
aaa\n
\n
bbb
\n",
    "example": 225,
    "start_line": 3601,
    "end_line": 3608,
    "section": "Paragraphs"
  },
  {
    "markdown": "aaa     \nbbb     \n",
    "html": "
aaa
\nbbb
\n",
    "example": 226,
    "start_line": 3615,
    "end_line": 3621,
    "section": "Paragraphs"
  },
  {
    "markdown": "  \n\naaa\n  \n\n# aaa\n\n  \n",
    "html": "
aaa
\n
aaa
\n",
    "example": 227,
    "start_line": 3632,
    "end_line": 3644,
    "section": "Blank lines"
  },
  {
    "markdown": "> # Foo\n> bar\n> baz\n",
    "html": "
\n
Foo
\n
bar\nbaz
\n
\n",
    "example": 228,
    "start_line": 3700,
    "end_line": 3710,
    "section": "Block quotes"
  },
  {
    "markdown": "># Foo\n>bar\n> baz\n",
    "html": "
\n
Foo
\n
bar\nbaz
\n
\n",
    "example": 229,
    "start_line": 3715,
    "end_line": 3725,
    "section": "Block quotes"
  },
  {
    "markdown": "   > # Foo\n   > bar\n > baz\n",
    "html": "
\n
Foo
\n
bar\nbaz
\n
\n",
    "example": 230,
    "start_line": 3730,
    "end_line": 3740,
    "section": "Block quotes"
  },
  {
    "markdown": "    > # Foo\n    > bar\n    > baz\n",
    "html": "
> # Foo\n> bar\n> baz\n
\n",
    "example": 231,
    "start_line": 3745,
    "end_line": 3754,
    "section": "Block quotes"
  },
  {
    "markdown": "> # Foo\n> bar\nbaz\n",
    "html": "
\n
Foo
\n
bar\nbaz
\n
\n",
    "example": 232,
    "start_line": 3760,
    "end_line": 3770,
    "section": "Block quotes"
  },
  {
    "markdown": "> bar\nbaz\n> foo\n",
    "html": "
\n
bar\nbaz\nfoo
\n
\n",
    "example": 233,
    "start_line": 3776,
    "end_line": 3786,
    "section": "Block quotes"
  },
  {
    "markdown": "> foo\n---\n",
    "html": "
\n
foo
\n
\n
\n",
    "example": 234,
    "start_line": 3800,
    "end_line": 3808,
    "section": "Block quotes"
  },
  {
    "markdown": "> - foo\n- bar\n",
    "html": "
\n
    \n
  • foo
    • \n
\n
\n
    \n
  • bar
    • \n
\n",
    "example": 235,
    "start_line": 3820,
    "end_line": 3832,
    "section": "Block quotes"
  },
  {
    "markdown": ">     foo\n    bar\n",
    "html": "
\n
foo\n
\n
\n
bar\n
\n",
    "example": 236,
    "start_line": 3838,
    "end_line": 3848,
    "section": "Block quotes"
  },
  {
    "markdown": "> ```\nfoo\n```\n",
    "html": "
\n
\n
\n
foo
\n
\n",
    "example": 237,
    "start_line": 3851,
    "end_line": 3861,
    "section": "Block quotes"
  },
  {
    "markdown": "> foo\n    - bar\n",
    "html": "
\n
foo\n- bar
\n
\n",
    "example": 238,
    "start_line": 3867,
    "end_line": 3875,
    "section": "Block quotes"
  },
  {
    "markdown": ">\n",
    "html": "
\n
\n",
    "example": 239,
    "start_line": 3891,
    "end_line": 3896,
    "section": "Block quotes"
  },
  {
    "markdown": ">\n>  \n> \n",
    "html": "
\n
\n",
    "example": 240,
    "start_line": 3899,
    "end_line": 3906,
    "section": "Block quotes"
  },
  {
    "markdown": ">\n> foo\n>  \n",
    "html": "
\n
foo
\n
\n",
    "example": 241,
    "start_line": 3911,
    "end_line": 3919,
    "section": "Block quotes"
  },
  {
    "markdown": "> foo\n\n> bar\n",
    "html": "
\n
foo
\n
\n
\n
bar
\n
\n",
    "example": 242,
    "start_line": 3924,
    "end_line": 3935,
    "section": "Block quotes"
  },
  {
    "markdown": "> foo\n> bar\n",
    "html": "
\n
foo\nbar
\n
\n",
    "example": 243,
    "start_line": 3946,
    "end_line": 3954,
    "section": "Block quotes"
  },
  {
    "markdown": "> foo\n>\n> bar\n",
    "html": "
\n
foo
\n
bar
\n
\n",
    "example": 244,
    "start_line": 3959,
    "end_line": 3968,
    "section": "Block quotes"
  },
  {
    "markdown": "foo\n> bar\n",
    "html": "
foo
\n
\n
bar
\n
\n",
    "example": 245,
    "start_line": 3973,
    "end_line": 3981,
    "section": "Block quotes"
  },
  {
    "markdown": "> aaa\n***\n> bbb\n",
    "html": "
\n
aaa
\n
\n
\n
\n
bbb
\n
\n",
    "example": 246,
    "start_line": 3987,
    "end_line": 3999,
    "section": "Block quotes"
  },
  {
    "markdown": "> bar\nbaz\n",
    "html": "
\n
bar\nbaz
\n
\n",
    "example": 247,
    "start_line": 4005,
    "end_line": 4013,
    "section": "Block quotes"
  },
  {
    "markdown": "> bar\n\nbaz\n",
    "html": "
\n
bar
\n
\n
baz
\n",
    "example": 248,
    "start_line": 4016,
    "end_line": 4025,
    "section": "Block quotes"
  },
  {
    "markdown": "> bar\n>\nbaz\n",
    "html": "
\n
bar
\n
\n
baz
\n",
    "example": 249,
    "start_line": 4028,
    "end_line": 4037,
    "section": "Block quotes"
  },
  {
    "markdown": "> > > foo\nbar\n",
    "html": "
\n
\n
\n
foo\nbar
\n
\n
\n
\n",
    "example": 250,
    "start_line": 4044,
    "end_line": 4056,
    "section": "Block quotes"
  },
  {
    "markdown": ">>> foo\n> bar\n>>baz\n",
    "html": "
\n
\n
\n
foo\nbar\nbaz
\n
\n
\n
\n",
    "example": 251,
    "start_line": 4059,
    "end_line": 4073,
    "section": "Block quotes"
  },
  {
    "markdown": ">     code\n\n>    not code\n",
    "html": "
\n
code\n
\n
\n
\n
not code
\n
\n",
    "example": 252,
    "start_line": 4081,
    "end_line": 4093,
    "section": "Block quotes"
  },
  {
    "markdown": "A paragraph\nwith two lines.\n\n    indented code\n\n> A block quote.\n",
    "html": "
A paragraph\nwith two lines.
\n
indented code\n
\n
\n
A block quote.
\n
\n",
    "example": 253,
    "start_line": 4135,
    "end_line": 4150,
    "section": "List items"
  },
  {
    "markdown": "1.  A paragraph\n    with two lines.\n\n        indented code\n\n    > A block quote.\n",
    "html": "
    \n
  1. \n
    A paragraph\nwith two lines.
    \n
    indented code\n
    \n
    \n
    A block quote.
    \n
    \n
    2. \n
\n",
    "example": 254,
    "start_line": 4157,
    "end_line": 4176,
    "section": "List items"
  },
  {
    "markdown": "- one\n\n two\n",
    "html": "
    \n
  • one
    • \n
\n
two
\n",
    "example": 255,
    "start_line": 4190,
    "end_line": 4199,
    "section": "List items"
  },
  {
    "markdown": "- one\n\n  two\n",
    "html": "
    \n
  • \n
    one
    \n
    two
    \n
    • \n
\n",
    "example": 256,
    "start_line": 4202,
    "end_line": 4213,
    "section": "List items"
  },
  {
    "markdown": " -    one\n\n     two\n",
    "html": "
    \n
  • one
    • \n
\n
 two\n
\n",
    "example": 257,
    "start_line": 4216,
    "end_line": 4226,
    "section": "List items"
  },
  {
    "markdown": " -    one\n\n      two\n",
    "html": "
    \n
  • \n
    one
    \n
    two
    \n
    • \n
\n",
    "example": 258,
    "start_line": 4229,
    "end_line": 4240,
    "section": "List items"
  },
  {
    "markdown": "   > > 1.  one\n>>\n>>     two\n",
    "html": "
\n
\n
    \n
  1. \n
    one
    \n
    two
    \n
    2. \n
\n
\n
\n",
    "example": 259,
    "start_line": 4251,
    "end_line": 4266,
    "section": "List items"
  },
  {
    "markdown": ">>- one\n>>\n  >  > two\n",
    "html": "
\n
\n
    \n
  • one
    • \n
\n
two
\n
\n
\n",
    "example": 260,
    "start_line": 4278,
    "end_line": 4291,
    "section": "List items"
  },
  {
    "markdown": "-one\n\n2.two\n",
    "html": "
-one
\n
2.two
\n",
    "example": 261,
    "start_line": 4297,
    "end_line": 4304,
    "section": "List items"
  },
  {
    "markdown": "- foo\n\n\n  bar\n",
    "html": "
    \n
  • \n
    foo
    \n
    bar
    \n
    • \n
\n",
    "example": 262,
    "start_line": 4310,
    "end_line": 4322,
    "section": "List items"
  },
  {
    "markdown": "1.  foo\n\n    ```\n    bar\n    ```\n\n    baz\n\n    > bam\n",
    "html": "
    \n
  1. \n
    foo
    \n
    bar\n
    \n
    baz
    \n
    \n
    bam
    \n
    \n
    2. \n
\n",
    "example": 263,
    "start_line": 4327,
    "end_line": 4349,
    "section": "List items"
  },
  {
    "markdown": "- Foo\n\n      bar\n\n\n      baz\n",
    "html": "
    \n
  • \n
    Foo
    \n
    bar\n\n\nbaz\n
    \n
    • \n
\n",
    "example": 264,
    "start_line": 4355,
    "end_line": 4373,
    "section": "List items"
  },
  {
    "markdown": "123456789. ok\n",
    "html": "
    \n
  1. ok
    2. \n
\n",
    "example": 265,
    "start_line": 4377,
    "end_line": 4383,
    "section": "List items"
  },
  {
    "markdown": "1234567890. not ok\n",
    "html": "
1234567890. not ok
\n",
    "example": 266,
    "start_line": 4386,
    "end_line": 4390,
    "section": "List items"
  },
  {
    "markdown": "0. ok\n",
    "html": "
    \n
  1. ok
    2. \n
\n",
    "example": 267,
    "start_line": 4395,
    "end_line": 4401,
    "section": "List items"
  },
  {
    "markdown": "003. ok\n",
    "html": "
    \n
  1. ok
    2. \n
\n",
    "example": 268,
    "start_line": 4404,
    "end_line": 4410,
    "section": "List items"
  },
  {
    "markdown": "-1. not ok\n",
    "html": "
-1. not ok
\n",
    "example": 269,
    "start_line": 4415,
    "end_line": 4419,
    "section": "List items"
  },
  {
    "markdown": "- foo\n\n      bar\n",
    "html": "
    \n
  • \n
    foo
    \n
    bar\n
    \n
    • \n
\n",
    "example": 270,
    "start_line": 4438,
    "end_line": 4450,
    "section": "List items"
  },
  {
    "markdown": "  10.  foo\n\n           bar\n",
    "html": "
    \n
  1. \n
    foo
    \n
    bar\n
    \n
    2. \n
\n",
    "example": 271,
    "start_line": 4455,
    "end_line": 4467,
    "section": "List items"
  },
  {
    "markdown": "    indented code\n\nparagraph\n\n    more code\n",
    "html": "
indented code\n
\n
paragraph
\n
more code\n
\n",
    "example": 272,
    "start_line": 4474,
    "end_line": 4486,
    "section": "List items"
  },
  {
    "markdown": "1.     indented code\n\n   paragraph\n\n       more code\n",
    "html": "
    \n
  1. \n
    indented code\n
    \n
    paragraph
    \n
    more code\n
    \n
    2. \n
\n",
    "example": 273,
    "start_line": 4489,
    "end_line": 4505,
    "section": "List items"
  },
  {
    "markdown": "1.      indented code\n\n   paragraph\n\n       more code\n",
    "html": "
    \n
  1. \n
     indented code\n
    \n
    paragraph
    \n
    more code\n
    \n
    2. \n
\n",
    "example": 274,
    "start_line": 4511,
    "end_line": 4527,
    "section": "List items"
  },
  {
    "markdown": "   foo\n\nbar\n",
    "html": "
foo
\n
bar
\n",
    "example": 275,
    "start_line": 4538,
    "end_line": 4545,
    "section": "List items"
  },
  {
    "markdown": "-    foo\n\n  bar\n",
    "html": "
    \n
  • foo
    • \n
\n
bar
\n",
    "example": 276,
    "start_line": 4548,
    "end_line": 4557,
    "section": "List items"
  },
  {
    "markdown": "-  foo\n\n   bar\n",
    "html": "
    \n
  • \n
    foo
    \n
    bar
    \n
    • \n
\n",
    "example": 277,
    "start_line": 4565,
    "end_line": 4576,
    "section": "List items"
  },
  {
    "markdown": "-\n  foo\n-\n  ```\n  bar\n  ```\n-\n      baz\n",
    "html": "
    \n
  • foo
    • \n
  • \n
    bar\n
    \n
    • \n
  • \n
    baz\n
    \n
    • \n
\n",
    "example": 278,
    "start_line": 4592,
    "end_line": 4613,
    "section": "List items"
  },
  {
    "markdown": "-   \n  foo\n",
    "html": "
    \n
  • foo
    • \n
\n",
    "example": 279,
    "start_line": 4618,
    "end_line": 4625,
    "section": "List items"
  },
  {
    "markdown": "-\n\n  foo\n",
    "html": "
    \n
  • \n
\n
foo
\n",
    "example": 280,
    "start_line": 4632,
    "end_line": 4641,
    "section": "List items"
  },
  {
    "markdown": "- foo\n-\n- bar\n",
    "html": "
    \n
  • foo
    • \n
  • \n
  • bar
    • \n
\n",
    "example": 281,
    "start_line": 4646,
    "end_line": 4656,
    "section": "List items"
  },
  {
    "markdown": "- foo\n-   \n- bar\n",
    "html": "
    \n
  • foo
    • \n
  • \n
  • bar
    • \n
\n",
    "example": 282,
    "start_line": 4661,
    "end_line": 4671,
    "section": "List items"
  },
  {
    "markdown": "1. foo\n2.\n3. bar\n",
    "html": "
    \n
  1. foo
    2. \n
  2. \n
  3. bar
    4. \n
\n",
    "example": 283,
    "start_line": 4676,
    "end_line": 4686,
    "section": "List items"
  },
  {
    "markdown": "*\n",
    "html": "
    \n
  • \n
\n",
    "example": 284,
    "start_line": 4691,
    "end_line": 4697,
    "section": "List items"
  },
  {
    "markdown": "foo\n*\n\nfoo\n1.\n",
    "html": "
foo\n*
\n
foo\n1.
\n",
    "example": 285,
    "start_line": 4701,
    "end_line": 4712,
    "section": "List items"
  },
  {
    "markdown": " 1.  A paragraph\n     with two lines.\n\n         indented code\n\n     > A block quote.\n",
    "html": "
    \n
  1. \n
    A paragraph\nwith two lines.
    \n
    indented code\n
    \n
    \n
    A block quote.
    \n
    \n
    2. \n
\n",
    "example": 286,
    "start_line": 4723,
    "end_line": 4742,
    "section": "List items"
  },
  {
    "markdown": "  1.  A paragraph\n      with two lines.\n\n          indented code\n\n      > A block quote.\n",
    "html": "
    \n
  1. \n
    A paragraph\nwith two lines.
    \n
    indented code\n
    \n
    \n
    A block quote.
    \n
    \n
    2. \n
\n",
    "example": 287,
    "start_line": 4747,
    "end_line": 4766,
    "section": "List items"
  },
  {
    "markdown": "   1.  A paragraph\n       with two lines.\n\n           indented code\n\n       > A block quote.\n",
    "html": "
    \n
  1. \n
    A paragraph\nwith two lines.
    \n
    indented code\n
    \n
    \n
    A block quote.
    \n
    \n
    2. \n
\n",
    "example": 288,
    "start_line": 4771,
    "end_line": 4790,
    "section": "List items"
  },
  {
    "markdown": "    1.  A paragraph\n        with two lines.\n\n            indented code\n\n        > A block quote.\n",
    "html": "
1.  A paragraph\n    with two lines.\n\n        indented code\n\n    > A block quote.\n
\n",
    "example": 289,
    "start_line": 4795,
    "end_line": 4810,
    "section": "List items"
  },
  {
    "markdown": "  1.  A paragraph\nwith two lines.\n\n          indented code\n\n      > A block quote.\n",
    "html": "
    \n
  1. \n
    A paragraph\nwith two lines.
    \n
    indented code\n
    \n
    \n
    A block quote.
    \n
    \n
    2. \n
\n",
    "example": 290,
    "start_line": 4825,
    "end_line": 4844,
    "section": "List items"
  },
  {
    "markdown": "  1.  A paragraph\n    with two lines.\n",
    "html": "
    \n
  1. A paragraph\nwith two lines.
    2. \n
\n",
    "example": 291,
    "start_line": 4849,
    "end_line": 4857,
    "section": "List items"
  },
  {
    "markdown": "> 1. > Blockquote\ncontinued here.\n",
    "html": "
\n
    \n
  1. \n
    \n
    Blockquote\ncontinued here.
    \n
    \n
    2. \n
\n
\n",
    "example": 292,
    "start_line": 4862,
    "end_line": 4876,
    "section": "List items"
  },
  {
    "markdown": "> 1. > Blockquote\n> continued here.\n",
    "html": "
\n
    \n
  1. \n
    \n
    Blockquote\ncontinued here.
    \n
    \n
    2. \n
\n
\n",
    "example": 293,
    "start_line": 4879,
    "end_line": 4893,
    "section": "List items"
  },
  {
    "markdown": "- foo\n  - bar\n    - baz\n      - boo\n",
    "html": "
    \n
  • foo\n
      \n
    • bar\n
        \n
      • baz\n
          \n
        • boo
          • \n
        \n
        • \n
      \n
      • \n
    \n
    • \n
\n",
    "example": 294,
    "start_line": 4907,
    "end_line": 4928,
    "section": "List items"
  },
  {
    "markdown": "- foo\n - bar\n  - baz\n   - boo\n",
    "html": "
    \n
  • foo
    • \n
  • bar
    • \n
  • baz
    • \n
  • boo
    • \n
\n",
    "example": 295,
    "start_line": 4933,
    "end_line": 4945,
    "section": "List items"
  },
  {
    "markdown": "10) foo\n    - bar\n",
    "html": "
    \n
  1. foo\n
      \n
    • bar
      • \n
    \n
    2. \n
\n",
    "example": 296,
    "start_line": 4950,
    "end_line": 4961,
    "section": "List items"
  },
  {
    "markdown": "10) foo\n   - bar\n",
    "html": "
    \n
  1. foo
    2. \n
\n
    \n
  • bar
    • \n
\n",
    "example": 297,
    "start_line": 4966,
    "end_line": 4976,
    "section": "List items"
  },
  {
    "markdown": "- - foo\n",
    "html": "
    \n
  • \n
      \n
    • foo
      • \n
    \n
    • \n
\n",
    "example": 298,
    "start_line": 4981,
    "end_line": 4991,
    "section": "List items"
  },
  {
    "markdown": "1. - 2. foo\n",
    "html": "
    \n
  1. \n
      \n
    • \n
        \n
      1. foo
        2. \n
      \n
      • \n
    \n
    2. \n
\n",
    "example": 299,
    "start_line": 4994,
    "end_line": 5008,
    "section": "List items"
  },
  {
    "markdown": "- # Foo\n- Bar\n  ---\n  baz\n",
    "html": "
    \n
  • \n
    Foo
    \n
    • \n
  • \n
    Bar
    \nbaz
    • \n
\n",
    "example": 300,
    "start_line": 5013,
    "end_line": 5027,
    "section": "List items"
  },
  {
    "markdown": "- foo\n- bar\n+ baz\n",
    "html": "
    \n
  • foo
    • \n
  • bar
    • \n
\n
    \n
  • baz
    • \n
\n",
    "example": 301,
    "start_line": 5249,
    "end_line": 5261,
    "section": "Lists"
  },
  {
    "markdown": "1. foo\n2. bar\n3) baz\n",
    "html": "
    \n
  1. foo
    2. \n
  2. bar
    3. \n
\n
    \n
  1. baz
    2. \n
\n",
    "example": 302,
    "start_line": 5264,
    "end_line": 5276,
    "section": "Lists"
  },
  {
    "markdown": "Foo\n- bar\n- baz\n",
    "html": "
Foo
\n
    \n
  • bar
    • \n
  • baz
    • \n
\n",
    "example": 303,
    "start_line": 5283,
    "end_line": 5293,
    "section": "Lists"
  },
  {
    "markdown": "The number of windows in my house is\n14.  The number of doors is 6.\n",
    "html": "
The number of windows in my house is\n14.  The number of doors is 6.
\n",
    "example": 304,
    "start_line": 5360,
    "end_line": 5366,
    "section": "Lists"
  },
  {
    "markdown": "The number of windows in my house is\n1.  The number of doors is 6.\n",
    "html": "
The number of windows in my house is
\n
    \n
  1. The number of doors is 6.
    2. \n
\n",
    "example": 305,
    "start_line": 5370,
    "end_line": 5378,
    "section": "Lists"
  },
  {
    "markdown": "- foo\n\n- bar\n\n\n- baz\n",
    "html": "
    \n
  • \n
    foo
    \n
    • \n
  • \n
    bar
    \n
    • \n
  • \n
    baz
    \n
    • \n
\n",
    "example": 306,
    "start_line": 5384,
    "end_line": 5403,
    "section": "Lists"
  },
  {
    "markdown": "- foo\n  - bar\n    - baz\n\n\n      bim\n",
    "html": "
    \n
  • foo\n
      \n
    • bar\n
        \n
      • \n
        baz
        \n
        bim
        \n
        • \n
      \n
      • \n
    \n
    • \n
\n",
    "example": 307,
    "start_line": 5405,
    "end_line": 5427,
    "section": "Lists"
  },
  {
    "markdown": "- foo\n- bar\n\n\n\n- baz\n- bim\n",
    "html": "
    \n
  • foo
    • \n
  • bar
    • \n
\n\n
    \n
  • baz
    • \n
  • bim
    • \n
\n",
    "example": 308,
    "start_line": 5435,
    "end_line": 5453,
    "section": "Lists"
  },
  {
    "markdown": "-   foo\n\n    notcode\n\n-   foo\n\n\n\n    code\n",
    "html": "
    \n
  • \n
    foo
    \n
    notcode
    \n
    • \n
  • \n
    foo
    \n
    • \n
\n\n
code\n
\n",
    "example": 309,
    "start_line": 5456,
    "end_line": 5479,
    "section": "Lists"
  },
  {
    "markdown": "- a\n - b\n  - c\n   - d\n  - e\n - f\n- g\n",
    "html": "
    \n
  • a
    • \n
  • b
    • \n
  • c
    • \n
  • d
    • \n
  • e
    • \n
  • f
    • \n
  • g
    • \n
\n",
    "example": 310,
    "start_line": 5487,
    "end_line": 5505,
    "section": "Lists"
  },
  {
    "markdown": "1. a\n\n  2. b\n\n   3. c\n",
    "html": "
    \n
  1. \n
    a
    \n
    2. \n
  2. \n
    b
    \n
    3. \n
  3. \n
    c
    \n
    4. \n
\n",
    "example": 311,
    "start_line": 5508,
    "end_line": 5526,
    "section": "Lists"
  },
  {
    "markdown": "- a\n - b\n  - c\n   - d\n    - e\n",
    "html": "
    \n
  • a
    • \n
  • b
    • \n
  • c
    • \n
  • d\n- e
    • \n
\n",
    "example": 312,
    "start_line": 5532,
    "end_line": 5546,
    "section": "Lists"
  },
  {
    "markdown": "1. a\n\n  2. b\n\n    3. c\n",
    "html": "
    \n
  1. \n
    a
    \n
    2. \n
  2. \n
    b
    \n
    3. \n
\n
3. c\n
\n",
    "example": 313,
    "start_line": 5552,
    "end_line": 5569,
    "section": "Lists"
  },
  {
    "markdown": "- a\n- b\n\n- c\n",
    "html": "
    \n
  • \n
    a
    \n
    • \n
  • \n
    b
    \n
    • \n
  • \n
    c
    \n
    • \n
\n",
    "example": 314,
    "start_line": 5575,
    "end_line": 5592,
    "section": "Lists"
  },
  {
    "markdown": "* a\n*\n\n* c\n",
    "html": "
    \n
  • \n
    a
    \n
    • \n
  • \n
  • \n
    c
    \n
    • \n
\n",
    "example": 315,
    "start_line": 5597,
    "end_line": 5612,
    "section": "Lists"
  },
  {
    "markdown": "- a\n- b\n\n  c\n- d\n",
    "html": "
    \n
  • \n
    a
    \n
    • \n
  • \n
    b
    \n
    c
    \n
    • \n
  • \n
    d
    \n
    • \n
\n",
    "example": 316,
    "start_line": 5619,
    "end_line": 5638,
    "section": "Lists"
  },
  {
    "markdown": "- a\n- b\n\n  [ref]: /url\n- d\n",
    "html": "
    \n
  • \n
    a
    \n
    • \n
  • \n
    b
    \n
    • \n
  • \n
    d
    \n
    • \n
\n",
    "example": 317,
    "start_line": 5641,
    "end_line": 5659,
    "section": "Lists"
  },
  {
    "markdown": "- a\n- ```\n  b\n\n\n  ```\n- c\n",
    "html": "
    \n
  • a
    • \n
  • \n
    b\n\n\n
    \n
    • \n
  • c
    • \n
\n",
    "example": 318,
    "start_line": 5664,
    "end_line": 5683,
    "section": "Lists"
  },
  {
    "markdown": "- a\n  - b\n\n    c\n- d\n",
    "html": "
    \n
  • a\n
      \n
    • \n
      b
      \n
      c
      \n
      • \n
    \n
    • \n
  • d
    • \n
\n",
    "example": 319,
    "start_line": 5690,
    "end_line": 5708,
    "section": "Lists"
  },
  {
    "markdown": "* a\n  > b\n  >\n* c\n",
    "html": "
    \n
  • a\n
    \n
    b
    \n
    \n
    • \n
  • c
    • \n
\n",
    "example": 320,
    "start_line": 5714,
    "end_line": 5728,
    "section": "Lists"
  },
  {
    "markdown": "- a\n  > b\n  ```\n  c\n  ```\n- d\n",
    "html": "
    \n
  • a\n
    \n
    b
    \n
    \n
    c\n
    \n
    • \n
  • d
    • \n
\n",
    "example": 321,
    "start_line": 5734,
    "end_line": 5752,
    "section": "Lists"
  },
  {
    "markdown": "- a\n",
    "html": "
    \n
  • a
    • \n
\n",
    "example": 322,
    "start_line": 5757,
    "end_line": 5763,
    "section": "Lists"
  },
  {
    "markdown": "- a\n  - b\n",
    "html": "
    \n
  • a\n
      \n
    • b
      • \n
    \n
    • \n
\n",
    "example": 323,
    "start_line": 5766,
    "end_line": 5777,
    "section": "Lists"
  },
  {
    "markdown": "1. ```\n   foo\n   ```\n\n   bar\n",
    "html": "
    \n
  1. \n
    foo\n
    \n
    bar
    \n
    2. \n
\n",
    "example": 324,
    "start_line": 5783,
    "end_line": 5797,
    "section": "Lists"
  },
  {
    "markdown": "* foo\n  * bar\n\n  baz\n",
    "html": "
    \n
  • \n
    foo
    \n
      \n
    • bar
      • \n
    \n
    baz
    \n
    • \n
\n",
    "example": 325,
    "start_line": 5802,
    "end_line": 5817,
    "section": "Lists"
  },
  {
    "markdown": "- a\n  - b\n  - c\n\n- d\n  - e\n  - f\n",
    "html": "
    \n
  • \n
    a
    \n
      \n
    • b
      • \n
    • c
      • \n
    \n
    • \n
  • \n
    d
    \n
      \n
    • e
      • \n
    • f
      • \n
    \n
    • \n
\n",
    "example": 326,
    "start_line": 5820,
    "end_line": 5845,
    "section": "Lists"
  },
  {
    "markdown": "`hi`lo`\n",
    "html": "
hilo`
\n",
    "example": 327,
    "start_line": 5854,
    "end_line": 5858,
    "section": "Inlines"
  },
  {
    "markdown": "`foo`\n",
    "html": "
foo
\n",
    "example": 328,
    "start_line": 5886,
    "end_line": 5890,
    "section": "Code spans"
  },
  {
    "markdown": "`` foo ` bar ``\n",
    "html": "
foo ` bar
\n",
    "example": 329,
    "start_line": 5897,
    "end_line": 5901,
    "section": "Code spans"
  },
  {
    "markdown": "` `` `\n",
    "html": "
``
\n",
    "example": 330,
    "start_line": 5907,
    "end_line": 5911,
    "section": "Code spans"
  },
  {
    "markdown": "`  ``  `\n",
    "html": "
 `` 
\n",
    "example": 331,
    "start_line": 5915,
    "end_line": 5919,
    "section": "Code spans"
  },
  {
    "markdown": "` a`\n",
    "html": "
 a
\n",
    "example": 332,
    "start_line": 5924,
    "end_line": 5928,
    "section": "Code spans"
  },
  {
    "markdown": "` b `\n",
    "html": "
 b 
\n",
    "example": 333,
    "start_line": 5933,
    "end_line": 5937,
    "section": "Code spans"
  },
  {
    "markdown": "` `\n`  `\n",
    "html": "
 \n  
\n",
    "example": 334,
    "start_line": 5941,
    "end_line": 5947,
    "section": "Code spans"
  },
  {
    "markdown": "``\nfoo\nbar  \nbaz\n``\n",
    "html": "
foo bar   baz
\n",
    "example": 335,
    "start_line": 5952,
    "end_line": 5960,
    "section": "Code spans"
  },
  {
    "markdown": "``\nfoo \n``\n",
    "html": "
foo 
\n",
    "example": 336,
    "start_line": 5962,
    "end_line": 5968,
    "section": "Code spans"
  },
  {
    "markdown": "`foo   bar \nbaz`\n",
    "html": "
foo   bar  baz
\n",
    "example": 337,
    "start_line": 5973,
    "end_line": 5978,
    "section": "Code spans"
  },
  {
    "markdown": "`foo\\`bar`\n",
    "html": "
foo\\bar`
\n",
    "example": 338,
    "start_line": 5990,
    "end_line": 5994,
    "section": "Code spans"
  },
  {
    "markdown": "``foo`bar``\n",
    "html": "
foo`bar
\n",
    "example": 339,
    "start_line": 6001,
    "end_line": 6005,
    "section": "Code spans"
  },
  {
    "markdown": "` foo `` bar `\n",
    "html": "
foo `` bar
\n",
    "example": 340,
    "start_line": 6007,
    "end_line": 6011,
    "section": "Code spans"
  },
  {
    "markdown": "*foo`*`\n",
    "html": "
*foo*
\n",
    "example": 341,
    "start_line": 6019,
    "end_line": 6023,
    "section": "Code spans"
  },
  {
    "markdown": "[not a `link](/foo`)\n",
    "html": "
[not a link](/foo)
\n",
    "example": 342,
    "start_line": 6028,
    "end_line": 6032,
    "section": "Code spans"
  },
  {
    "markdown": "``\n",
    "html": "
<a href="">`
\n",
    "example": 343,
    "start_line": 6038,
    "end_line": 6042,
    "section": "Code spans"
  },
  {
    "markdown": "`\n",
    "html": "
`
\n",
    "example": 344,
    "start_line": 6047,
    "end_line": 6051,
    "section": "Code spans"
  },
  {
    "markdown": "``\n",
    "html": "
<https://foo.bar.baz>`
\n",
    "example": 345,
    "start_line": 6056,
    "end_line": 6060,
    "section": "Code spans"
  },
  {
    "markdown": "`\n",
    "html": "
https://foo.bar.`baz`
\n",
    "example": 346,
    "start_line": 6065,
    "end_line": 6069,
    "section": "Code spans"
  },
  {
    "markdown": "```foo``\n",
    "html": "
```foo``
\n",
    "example": 347,
    "start_line": 6075,
    "end_line": 6079,
    "section": "Code spans"
  },
  {
    "markdown": "`foo\n",
    "html": "
`foo
\n",
    "example": 348,
    "start_line": 6082,
    "end_line": 6086,
    "section": "Code spans"
  },
  {
    "markdown": "`foo``bar``\n",
    "html": "
`foobar
\n",
    "example": 349,
    "start_line": 6091,
    "end_line": 6095,
    "section": "Code spans"
  },
  {
    "markdown": "*foo bar*\n",
    "html": "
foo bar
\n",
    "example": 350,
    "start_line": 6308,
    "end_line": 6312,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "a * foo bar*\n",
    "html": "
a * foo bar*
\n",
    "example": 351,
    "start_line": 6318,
    "end_line": 6322,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "a*\"foo\"*\n",
    "html": "
a*"foo"*
\n",
    "example": 352,
    "start_line": 6329,
    "end_line": 6333,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "* a *\n",
    "html": "
* a *
\n",
    "example": 353,
    "start_line": 6338,
    "end_line": 6342,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*$*alpha.\n\n*£*bravo.\n\n*€*charlie.\n",
    "html": "
*$*alpha.
\n
*£*bravo.
\n
*€*charlie.
\n",
    "example": 354,
    "start_line": 6347,
    "end_line": 6357,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo*bar*\n",
    "html": "
foobar
\n",
    "example": 355,
    "start_line": 6362,
    "end_line": 6366,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "5*6*78\n",
    "html": "
5678
\n",
    "example": 356,
    "start_line": 6369,
    "end_line": 6373,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo bar_\n",
    "html": "
foo bar
\n",
    "example": 357,
    "start_line": 6378,
    "end_line": 6382,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_ foo bar_\n",
    "html": "
_ foo bar_
\n",
    "example": 358,
    "start_line": 6388,
    "end_line": 6392,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "a_\"foo\"_\n",
    "html": "
a_"foo"_
\n",
    "example": 359,
    "start_line": 6398,
    "end_line": 6402,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo_bar_\n",
    "html": "
foo_bar_
\n",
    "example": 360,
    "start_line": 6407,
    "end_line": 6411,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "5_6_78\n",
    "html": "
5_6_78
\n",
    "example": 361,
    "start_line": 6414,
    "end_line": 6418,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "пристаням_стремятся_\n",
    "html": "
пристаням_стремятся_
\n",
    "example": 362,
    "start_line": 6421,
    "end_line": 6425,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "aa_\"bb\"_cc\n",
    "html": "
aa_"bb"_cc
\n",
    "example": 363,
    "start_line": 6431,
    "end_line": 6435,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo-_(bar)_\n",
    "html": "
foo-(bar)
\n",
    "example": 364,
    "start_line": 6442,
    "end_line": 6446,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo*\n",
    "html": "
_foo*
\n",
    "example": 365,
    "start_line": 6454,
    "end_line": 6458,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo bar *\n",
    "html": "
*foo bar *
\n",
    "example": 366,
    "start_line": 6464,
    "end_line": 6468,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo bar\n*\n",
    "html": "
*foo bar\n*
\n",
    "example": 367,
    "start_line": 6473,
    "end_line": 6479,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*(*foo)\n",
    "html": "
*(*foo)
\n",
    "example": 368,
    "start_line": 6486,
    "end_line": 6490,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*(*foo*)*\n",
    "html": "
(foo)
\n",
    "example": 369,
    "start_line": 6496,
    "end_line": 6500,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo*bar\n",
    "html": "
foobar
\n",
    "example": 370,
    "start_line": 6505,
    "end_line": 6509,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo bar _\n",
    "html": "
_foo bar _
\n",
    "example": 371,
    "start_line": 6518,
    "end_line": 6522,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_(_foo)\n",
    "html": "
_(_foo)
\n",
    "example": 372,
    "start_line": 6528,
    "end_line": 6532,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_(_foo_)_\n",
    "html": "
(foo)
\n",
    "example": 373,
    "start_line": 6537,
    "end_line": 6541,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo_bar\n",
    "html": "
_foo_bar
\n",
    "example": 374,
    "start_line": 6546,
    "end_line": 6550,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_пристаням_стремятся\n",
    "html": "
_пристаням_стремятся
\n",
    "example": 375,
    "start_line": 6553,
    "end_line": 6557,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo_bar_baz_\n",
    "html": "
foo_bar_baz
\n",
    "example": 376,
    "start_line": 6560,
    "end_line": 6564,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_(bar)_.\n",
    "html": "
(bar).
\n",
    "example": 377,
    "start_line": 6571,
    "end_line": 6575,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo bar**\n",
    "html": "
foo bar
\n",
    "example": 378,
    "start_line": 6580,
    "end_line": 6584,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "** foo bar**\n",
    "html": "
** foo bar**
\n",
    "example": 379,
    "start_line": 6590,
    "end_line": 6594,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "a**\"foo\"**\n",
    "html": "
a**"foo"**
\n",
    "example": 380,
    "start_line": 6601,
    "end_line": 6605,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo**bar**\n",
    "html": "
foobar
\n",
    "example": 381,
    "start_line": 6610,
    "end_line": 6614,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo bar__\n",
    "html": "
foo bar
\n",
    "example": 382,
    "start_line": 6619,
    "end_line": 6623,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__ foo bar__\n",
    "html": "
__ foo bar__
\n",
    "example": 383,
    "start_line": 6629,
    "end_line": 6633,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__\nfoo bar__\n",
    "html": "
__\nfoo bar__
\n",
    "example": 384,
    "start_line": 6637,
    "end_line": 6643,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "a__\"foo\"__\n",
    "html": "
a__"foo"__
\n",
    "example": 385,
    "start_line": 6649,
    "end_line": 6653,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo__bar__\n",
    "html": "
foo__bar__
\n",
    "example": 386,
    "start_line": 6658,
    "end_line": 6662,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "5__6__78\n",
    "html": "
5__6__78
\n",
    "example": 387,
    "start_line": 6665,
    "end_line": 6669,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "пристаням__стремятся__\n",
    "html": "
пристаням__стремятся__
\n",
    "example": 388,
    "start_line": 6672,
    "end_line": 6676,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo, __bar__, baz__\n",
    "html": "
foo, bar, baz
\n",
    "example": 389,
    "start_line": 6679,
    "end_line": 6683,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo-__(bar)__\n",
    "html": "
foo-(bar)
\n",
    "example": 390,
    "start_line": 6690,
    "end_line": 6694,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo bar **\n",
    "html": "
**foo bar **
\n",
    "example": 391,
    "start_line": 6703,
    "end_line": 6707,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**(**foo)\n",
    "html": "
**(**foo)
\n",
    "example": 392,
    "start_line": 6716,
    "end_line": 6720,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*(**foo**)*\n",
    "html": "
(foo)
\n",
    "example": 393,
    "start_line": 6726,
    "end_line": 6730,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**Gomphocarpus (*Gomphocarpus physocarpus*, syn.\n*Asclepias physocarpa*)**\n",
    "html": "
Gomphocarpus (Gomphocarpus physocarpus, syn.\nAsclepias physocarpa)
\n",
    "example": 394,
    "start_line": 6733,
    "end_line": 6739,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo \"*bar*\" foo**\n",
    "html": "
foo "bar" foo
\n",
    "example": 395,
    "start_line": 6742,
    "end_line": 6746,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo**bar\n",
    "html": "
foobar
\n",
    "example": 396,
    "start_line": 6751,
    "end_line": 6755,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo bar __\n",
    "html": "
__foo bar __
\n",
    "example": 397,
    "start_line": 6763,
    "end_line": 6767,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__(__foo)\n",
    "html": "
__(__foo)
\n",
    "example": 398,
    "start_line": 6773,
    "end_line": 6777,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_(__foo__)_\n",
    "html": "
(foo)
\n",
    "example": 399,
    "start_line": 6783,
    "end_line": 6787,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo__bar\n",
    "html": "
__foo__bar
\n",
    "example": 400,
    "start_line": 6792,
    "end_line": 6796,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__пристаням__стремятся\n",
    "html": "
__пристаням__стремятся
\n",
    "example": 401,
    "start_line": 6799,
    "end_line": 6803,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo__bar__baz__\n",
    "html": "
foo__bar__baz
\n",
    "example": 402,
    "start_line": 6806,
    "end_line": 6810,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__(bar)__.\n",
    "html": "
(bar).
\n",
    "example": 403,
    "start_line": 6817,
    "end_line": 6821,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo [bar](/url)*\n",
    "html": "
foo bar
\n",
    "example": 404,
    "start_line": 6829,
    "end_line": 6833,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo\nbar*\n",
    "html": "
foo\nbar
\n",
    "example": 405,
    "start_line": 6836,
    "end_line": 6842,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo __bar__ baz_\n",
    "html": "
foo bar baz
\n",
    "example": 406,
    "start_line": 6848,
    "end_line": 6852,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo _bar_ baz_\n",
    "html": "
foo bar baz
\n",
    "example": 407,
    "start_line": 6855,
    "end_line": 6859,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo_ bar_\n",
    "html": "
foo bar
\n",
    "example": 408,
    "start_line": 6862,
    "end_line": 6866,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo *bar**\n",
    "html": "
foo bar
\n",
    "example": 409,
    "start_line": 6869,
    "end_line": 6873,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo **bar** baz*\n",
    "html": "
foo bar baz
\n",
    "example": 410,
    "start_line": 6876,
    "end_line": 6880,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo**bar**baz*\n",
    "html": "
foobarbaz
\n",
    "example": 411,
    "start_line": 6882,
    "end_line": 6886,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo**bar*\n",
    "html": "
foo**bar
\n",
    "example": 412,
    "start_line": 6906,
    "end_line": 6910,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "***foo** bar*\n",
    "html": "
foo bar
\n",
    "example": 413,
    "start_line": 6919,
    "end_line": 6923,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo **bar***\n",
    "html": "
foo bar
\n",
    "example": 414,
    "start_line": 6926,
    "end_line": 6930,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo**bar***\n",
    "html": "
foobar
\n",
    "example": 415,
    "start_line": 6933,
    "end_line": 6937,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo***bar***baz\n",
    "html": "
foobarbaz
\n",
    "example": 416,
    "start_line": 6944,
    "end_line": 6948,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo******bar*********baz\n",
    "html": "
foobar***baz
\n",
    "example": 417,
    "start_line": 6950,
    "end_line": 6954,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo **bar *baz* bim** bop*\n",
    "html": "
foo bar baz bim bop
\n",
    "example": 418,
    "start_line": 6959,
    "end_line": 6963,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo [*bar*](/url)*\n",
    "html": "
foo bar
\n",
    "example": 419,
    "start_line": 6966,
    "end_line": 6970,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "** is not an empty emphasis\n",
    "html": "
** is not an empty emphasis
\n",
    "example": 420,
    "start_line": 6975,
    "end_line": 6979,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**** is not an empty strong emphasis\n",
    "html": "
**** is not an empty strong emphasis
\n",
    "example": 421,
    "start_line": 6982,
    "end_line": 6986,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo [bar](/url)**\n",
    "html": "
foo bar
\n",
    "example": 422,
    "start_line": 6995,
    "end_line": 6999,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo\nbar**\n",
    "html": "
foo\nbar
\n",
    "example": 423,
    "start_line": 7002,
    "end_line": 7008,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo _bar_ baz__\n",
    "html": "
foo bar baz
\n",
    "example": 424,
    "start_line": 7014,
    "end_line": 7018,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo __bar__ baz__\n",
    "html": "
foo bar baz
\n",
    "example": 425,
    "start_line": 7021,
    "end_line": 7025,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "____foo__ bar__\n",
    "html": "
foo bar
\n",
    "example": 426,
    "start_line": 7028,
    "end_line": 7032,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo **bar****\n",
    "html": "
foo bar
\n",
    "example": 427,
    "start_line": 7035,
    "end_line": 7039,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo *bar* baz**\n",
    "html": "
foo bar baz
\n",
    "example": 428,
    "start_line": 7042,
    "end_line": 7046,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo*bar*baz**\n",
    "html": "
foobarbaz
\n",
    "example": 429,
    "start_line": 7049,
    "end_line": 7053,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "***foo* bar**\n",
    "html": "
foo bar
\n",
    "example": 430,
    "start_line": 7056,
    "end_line": 7060,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo *bar***\n",
    "html": "
foo bar
\n",
    "example": 431,
    "start_line": 7063,
    "end_line": 7067,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo *bar **baz**\nbim* bop**\n",
    "html": "
foo bar baz\nbim bop
\n",
    "example": 432,
    "start_line": 7072,
    "end_line": 7078,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo [*bar*](/url)**\n",
    "html": "
foo bar
\n",
    "example": 433,
    "start_line": 7081,
    "end_line": 7085,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__ is not an empty emphasis\n",
    "html": "
__ is not an empty emphasis
\n",
    "example": 434,
    "start_line": 7090,
    "end_line": 7094,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "____ is not an empty strong emphasis\n",
    "html": "
____ is not an empty strong emphasis
\n",
    "example": 435,
    "start_line": 7097,
    "end_line": 7101,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo ***\n",
    "html": "
foo ***
\n",
    "example": 436,
    "start_line": 7107,
    "end_line": 7111,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo *\\**\n",
    "html": "
foo *
\n",
    "example": 437,
    "start_line": 7114,
    "end_line": 7118,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo *_*\n",
    "html": "
foo _
\n",
    "example": 438,
    "start_line": 7121,
    "end_line": 7125,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo *****\n",
    "html": "
foo *****
\n",
    "example": 439,
    "start_line": 7128,
    "end_line": 7132,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo **\\***\n",
    "html": "
foo *
\n",
    "example": 440,
    "start_line": 7135,
    "end_line": 7139,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo **_**\n",
    "html": "
foo _
\n",
    "example": 441,
    "start_line": 7142,
    "end_line": 7146,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo*\n",
    "html": "
*foo
\n",
    "example": 442,
    "start_line": 7153,
    "end_line": 7157,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo**\n",
    "html": "
foo*
\n",
    "example": 443,
    "start_line": 7160,
    "end_line": 7164,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "***foo**\n",
    "html": "
*foo
\n",
    "example": 444,
    "start_line": 7167,
    "end_line": 7171,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "****foo*\n",
    "html": "
***foo
\n",
    "example": 445,
    "start_line": 7174,
    "end_line": 7178,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo***\n",
    "html": "
foo*
\n",
    "example": 446,
    "start_line": 7181,
    "end_line": 7185,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo****\n",
    "html": "
foo***
\n",
    "example": 447,
    "start_line": 7188,
    "end_line": 7192,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo ___\n",
    "html": "
foo ___
\n",
    "example": 448,
    "start_line": 7198,
    "end_line": 7202,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo _\\__\n",
    "html": "
foo _
\n",
    "example": 449,
    "start_line": 7205,
    "end_line": 7209,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo _*_\n",
    "html": "
foo *
\n",
    "example": 450,
    "start_line": 7212,
    "end_line": 7216,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo _____\n",
    "html": "
foo _____
\n",
    "example": 451,
    "start_line": 7219,
    "end_line": 7223,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo __\\___\n",
    "html": "
foo _
\n",
    "example": 452,
    "start_line": 7226,
    "end_line": 7230,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "foo __*__\n",
    "html": "
foo *
\n",
    "example": 453,
    "start_line": 7233,
    "end_line": 7237,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo_\n",
    "html": "
_foo
\n",
    "example": 454,
    "start_line": 7240,
    "end_line": 7244,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo__\n",
    "html": "
foo_
\n",
    "example": 455,
    "start_line": 7251,
    "end_line": 7255,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "___foo__\n",
    "html": "
_foo
\n",
    "example": 456,
    "start_line": 7258,
    "end_line": 7262,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "____foo_\n",
    "html": "
___foo
\n",
    "example": 457,
    "start_line": 7265,
    "end_line": 7269,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo___\n",
    "html": "
foo_
\n",
    "example": 458,
    "start_line": 7272,
    "end_line": 7276,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo____\n",
    "html": "
foo___
\n",
    "example": 459,
    "start_line": 7279,
    "end_line": 7283,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo**\n",
    "html": "
foo
\n",
    "example": 460,
    "start_line": 7289,
    "end_line": 7293,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*_foo_*\n",
    "html": "
foo
\n",
    "example": 461,
    "start_line": 7296,
    "end_line": 7300,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__foo__\n",
    "html": "
foo
\n",
    "example": 462,
    "start_line": 7303,
    "end_line": 7307,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_*foo*_\n",
    "html": "
foo
\n",
    "example": 463,
    "start_line": 7310,
    "end_line": 7314,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "****foo****\n",
    "html": "
foo
\n",
    "example": 464,
    "start_line": 7320,
    "end_line": 7324,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "____foo____\n",
    "html": "
foo
\n",
    "example": 465,
    "start_line": 7327,
    "end_line": 7331,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "******foo******\n",
    "html": "
foo
\n",
    "example": 466,
    "start_line": 7338,
    "end_line": 7342,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "***foo***\n",
    "html": "
foo
\n",
    "example": 467,
    "start_line": 7347,
    "end_line": 7351,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_____foo_____\n",
    "html": "
foo
\n",
    "example": 468,
    "start_line": 7354,
    "end_line": 7358,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo _bar* baz_\n",
    "html": "
foo _bar baz_
\n",
    "example": 469,
    "start_line": 7363,
    "end_line": 7367,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo __bar *baz bim__ bam*\n",
    "html": "
foo bar *baz bim bam
\n",
    "example": 470,
    "start_line": 7370,
    "end_line": 7374,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**foo **bar baz**\n",
    "html": "
**foo bar baz
\n",
    "example": 471,
    "start_line": 7379,
    "end_line": 7383,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*foo *bar baz*\n",
    "html": "
*foo bar baz
\n",
    "example": 472,
    "start_line": 7386,
    "end_line": 7390,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*[bar*](/url)\n",
    "html": "
*bar*
\n",
    "example": 473,
    "start_line": 7395,
    "end_line": 7399,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_foo [bar_](/url)\n",
    "html": "
_foo bar_
\n",
    "example": 474,
    "start_line": 7402,
    "end_line": 7406,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*\n",
    "html": "
*
\n",
    "example": 475,
    "start_line": 7409,
    "end_line": 7413,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**\n",
    "html": "
**
\n",
    "example": 476,
    "start_line": 7416,
    "end_line": 7420,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__\n",
    "html": "
__
\n",
    "example": 477,
    "start_line": 7423,
    "end_line": 7427,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "*a `*`*\n",
    "html": "
a *
\n",
    "example": 478,
    "start_line": 7430,
    "end_line": 7434,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "_a `_`_\n",
    "html": "
a _
\n",
    "example": 479,
    "start_line": 7437,
    "end_line": 7441,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "**a\n",
    "html": "
**ahttps://foo.bar/?q=**
\n",
    "example": 480,
    "start_line": 7444,
    "end_line": 7448,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "__a\n",
    "html": "
__ahttps://foo.bar/?q=__
\n",
    "example": 481,
    "start_line": 7451,
    "end_line": 7455,
    "section": "Emphasis and strong emphasis"
  },
  {
    "markdown": "[link](/uri \"title\")\n",
    "html": "
link
\n",
    "example": 482,
    "start_line": 7539,
    "end_line": 7543,
    "section": "Links"
  },
  {
    "markdown": "[link](/uri)\n",
    "html": "
link
\n",
    "example": 483,
    "start_line": 7549,
    "end_line": 7553,
    "section": "Links"
  },
  {
    "markdown": "[](./target.md)\n",
    "html": "
\n",
    "example": 484,
    "start_line": 7555,
    "end_line": 7559,
    "section": "Links"
  },
  {
    "markdown": "[link]()\n",
    "html": "
link
\n",
    "example": 485,
    "start_line": 7562,
    "end_line": 7566,
    "section": "Links"
  },
  {
    "markdown": "[link](<>)\n",
    "html": "
link
\n",
    "example": 486,
    "start_line": 7569,
    "end_line": 7573,
    "section": "Links"
  },
  {
    "markdown": "[]()\n",
    "html": "
\n",
    "example": 487,
    "start_line": 7576,
    "end_line": 7580,
    "section": "Links"
  },
  {
    "markdown": "[link](/my uri)\n",
    "html": "
[link](/my uri)
\n",
    "example": 488,
    "start_line": 7585,
    "end_line": 7589,
    "section": "Links"
  },
  {
    "markdown": "[link]()\n",
    "html": "
link
\n",
    "example": 489,
    "start_line": 7591,
    "end_line": 7595,
    "section": "Links"
  },
  {
    "markdown": "[link](foo\nbar)\n",
    "html": "
[link](foo\nbar)
\n",
    "example": 490,
    "start_line": 7600,
    "end_line": 7606,
    "section": "Links"
  },
  {
    "markdown": "[link]()\n",
    "html": "
[link]()
\n",
    "example": 491,
    "start_line": 7608,
    "end_line": 7614,
    "section": "Links"
  },
  {
    "markdown": "[a]()\n",
    "html": "
a
\n",
    "example": 492,
    "start_line": 7619,
    "end_line": 7623,
    "section": "Links"
  },
  {
    "markdown": "[link]()\n",
    "html": "
[link](<foo>)
\n",
    "example": 493,
    "start_line": 7627,
    "end_line": 7631,
    "section": "Links"
  },
  {
    "markdown": "[a](\n[a](c)\n",
    "html": "
[a](<b)c\n[a](<b)c>\n[a](c)
\n",
    "example": 494,
    "start_line": 7636,
    "end_line": 7644,
    "section": "Links"
  },
  {
    "markdown": "[link](\\(foo\\))\n",
    "html": "
link
\n",
    "example": 495,
    "start_line": 7648,
    "end_line": 7652,
    "section": "Links"
  },
  {
    "markdown": "[link](foo(and(bar)))\n",
    "html": "
link
\n",
    "example": 496,
    "start_line": 7657,
    "end_line": 7661,
    "section": "Links"
  },
  {
    "markdown": "[link](foo(and(bar))\n",
    "html": "
[link](foo(and(bar))
\n",
    "example": 497,
    "start_line": 7666,
    "end_line": 7670,
    "section": "Links"
  },
  {
    "markdown": "[link](foo\\(and\\(bar\\))\n",
    "html": "
link
\n",
    "example": 498,
    "start_line": 7673,
    "end_line": 7677,
    "section": "Links"
  },
  {
    "markdown": "[link]()\n",
    "html": "
link
\n",
    "example": 499,
    "start_line": 7680,
    "end_line": 7684,
    "section": "Links"
  },
  {
    "markdown": "[link](foo\\)\\:)\n",
    "html": "
link
\n",
    "example": 500,
    "start_line": 7690,
    "end_line": 7694,
    "section": "Links"
  },
  {
    "markdown": "[link](#fragment)\n\n[link](https://example.com#fragment)\n\n[link](https://example.com?foo=3#frag)\n",
    "html": "
link
\n
link
\n
link
\n",
    "example": 501,
    "start_line": 7699,
    "end_line": 7709,
    "section": "Links"
  },
  {
    "markdown": "[link](foo\\bar)\n",
    "html": "
link
\n",
    "example": 502,
    "start_line": 7715,
    "end_line": 7719,
    "section": "Links"
  },
  {
    "markdown": "[link](foo%20bä)\n",
    "html": "
link
\n",
    "example": 503,
    "start_line": 7731,
    "end_line": 7735,
    "section": "Links"
  },
  {
    "markdown": "[link](\"title\")\n",
    "html": "
link
\n",
    "example": 504,
    "start_line": 7742,
    "end_line": 7746,
    "section": "Links"
  },
  {
    "markdown": "[link](/url \"title\")\n[link](/url 'title')\n[link](/url (title))\n",
    "html": "
link\nlink\nlink
\n",
    "example": 505,
    "start_line": 7751,
    "end_line": 7759,
    "section": "Links"
  },
  {
    "markdown": "[link](/url \"title \\\""\")\n",
    "html": "
link
\n",
    "example": 506,
    "start_line": 7765,
    "end_line": 7769,
    "section": "Links"
  },
  {
    "markdown": "[link](/url \"title\")\n",
    "html": "
link
\n",
    "example": 507,
    "start_line": 7776,
    "end_line": 7780,
    "section": "Links"
  },
  {
    "markdown": "[link](/url \"title \"and\" title\")\n",
    "html": "
[link](/url "title "and" title")
\n",
    "example": 508,
    "start_line": 7785,
    "end_line": 7789,
    "section": "Links"
  },
  {
    "markdown": "[link](/url 'title \"and\" title')\n",
    "html": "
link
\n",
    "example": 509,
    "start_line": 7794,
    "end_line": 7798,
    "section": "Links"
  },
  {
    "markdown": "[link](   /uri\n  \"title\"  )\n",
    "html": "
link
\n",
    "example": 510,
    "start_line": 7819,
    "end_line": 7824,
    "section": "Links"
  },
  {
    "markdown": "[link] (/uri)\n",
    "html": "
[link] (/uri)
\n",
    "example": 511,
    "start_line": 7830,
    "end_line": 7834,
    "section": "Links"
  },
  {
    "markdown": "[link [foo [bar]]](/uri)\n",
    "html": "
link [foo [bar]]
\n",
    "example": 512,
    "start_line": 7840,
    "end_line": 7844,
    "section": "Links"
  },
  {
    "markdown": "[link] bar](/uri)\n",
    "html": "
[link] bar](/uri)
\n",
    "example": 513,
    "start_line": 7847,
    "end_line": 7851,
    "section": "Links"
  },
  {
    "markdown": "[link [bar](/uri)\n",
    "html": "
[link bar
\n",
    "example": 514,
    "start_line": 7854,
    "end_line": 7858,
    "section": "Links"
  },
  {
    "markdown": "[link \\[bar](/uri)\n",
    "html": "
link [bar
\n",
    "example": 515,
    "start_line": 7861,
    "end_line": 7865,
    "section": "Links"
  },
  {
    "markdown": "[link *foo **bar** `#`*](/uri)\n",
    "html": "
link foo bar #
\n",
    "example": 516,
    "start_line": 7870,
    "end_line": 7874,
    "section": "Links"
  },
  {
    "markdown": "[![moon](moon.jpg)](/uri)\n",
    "html": "
\"moon\"
\n",
    "example": 517,
    "start_line": 7877,
    "end_line": 7881,
    "section": "Links"
  },
  {
    "markdown": "[foo [bar](/uri)](/uri)\n",
    "html": "
[foo bar](/uri)
\n",
    "example": 518,
    "start_line": 7886,
    "end_line": 7890,
    "section": "Links"
  },
  {
    "markdown": "[foo *[bar [baz](/uri)](/uri)*](/uri)\n",
    "html": "
[foo [bar baz](/uri)](/uri)
\n",
    "example": 519,
    "start_line": 7893,
    "end_line": 7897,
    "section": "Links"
  },
  {
    "markdown": "![[[foo](uri1)](uri2)](uri3)\n",
    "html": "
\"[foo](uri2)\"
\n",
    "example": 520,
    "start_line": 7900,
    "end_line": 7904,
    "section": "Links"
  },
  {
    "markdown": "*[foo*](/uri)\n",
    "html": "
*foo*
\n",
    "example": 521,
    "start_line": 7910,
    "end_line": 7914,
    "section": "Links"
  },
  {
    "markdown": "[foo *bar](baz*)\n",
    "html": "
foo *bar
\n",
    "example": 522,
    "start_line": 7917,
    "end_line": 7921,
    "section": "Links"
  },
  {
    "markdown": "*foo [bar* baz]\n",
    "html": "
foo [bar baz]
\n",
    "example": 523,
    "start_line": 7927,
    "end_line": 7931,
    "section": "Links"
  },
  {
    "markdown": "[foo \n",
    "html": "
[foo 
\n",
    "example": 524,
    "start_line": 7937,
    "end_line": 7941,
    "section": "Links"
  },
  {
    "markdown": "[foo`](/uri)`\n",
    "html": "
[foo](/uri)
\n",
    "example": 525,
    "start_line": 7944,
    "end_line": 7948,
    "section": "Links"
  },
  {
    "markdown": "[foo\n",
    "html": "
[foohttps://example.com/?search=](uri)
\n",
    "example": 526,
    "start_line": 7951,
    "end_line": 7955,
    "section": "Links"
  },
  {
    "markdown": "[foo][bar]\n\n[bar]: /url \"title\"\n",
    "html": "
foo
\n",
    "example": 527,
    "start_line": 7989,
    "end_line": 7995,
    "section": "Links"
  },
  {
    "markdown": "[link [foo [bar]]][ref]\n\n[ref]: /uri\n",
    "html": "
link [foo [bar]]
\n",
    "example": 528,
    "start_line": 8004,
    "end_line": 8010,
    "section": "Links"
  },
  {
    "markdown": "[link \\[bar][ref]\n\n[ref]: /uri\n",
    "html": "
link [bar
\n",
    "example": 529,
    "start_line": 8013,
    "end_line": 8019,
    "section": "Links"
  },
  {
    "markdown": "[link *foo **bar** `#`*][ref]\n\n[ref]: /uri\n",
    "html": "
link foo bar #
\n",
    "example": 530,
    "start_line": 8024,
    "end_line": 8030,
    "section": "Links"
  },
  {
    "markdown": "[![moon](moon.jpg)][ref]\n\n[ref]: /uri\n",
    "html": "
\"moon\"
\n",
    "example": 531,
    "start_line": 8033,
    "end_line": 8039,
    "section": "Links"
  },
  {
    "markdown": "[foo [bar](/uri)][ref]\n\n[ref]: /uri\n",
    "html": "
[foo bar]ref
\n",
    "example": 532,
    "start_line": 8044,
    "end_line": 8050,
    "section": "Links"
  },
  {
    "markdown": "[foo *bar [baz][ref]*][ref]\n\n[ref]: /uri\n",
    "html": "
[foo bar baz]ref
\n",
    "example": 533,
    "start_line": 8053,
    "end_line": 8059,
    "section": "Links"
  },
  {
    "markdown": "*[foo*][ref]\n\n[ref]: /uri\n",
    "html": "
*foo*
\n",
    "example": 534,
    "start_line": 8068,
    "end_line": 8074,
    "section": "Links"
  },
  {
    "markdown": "[foo *bar][ref]*\n\n[ref]: /uri\n",
    "html": "
foo *bar*
\n",
    "example": 535,
    "start_line": 8077,
    "end_line": 8083,
    "section": "Links"
  },
  {
    "markdown": "[foo \n\n[ref]: /uri\n",
    "html": "
[foo 
\n",
    "example": 536,
    "start_line": 8089,
    "end_line": 8095,
    "section": "Links"
  },
  {
    "markdown": "[foo`][ref]`\n\n[ref]: /uri\n",
    "html": "
[foo][ref]
\n",
    "example": 537,
    "start_line": 8098,
    "end_line": 8104,
    "section": "Links"
  },
  {
    "markdown": "[foo\n\n[ref]: /uri\n",
    "html": "
[foohttps://example.com/?search=][ref]
\n",
    "example": 538,
    "start_line": 8107,
    "end_line": 8113,
    "section": "Links"
  },
  {
    "markdown": "[foo][BaR]\n\n[bar]: /url \"title\"\n",
    "html": "
foo
\n",
    "example": 539,
    "start_line": 8118,
    "end_line": 8124,
    "section": "Links"
  },
  {
    "markdown": "[ẞ]\n\n[SS]: /url\n",
    "html": "
ẞ
\n",
    "example": 540,
    "start_line": 8129,
    "end_line": 8135,
    "section": "Links"
  },
  {
    "markdown": "[Foo\n  bar]: /url\n\n[Baz][Foo bar]\n",
    "html": "
Baz
\n",
    "example": 541,
    "start_line": 8141,
    "end_line": 8148,
    "section": "Links"
  },
  {
    "markdown": "[foo] [bar]\n\n[bar]: /url \"title\"\n",
    "html": "
[foo] bar
\n",
    "example": 542,
    "start_line": 8154,
    "end_line": 8160,
    "section": "Links"
  },
  {
    "markdown": "[foo]\n[bar]\n\n[bar]: /url \"title\"\n",
    "html": "
[foo]\nbar
\n",
    "example": 543,
    "start_line": 8163,
    "end_line": 8171,
    "section": "Links"
  },
  {
    "markdown": "[foo]: /url1\n\n[foo]: /url2\n\n[bar][foo]\n",
    "html": "
bar
\n",
    "example": 544,
    "start_line": 8204,
    "end_line": 8212,
    "section": "Links"
  },
  {
    "markdown": "[bar][foo\\!]\n\n[foo!]: /url\n",
    "html": "
[bar][foo!]
\n",
    "example": 545,
    "start_line": 8219,
    "end_line": 8225,
    "section": "Links"
  },
  {
    "markdown": "[foo][ref[]\n\n[ref[]: /uri\n",
    "html": "
[foo][ref[]
\n
[ref[]: /uri
\n",
    "example": 546,
    "start_line": 8231,
    "end_line": 8238,
    "section": "Links"
  },
  {
    "markdown": "[foo][ref[bar]]\n\n[ref[bar]]: /uri\n",
    "html": "
[foo][ref[bar]]
\n
[ref[bar]]: /uri
\n",
    "example": 547,
    "start_line": 8241,
    "end_line": 8248,
    "section": "Links"
  },
  {
    "markdown": "[[[foo]]]\n\n[[[foo]]]: /url\n",
    "html": "
[[[foo]]]
\n
[[[foo]]]: /url
\n",
    "example": 548,
    "start_line": 8251,
    "end_line": 8258,
    "section": "Links"
  },
  {
    "markdown": "[foo][ref\\[]\n\n[ref\\[]: /uri\n",
    "html": "
foo
\n",
    "example": 549,
    "start_line": 8261,
    "end_line": 8267,
    "section": "Links"
  },
  {
    "markdown": "[bar\\\\]: /uri\n\n[bar\\\\]\n",
    "html": "
bar\\
\n",
    "example": 550,
    "start_line": 8272,
    "end_line": 8278,
    "section": "Links"
  },
  {
    "markdown": "[]\n\n[]: /uri\n",
    "html": "
[]
\n
[]: /uri
\n",
    "example": 551,
    "start_line": 8284,
    "end_line": 8291,
    "section": "Links"
  },
  {
    "markdown": "[\n ]\n\n[\n ]: /uri\n",
    "html": "
[\n]
\n
[\n]: /uri
\n",
    "example": 552,
    "start_line": 8294,
    "end_line": 8305,
    "section": "Links"
  },
  {
    "markdown": "[foo][]\n\n[foo]: /url \"title\"\n",
    "html": "
foo
\n",
    "example": 553,
    "start_line": 8317,
    "end_line": 8323,
    "section": "Links"
  },
  {
    "markdown": "[*foo* bar][]\n\n[*foo* bar]: /url \"title\"\n",
    "html": "
foo bar
\n",
    "example": 554,
    "start_line": 8326,
    "end_line": 8332,
    "section": "Links"
  },
  {
    "markdown": "[Foo][]\n\n[foo]: /url \"title\"\n",
    "html": "
Foo
\n",
    "example": 555,
    "start_line": 8337,
    "end_line": 8343,
    "section": "Links"
  },
  {
    "markdown": "[foo] \n[]\n\n[foo]: /url \"title\"\n",
    "html": "
foo\n[]
\n",
    "example": 556,
    "start_line": 8350,
    "end_line": 8358,
    "section": "Links"
  },
  {
    "markdown": "[foo]\n\n[foo]: /url \"title\"\n",
    "html": "
foo
\n",
    "example": 557,
    "start_line": 8370,
    "end_line": 8376,
    "section": "Links"
  },
  {
    "markdown": "[*foo* bar]\n\n[*foo* bar]: /url \"title\"\n",
    "html": "
foo bar
\n",
    "example": 558,
    "start_line": 8379,
    "end_line": 8385,
    "section": "Links"
  },
  {
    "markdown": "[[*foo* bar]]\n\n[*foo* bar]: /url \"title\"\n",
    "html": "
[foo bar]
\n",
    "example": 559,
    "start_line": 8388,
    "end_line": 8394,
    "section": "Links"
  },
  {
    "markdown": "[[bar [foo]\n\n[foo]: /url\n",
    "html": "
[[bar foo
\n",
    "example": 560,
    "start_line": 8397,
    "end_line": 8403,
    "section": "Links"
  },
  {
    "markdown": "[Foo]\n\n[foo]: /url \"title\"\n",
    "html": "
Foo
\n",
    "example": 561,
    "start_line": 8408,
    "end_line": 8414,
    "section": "Links"
  },
  {
    "markdown": "[foo] bar\n\n[foo]: /url\n",
    "html": "
foo bar
\n",
    "example": 562,
    "start_line": 8419,
    "end_line": 8425,
    "section": "Links"
  },
  {
    "markdown": "\\[foo]\n\n[foo]: /url \"title\"\n",
    "html": "
[foo]
\n",
    "example": 563,
    "start_line": 8431,
    "end_line": 8437,
    "section": "Links"
  },
  {
    "markdown": "[foo*]: /url\n\n*[foo*]\n",
    "html": "
*foo*
\n",
    "example": 564,
    "start_line": 8443,
    "end_line": 8449,
    "section": "Links"
  },
  {
    "markdown": "[foo][bar]\n\n[foo]: /url1\n[bar]: /url2\n",
    "html": "
foo
\n",
    "example": 565,
    "start_line": 8455,
    "end_line": 8462,
    "section": "Links"
  },
  {
    "markdown": "[foo][]\n\n[foo]: /url1\n",
    "html": "
foo
\n",
    "example": 566,
    "start_line": 8464,
    "end_line": 8470,
    "section": "Links"
  },
  {
    "markdown": "[foo]()\n\n[foo]: /url1\n",
    "html": "
foo
\n",
    "example": 567,
    "start_line": 8474,
    "end_line": 8480,
    "section": "Links"
  },
  {
    "markdown": "[foo](not a link)\n\n[foo]: /url1\n",
    "html": "
foo(not a link)
\n",
    "example": 568,
    "start_line": 8482,
    "end_line": 8488,
    "section": "Links"
  },
  {
    "markdown": "[foo][bar][baz]\n\n[baz]: /url\n",
    "html": "
[foo]bar
\n",
    "example": 569,
    "start_line": 8493,
    "end_line": 8499,
    "section": "Links"
  },
  {
    "markdown": "[foo][bar][baz]\n\n[baz]: /url1\n[bar]: /url2\n",
    "html": "
foobaz
\n",
    "example": 570,
    "start_line": 8505,
    "end_line": 8512,
    "section": "Links"
  },
  {
    "markdown": "[foo][bar][baz]\n\n[baz]: /url1\n[foo]: /url2\n",
    "html": "
[foo]bar
\n",
    "example": 571,
    "start_line": 8518,
    "end_line": 8525,
    "section": "Links"
  },
  {
    "markdown": "![foo](/url \"title\")\n",
    "html": "
\"foo\"
\n",
    "example": 572,
    "start_line": 8541,
    "end_line": 8545,
    "section": "Images"
  },
  {
    "markdown": "![foo *bar*]\n\n[foo *bar*]: train.jpg \"train & tracks\"\n",
    "html": "
\"foo
\n",
    "example": 573,
    "start_line": 8548,
    "end_line": 8554,
    "section": "Images"
  },
  {
    "markdown": "![foo ![bar](/url)](/url2)\n",
    "html": "
\"foo
\n",
    "example": 574,
    "start_line": 8557,
    "end_line": 8561,
    "section": "Images"
  },
  {
    "markdown": "![foo [bar](/url)](/url2)\n",
    "html": "
\"foo
\n",
    "example": 575,
    "start_line": 8564,
    "end_line": 8568,
    "section": "Images"
  },
  {
    "markdown": "![foo *bar*][]\n\n[foo *bar*]: train.jpg \"train & tracks\"\n",
    "html": "
\"foo
\n",
    "example": 576,
    "start_line": 8578,
    "end_line": 8584,
    "section": "Images"
  },
  {
    "markdown": "![foo *bar*][foobar]\n\n[FOOBAR]: train.jpg \"train & tracks\"\n",
    "html": "
\"foo
\n",
    "example": 577,
    "start_line": 8587,
    "end_line": 8593,
    "section": "Images"
  },
  {
    "markdown": "![foo](train.jpg)\n",
    "html": "
\"foo\"
\n",
    "example": 578,
    "start_line": 8596,
    "end_line": 8600,
    "section": "Images"
  },
  {
    "markdown": "My ![foo bar](/path/to/train.jpg  \"title\"   )\n",
    "html": "
My \"foo
\n",
    "example": 579,
    "start_line": 8603,
    "end_line": 8607,
    "section": "Images"
  },
  {
    "markdown": "![foo]()\n",
    "html": "
\"foo\"
\n",
    "example": 580,
    "start_line": 8610,
    "end_line": 8614,
    "section": "Images"
  },
  {
    "markdown": "![](/url)\n",
    "html": "
\"\"
\n",
    "example": 581,
    "start_line": 8617,
    "end_line": 8621,
    "section": "Images"
  },
  {
    "markdown": "![foo][bar]\n\n[bar]: /url\n",
    "html": "
\"foo\"
\n",
    "example": 582,
    "start_line": 8626,
    "end_line": 8632,
    "section": "Images"
  },
  {
    "markdown": "![foo][bar]\n\n[BAR]: /url\n",
    "html": "
\"foo\"
\n",
    "example": 583,
    "start_line": 8635,
    "end_line": 8641,
    "section": "Images"
  },
  {
    "markdown": "![foo][]\n\n[foo]: /url \"title\"\n",
    "html": "
\"foo\"
\n",
    "example": 584,
    "start_line": 8646,
    "end_line": 8652,
    "section": "Images"
  },
  {
    "markdown": "![*foo* bar][]\n\n[*foo* bar]: /url \"title\"\n",
    "html": "
\"foo
\n",
    "example": 585,
    "start_line": 8655,
    "end_line": 8661,
    "section": "Images"
  },
  {
    "markdown": "![Foo][]\n\n[foo]: /url \"title\"\n",
    "html": "
\"Foo\"
\n",
    "example": 586,
    "start_line": 8666,
    "end_line": 8672,
    "section": "Images"
  },
  {
    "markdown": "![foo] \n[]\n\n[foo]: /url \"title\"\n",
    "html": "
\"foo\"\n[]
\n",
    "example": 587,
    "start_line": 8678,
    "end_line": 8686,
    "section": "Images"
  },
  {
    "markdown": "![foo]\n\n[foo]: /url \"title\"\n",
    "html": "
\"foo\"
\n",
    "example": 588,
    "start_line": 8691,
    "end_line": 8697,
    "section": "Images"
  },
  {
    "markdown": "![*foo* bar]\n\n[*foo* bar]: /url \"title\"\n",
    "html": "
\"foo
\n",
    "example": 589,
    "start_line": 8700,
    "end_line": 8706,
    "section": "Images"
  },
  {
    "markdown": "![[foo]]\n\n[[foo]]: /url \"title\"\n",
    "html": "
![[foo]]
\n
[[foo]]: /url "title"
\n",
    "example": 590,
    "start_line": 8711,
    "end_line": 8718,
    "section": "Images"
  },
  {
    "markdown": "![Foo]\n\n[foo]: /url \"title\"\n",
    "html": "
\"Foo\"
\n",
    "example": 591,
    "start_line": 8723,
    "end_line": 8729,
    "section": "Images"
  },
  {
    "markdown": "!\\[foo]\n\n[foo]: /url \"title\"\n",
    "html": "
![foo]
\n",
    "example": 592,
    "start_line": 8735,
    "end_line": 8741,
    "section": "Images"
  },
  {
    "markdown": "\\![foo]\n\n[foo]: /url \"title\"\n",
    "html": "
!foo
\n",
    "example": 593,
    "start_line": 8747,
    "end_line": 8753,
    "section": "Images"
  },
  {
    "markdown": "\n",
    "html": "
http://foo.bar.baz
\n",
    "example": 594,
    "start_line": 8780,
    "end_line": 8784,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
https://foo.bar.baz/test?q=hello&id=22&boolean
\n",
    "example": 595,
    "start_line": 8787,
    "end_line": 8791,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
irc://foo.bar:2233/baz
\n",
    "example": 596,
    "start_line": 8794,
    "end_line": 8798,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
MAILTO:FOO@BAR.BAZ
\n",
    "example": 597,
    "start_line": 8803,
    "end_line": 8807,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
a+b+c:d
\n",
    "example": 598,
    "start_line": 8815,
    "end_line": 8819,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
made-up-scheme://foo,bar
\n",
    "example": 599,
    "start_line": 8822,
    "end_line": 8826,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
https://../
\n",
    "example": 600,
    "start_line": 8829,
    "end_line": 8833,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
localhost:5001/foo
\n",
    "example": 601,
    "start_line": 8836,
    "end_line": 8840,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
<https://foo.bar/baz bim>
\n",
    "example": 602,
    "start_line": 8845,
    "end_line": 8849,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
https://example.com/\\[\\
\n",
    "example": 603,
    "start_line": 8854,
    "end_line": 8858,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
foo@bar.example.com
\n",
    "example": 604,
    "start_line": 8876,
    "end_line": 8880,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
foo+special@Bar.baz-bar0.com
\n",
    "example": 605,
    "start_line": 8883,
    "end_line": 8887,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
<foo+@bar.example.com>
\n",
    "example": 606,
    "start_line": 8892,
    "end_line": 8896,
    "section": "Autolinks"
  },
  {
    "markdown": "<>\n",
    "html": "
<>
\n",
    "example": 607,
    "start_line": 8901,
    "end_line": 8905,
    "section": "Autolinks"
  },
  {
    "markdown": "< https://foo.bar >\n",
    "html": "
< https://foo.bar >
\n",
    "example": 608,
    "start_line": 8908,
    "end_line": 8912,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
<m:abc>
\n",
    "example": 609,
    "start_line": 8915,
    "end_line": 8919,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
<foo.bar.baz>
\n",
    "example": 610,
    "start_line": 8922,
    "end_line": 8926,
    "section": "Autolinks"
  },
  {
    "markdown": "https://example.com\n",
    "html": "
https://example.com
\n",
    "example": 611,
    "start_line": 8929,
    "end_line": 8933,
    "section": "Autolinks"
  },
  {
    "markdown": "foo@bar.example.com\n",
    "html": "
foo@bar.example.com
\n",
    "example": 612,
    "start_line": 8936,
    "end_line": 8940,
    "section": "Autolinks"
  },
  {
    "markdown": "\n",
    "html": "
\n",
    "example": 613,
    "start_line": 9016,
    "end_line": 9020,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
\n",
    "example": 614,
    "start_line": 9025,
    "end_line": 9029,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
\n",
    "example": 615,
    "start_line": 9034,
    "end_line": 9040,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
\n",
    "example": 616,
    "start_line": 9045,
    "end_line": 9051,
    "section": "Raw HTML"
  },
  {
    "markdown": "Foo \n",
    "html": "
Foo 
\n",
    "example": 617,
    "start_line": 9056,
    "end_line": 9060,
    "section": "Raw HTML"
  },
  {
    "markdown": "<33> <__>\n",
    "html": "
<33> <__>
\n",
    "example": 618,
    "start_line": 9065,
    "end_line": 9069,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
<a h*#ref="hi">
\n",
    "example": 619,
    "start_line": 9074,
    "end_line": 9078,
    "section": "Raw HTML"
  },
  {
    "markdown": " \n",
    "html": "
<a href="hi'> <a href=hi'>
\n",
    "example": 620,
    "start_line": 9083,
    "end_line": 9087,
    "section": "Raw HTML"
  },
  {
    "markdown": "< a><\nfoo>\n\n",
    "html": "
< a><\nfoo><bar/ >\n<foo bar=baz\nbim!bop />
\n",
    "example": 621,
    "start_line": 9092,
    "end_line": 9102,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
<a href='bar'title=title>
\n",
    "example": 622,
    "start_line": 9107,
    "end_line": 9111,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
\n",
    "example": 623,
    "start_line": 9116,
    "end_line": 9120,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
</a href="foo">
\n",
    "example": 624,
    "start_line": 9125,
    "end_line": 9129,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo \n",
    "html": "
foo 
\n",
    "example": 625,
    "start_line": 9134,
    "end_line": 9140,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo  foo -->\n\nfoo  foo -->\n",
    "html": "
foo  foo -->
\n
foo  foo -->
\n",
    "example": 626,
    "start_line": 9142,
    "end_line": 9149,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo \n",
    "html": "
foo 
\n",
    "example": 627,
    "start_line": 9154,
    "end_line": 9158,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo \n",
    "html": "
foo 
\n",
    "example": 628,
    "start_line": 9163,
    "end_line": 9167,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo &<]]>\n",
    "html": "
foo &<]]>
\n",
    "example": 629,
    "start_line": 9172,
    "end_line": 9176,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo \n",
    "html": "
foo 
\n",
    "example": 630,
    "start_line": 9182,
    "end_line": 9186,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo \n",
    "html": "
foo 
\n",
    "example": 631,
    "start_line": 9191,
    "end_line": 9195,
    "section": "Raw HTML"
  },
  {
    "markdown": "\n",
    "html": "
<a href=""">
\n",
    "example": 632,
    "start_line": 9198,
    "end_line": 9202,
    "section": "Raw HTML"
  },
  {
    "markdown": "foo  \nbaz\n",
    "html": "
foo
\nbaz
\n",
    "example": 633,
    "start_line": 9212,
    "end_line": 9218,
    "section": "Hard line breaks"
  },
  {
    "markdown": "foo\\\nbaz\n",
    "html": "
foo
\nbaz
\n",
    "example": 634,
    "start_line": 9224,
    "end_line": 9230,
    "section": "Hard line breaks"
  },
  {
    "markdown": "foo       \nbaz\n",
    "html": "
foo
\nbaz
\n",
    "example": 635,
    "start_line": 9235,
    "end_line": 9241,
    "section": "Hard line breaks"
  },
  {
    "markdown": "foo  \n     bar\n",
    "html": "
foo
\nbar
\n",
    "example": 636,
    "start_line": 9246,
    "end_line": 9252,
    "section": "Hard line breaks"
  },
  {
    "markdown": "foo\\\n     bar\n",
    "html": "
foo
\nbar
\n",
    "example": 637,
    "start_line": 9255,
    "end_line": 9261,
    "section": "Hard line breaks"
  },
  {
    "markdown": "*foo  \nbar*\n",
    "html": "
foo
\nbar
\n",
    "example": 638,
    "start_line": 9267,
    "end_line": 9273,
    "section": "Hard line breaks"
  },
  {
    "markdown": "*foo\\\nbar*\n",
    "html": "
foo
\nbar
\n",
    "example": 639,
    "start_line": 9276,
    "end_line": 9282,
    "section": "Hard line breaks"
  },
  {
    "markdown": "`code  \nspan`\n",
    "html": "
code   span
\n",
    "example": 640,
    "start_line": 9287,
    "end_line": 9292,
    "section": "Hard line breaks"
  },
  {
    "markdown": "`code\\\nspan`\n",
    "html": "
code\\ span
\n",
    "example": 641,
    "start_line": 9295,
    "end_line": 9300,
    "section": "Hard line breaks"
  },
  {
    "markdown": "\n",
    "html": "
\n",
    "example": 642,
    "start_line": 9305,
    "end_line": 9311,
    "section": "Hard line breaks"
  },
  {
    "markdown": "\n",
    "html": "
\n",
    "example": 643,
    "start_line": 9314,
    "end_line": 9320,
    "section": "Hard line breaks"
  },
  {
    "markdown": "foo\\\n",
    "html": "
foo\\
\n",
    "example": 644,
    "start_line": 9327,
    "end_line": 9331,
    "section": "Hard line breaks"
  },
  {
    "markdown": "foo  \n",
    "html": "
foo
\n",
    "example": 645,
    "start_line": 9334,
    "end_line": 9338,
    "section": "Hard line breaks"
  },
  {
    "markdown": "### foo\\\n",
    "html": "
foo\\
\n",
    "example": 646,
    "start_line": 9341,
    "end_line": 9345,
    "section": "Hard line breaks"
  },
  {
    "markdown": "### foo  \n",
    "html": "
foo
\n",
    "example": 647,
    "start_line": 9348,
    "end_line": 9352,
    "section": "Hard line breaks"
  },
  {
    "markdown": "foo\nbaz\n",
    "html": "
foo\nbaz
\n",
    "example": 648,
    "start_line": 9363,
    "end_line": 9369,
    "section": "Soft line breaks"
  },
  {
    "markdown": "foo \n baz\n",
    "html": "
foo\nbaz
\n",
    "example": 649,
    "start_line": 9375,
    "end_line": 9381,
    "section": "Soft line breaks"
  },
  {
    "markdown": "hello $.;'there\n",
    "html": "
hello $.;'there
\n",
    "example": 650,
    "start_line": 9395,
    "end_line": 9399,
    "section": "Textual content"
  },
  {
    "markdown": "Foo χρῆν\n",
    "html": "
Foo χρῆν
\n",
    "example": 651,
    "start_line": 9402,
    "end_line": 9406,
    "section": "Textual content"
  },
  {
    "markdown": "Multiple     spaces\n",
    "html": "
Multiple     spaces
\n",
    "example": 652,
    "start_line": 9411,
    "end_line": 9415,
    "section": "Textual content"
  }
]markdown-it-py-4.2.0/tests/test_cmark_spec/get_cmark_spec.py000066400000000000000000000057321517710005200242340ustar00rootroot00000000000000# /// script
# dependencies = [
#   "requests",
# ]
# ///
from pathlib import Path
from typing import Any

default_version = "0.31.2"
default_json_path = Path(__file__).parent / "commonmark.json"
default_text_path = Path(__file__).parent / "spec.md"
default_fixture_path = (
    Path(__file__).parent.parent / "test_port" / "fixtures" / "commonmark_spec.md"
)


def create_argparser():
    import argparse

    parser = argparse.ArgumentParser(description="Download CommonMark spec JSON")
    parser.add_argument(
        "version",
        nargs="?",
        default=default_version,
        help=f"CommonMark spec version to download (default: {default_version})",
    )
    parser.add_argument(
        "--output-json",
        type=Path,
        default=default_json_path,
        help=f"Output file path (default: {default_json_path})",
    )
    parser.add_argument(
        "--output-text",
        type=Path,
        default=default_text_path,
        help=f"Output file path (default: {default_text_path})",
    )
    parser.add_argument(
        "--output-fixture",
        type=Path,
        default=default_fixture_path,
        help=f"Write to test fixture (default: {default_fixture_path})",
    )
    return parser


def _json_to_fixture(data: list[dict[str, Any]]) -> str:
    text = ""
    for item in data:
        text += "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n"
        text += f"src line: {item['start_line'] - 1}\n\n"
        text += f".\n{item['markdown']}.\n{item['html']}.\n\n"
    return text


if __name__ == "__main__":
    import requests  # type: ignore[import-untyped]

    args = create_argparser().parse_args()
    version: str = args.version
    json_path: Path = args.output_json
    txt_path: Path = args.output_text
    test_fixture: Path = args.output_fixture

    changed = False

    json_url = f"https://spec.commonmark.org/{version}/spec.json"
    txt_url = f"https://raw.githubusercontent.com/commonmark/commonmark-spec/refs/tags/{version}/spec.txt"

    for url, output_path in ((json_url, json_path), (txt_url, txt_path)):
        print(f"Downloading CommonMark spec from {url}")
        response = requests.get(url)
        response.raise_for_status()
        if not output_path.exists() or output_path.read_text() != response.text:
            changed = True
            with output_path.open("w") as f:
                f.write(response.text)
            print(f"Updated to {output_path}")
        else:
            print(f"File {output_path} is up to date, not overwriting")

    # write_to_test_fixture:
    response = requests.get(json_url)
    response.raise_for_status()
    data = response.json()
    text = _json_to_fixture(data)
    if not test_fixture.exists() or test_fixture.read_text() != text:
        changed = True
        with test_fixture.open("w") as f:
            f.write(text)
        print(f"Also updated to {test_fixture}")
    else:
        print(f"Fixture file {test_fixture} is up to date, not overwriting")

    raise SystemExit(0 if not changed else 1)
markdown-it-py-4.2.0/tests/test_cmark_spec/spec.md000066400000000000000000006203411517710005200221670ustar00rootroot00000000000000---
title: CommonMark Spec
author: John MacFarlane
version: '0.31.2'
date: '2024-01-28'
license: '[CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)'
...

# Introduction

## What is Markdown?

Markdown is a plain text format for writing structured documents,
based on conventions for indicating formatting in email
and usenet posts.  It was developed by John Gruber (with
help from Aaron Swartz) and released in 2004 in the form of a
[syntax description](https://daringfireball.net/projects/markdown/syntax)
and a Perl script (`Markdown.pl`) for converting Markdown to
HTML.  In the next decade, dozens of implementations were
developed in many languages.  Some extended the original
Markdown syntax with conventions for footnotes, tables, and
other document elements.  Some allowed Markdown documents to be
rendered in formats other than HTML.  Websites like Reddit,
StackOverflow, and GitHub had millions of people using Markdown.
And Markdown started to be used beyond the web, to author books,
articles, slide shows, letters, and lecture notes.

What distinguishes Markdown from many other lightweight markup
syntaxes, which are often easier to write, is its readability.
As Gruber writes:

> The overriding design goal for Markdown's formatting syntax is
> to make it as readable as possible. The idea is that a
> Markdown-formatted document should be publishable as-is, as
> plain text, without looking like it's been marked up with tags
> or formatting instructions.
> ()

The point can be illustrated by comparing a sample of
[AsciiDoc](https://asciidoc.org/) with
an equivalent sample of Markdown.  Here is a sample of
AsciiDoc from the AsciiDoc manual:

```
1. List item one.
+
List item one continued with a second paragraph followed by an
Indented block.
+
.................
$ ls *.sh
$ mv *.sh ~/tmp
.................
+
List item continued with a third paragraph.

2. List item two continued with an open block.
+
--
This paragraph is part of the preceding list item.

a. This list is nested and does not require explicit item
continuation.
+
This paragraph is part of the preceding list item.

b. List item b.

This paragraph belongs to item two of the outer list.
--
```

And here is the equivalent in Markdown:
```
1.  List item one.

    List item one continued with a second paragraph followed by an
    Indented block.

        $ ls *.sh
        $ mv *.sh ~/tmp

    List item continued with a third paragraph.

2.  List item two continued with an open block.

    This paragraph is part of the preceding list item.

    1. This list is nested and does not require explicit item continuation.

       This paragraph is part of the preceding list item.

    2. List item b.

    This paragraph belongs to item two of the outer list.
```

The AsciiDoc version is, arguably, easier to write. You don't need
to worry about indentation.  But the Markdown version is much easier
to read.  The nesting of list items is apparent to the eye in the
source, not just in the processed document.

## Why is a spec needed?

John Gruber's [canonical description of Markdown's
syntax](https://daringfireball.net/projects/markdown/syntax)
does not specify the syntax unambiguously.  Here are some examples of
questions it does not answer:

1.  How much indentation is needed for a sublist?  The spec says that
    continuation paragraphs need to be indented four spaces, but is
    not fully explicit about sublists.  It is natural to think that
    they, too, must be indented four spaces, but `Markdown.pl` does
    not require that.  This is hardly a "corner case," and divergences
    between implementations on this issue often lead to surprises for
    users in real documents. (See [this comment by John
    Gruber](https://web.archive.org/web/20170611172104/http://article.gmane.org/gmane.text.markdown.general/1997).)

2.  Is a blank line needed before a block quote or heading?
    Most implementations do not require the blank line.  However,
    this can lead to unexpected results in hard-wrapped text, and
    also to ambiguities in parsing (note that some implementations
    put the heading inside the blockquote, while others do not).
    (John Gruber has also spoken [in favor of requiring the blank
    lines](https://web.archive.org/web/20170611172104/http://article.gmane.org/gmane.text.markdown.general/2146).)

3.  Is a blank line needed before an indented code block?
    (`Markdown.pl` requires it, but this is not mentioned in the
    documentation, and some implementations do not require it.)

    ``` markdown
    paragraph
        code?
    ```

4.  What is the exact rule for determining when list items get
    wrapped in `
` tags?  Can a list be partially "loose" and partially
    "tight"?  What should we do with a list like this?

    ``` markdown
    1. one

    2. two
    3. three
    ```

    Or this?

    ``` markdown
    1.  one
        - a

        - b
    2.  two
    ```

    (There are some relevant comments by John Gruber
    [here](https://web.archive.org/web/20170611172104/http://article.gmane.org/gmane.text.markdown.general/2554).)

5.  Can list markers be indented?  Can ordered list markers be right-aligned?

    ``` markdown
     8. item 1
     9. item 2
    10. item 2a
    ```

6.  Is this one list with a thematic break in its second item,
    or two lists separated by a thematic break?

    ``` markdown
    * a
    * * * * *
    * b
    ```

7.  When list markers change from numbers to bullets, do we have
    two lists or one?  (The Markdown syntax description suggests two,
    but the perl scripts and many other implementations produce one.)

    ``` markdown
    1. fee
    2. fie
    -  foe
    -  fum
    ```

8.  What are the precedence rules for the markers of inline structure?
    For example, is the following a valid link, or does the code span
    take precedence ?

    ``` markdown
    [a backtick (`)](/url) and [another backtick (`)](/url).
    ```

9.  What are the precedence rules for markers of emphasis and strong
    emphasis?  For example, how should the following be parsed?

    ``` markdown
    *foo *bar* baz*
    ```

10. What are the precedence rules between block-level and inline-level
    structure?  For example, how should the following be parsed?

    ``` markdown
    - `a long code span can contain a hyphen like this
      - and it can screw things up`
    ```

11. Can list items include section headings?  (`Markdown.pl` does not
    allow this, but does allow blockquotes to include headings.)

    ``` markdown
    - # Heading
    ```

12. Can list items be empty?

    ``` markdown
    * a
    *
    * b
    ```

13. Can link references be defined inside block quotes or list items?

    ``` markdown
    > Blockquote [foo].
    >
    > [foo]: /url
    ```

14. If there are multiple definitions for the same reference, which takes
    precedence?

    ``` markdown
    [foo]: /url1
    [foo]: /url2

    [foo][]
    ```

In the absence of a spec, early implementers consulted `Markdown.pl`
to resolve these ambiguities.  But `Markdown.pl` was quite buggy, and
gave manifestly bad results in many cases, so it was not a
satisfactory replacement for a spec.

Because there is no unambiguous spec, implementations have diverged
considerably.  As a result, users are often surprised to find that
a document that renders one way on one system (say, a GitHub wiki)
renders differently on another (say, converting to docbook using
pandoc).  To make matters worse, because nothing in Markdown counts
as a "syntax error," the divergence often isn't discovered right away.

## About this document

This document attempts to specify Markdown syntax unambiguously.
It contains many examples with side-by-side Markdown and
HTML.  These are intended to double as conformance tests.  An
accompanying script `spec_tests.py` can be used to run the tests
against any Markdown program:

    python test/spec_tests.py --spec spec.txt --program PROGRAM

Since this document describes how Markdown is to be parsed into
an abstract syntax tree, it would have made sense to use an abstract
representation of the syntax tree instead of HTML.  But HTML is capable
of representing the structural distinctions we need to make, and the
choice of HTML for the tests makes it possible to run the tests against
an implementation without writing an abstract syntax tree renderer.

Note that not every feature of the HTML samples is mandated by
the spec.  For example, the spec says what counts as a link
destination, but it doesn't mandate that non-ASCII characters in
the URL be percent-encoded.  To use the automatic tests,
implementers will need to provide a renderer that conforms to
the expectations of the spec examples (percent-encoding
non-ASCII characters in URLs).  But a conforming implementation
can use a different renderer and may choose not to
percent-encode non-ASCII characters in URLs.

This document is generated from a text file, `spec.txt`, written
in Markdown with a small extension for the side-by-side tests.
The script `tools/makespec.py` can be used to convert `spec.txt` into
HTML or CommonMark (which can then be converted into other formats).

In the examples, the `→` character is used to represent tabs.

# Preliminaries

## Characters and lines

Any sequence of [characters] is a valid CommonMark
document.

A [character](@) is a Unicode code point.  Although some
code points (for example, combining accents) do not correspond to
characters in an intuitive sense, all code points count as characters
for purposes of this spec.

This spec does not specify an encoding; it thinks of lines as composed
of [characters] rather than bytes.  A conforming parser may be limited
to a certain encoding.

A [line](@) is a sequence of zero or more [characters]
other than line feed (`U+000A`) or carriage return (`U+000D`),
followed by a [line ending] or by the end of file.

A [line ending](@) is a line feed (`U+000A`), a carriage return
(`U+000D`) not followed by a line feed, or a carriage return and a
following line feed.

A line containing no characters, or a line containing only spaces
(`U+0020`) or tabs (`U+0009`), is called a [blank line](@).

The following definitions of character classes will be used in this spec:

A [Unicode whitespace character](@) is a character in the Unicode `Zs` general
category, or a tab (`U+0009`), line feed (`U+000A`), form feed (`U+000C`), or
carriage return (`U+000D`).

[Unicode whitespace](@) is a sequence of one or more
[Unicode whitespace characters].

A [tab](@) is `U+0009`.

A [space](@) is `U+0020`.

An [ASCII control character](@) is a character between `U+0000–1F` (both
including) or `U+007F`.

An [ASCII punctuation character](@)
is `!`, `"`, `#`, `$`, `%`, `&`, `'`, `(`, `)`,
`*`, `+`, `,`, `-`, `.`, `/` (U+0021–2F), 
`:`, `;`, `<`, `=`, `>`, `?`, `@` (U+003A–0040),
`[`, `\`, `]`, `^`, `_`, `` ` `` (U+005B–0060), 
`{`, `|`, `}`, or `~` (U+007B–007E).

A [Unicode punctuation character](@) is a character in the Unicode `P`
(puncuation) or `S` (symbol) general categories.

## Tabs

Tabs in lines are not expanded to [spaces].  However,
in contexts where spaces help to define block structure,
tabs behave as if they were replaced by spaces with a tab stop
of 4 characters.

Thus, for example, a tab can be used instead of four spaces
in an indented code block.  (Note, however, that internal
tabs are passed through as literal tabs, not expanded to
spaces.)

```````````````````````````````` example
→foo→baz→→bim
.

foo→baz→→bim


````````````````````````````````

```````````````````````````````` example
  →foo→baz→→bim
.

foo→baz→→bim


````````````````````````````````

```````````````````````````````` example
    a→a
    ὐ→a
.

a→a
ὐ→a


````````````````````````````````

In the following example, a continuation paragraph of a list
item is indented with a tab; this has exactly the same effect
as indentation with four spaces would:

```````````````````````````````` example
  - foo

→bar
.

    

  • 

    foo
    

    bar
    

    • 


````````````````````````````````

```````````````````````````````` example
- foo

→→bar
.

    

  • 

    foo
    

      bar

    

    • 


````````````````````````````````

Normally the `>` that begins a block quote may be followed
optionally by a space, which is not considered part of the
content.  In the following case `>` is followed by a tab,
which is treated as if it were expanded into three spaces.
Since one of these spaces is considered part of the
delimiter, `foo` is considered to be indented six spaces
inside the block quote context, so we get an indented
code block starting with two spaces.

```````````````````````````````` example
>→→foo
.



  foo




````````````````````````````````

```````````````````````````````` example
-→→foo
.

    

  • 

      foo

    

    • 


````````````````````````````````


```````````````````````````````` example
    foo
→bar
.

foo
bar


````````````````````````````````

```````````````````````````````` example
 - foo
   - bar
→ - baz
.

    

  • foo

      

    • bar

        

      • baz
        • 

      

      • 

    

    • 


````````````````````````````````

```````````````````````````````` example
#→Foo
.

Foo

````````````````````````````````

```````````````````````````````` example
*→*→*→
.


````````````````````````````````


## Insecure characters

For security reasons, the Unicode character `U+0000` must be replaced
with the REPLACEMENT CHARACTER (`U+FFFD`).


## Backslash escapes

Any ASCII punctuation character may be backslash-escaped:

```````````````````````````````` example
\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~
.

!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

````````````````````````````````


Backslashes before other characters are treated as literal
backslashes:

```````````````````````````````` example
\→\A\a\ \3\φ\«
.

\→\A\a\ \3\φ\«

````````````````````````````````


Escaped characters are treated as regular characters and do
not have their usual Markdown meanings:

```````````````````````````````` example
\*not emphasized*
\
 not a tag
\[not a link](/foo)
\`not code`
1\. not a list
\* not a list
\# not a heading
\[foo]: /url "not a reference"
\ö not a character entity
.

*not emphasized*
<br/> not a tag
[not a link](/foo)
`not code`
1. not a list
* not a list
# not a heading
[foo]: /url "not a reference"
&ouml; not a character entity

````````````````````````````````


If a backslash is itself escaped, the following character is not:

```````````````````````````````` example
\\*emphasis*
.

\emphasis

````````````````````````````````


A backslash at the end of the line is a [hard line break]:

```````````````````````````````` example
foo\
bar
.

foo

bar

````````````````````````````````


Backslash escapes do not work in code blocks, code spans, autolinks, or
raw HTML:

```````````````````````````````` example
`` \[\` ``
.

\[\`

````````````````````````````````


```````````````````````````````` example
    \[\]
.

\[\]


````````````````````````````````


```````````````````````````````` example
~~~
\[\]
~~~
.

\[\]


````````````````````````````````


```````````````````````````````` example

.

https://example.com?find=\*

````````````````````````````````


```````````````````````````````` example

.

````````````````````````````````


But they work in all other contexts, including URLs and link titles,
link references, and [info strings] in [fenced code blocks]:

```````````````````````````````` example
[foo](/bar\* "ti\*tle")
.

foo

````````````````````````````````


```````````````````````````````` example
[foo]

[foo]: /bar\* "ti\*tle"
.

foo

````````````````````````````````


```````````````````````````````` example
``` foo\+bar
foo
```
.

foo


````````````````````````````````


## Entity and numeric character references

Valid HTML entity references and numeric character references
can be used in place of the corresponding Unicode character,
with the following exceptions:

- Entity and character references are not recognized in code
  blocks and code spans.

- Entity and character references cannot stand in place of
  special characters that define structural elements in
  CommonMark.  For example, although `*` can be used
  in place of a literal `*` character, `*` cannot replace
  `*` in emphasis delimiters, bullet list markers, or thematic
  breaks.

Conforming CommonMark parsers need not store information about
whether a particular character was represented in the source
using a Unicode character or an entity reference.

[Entity references](@) consist of `&` + any of the valid
HTML5 entity names + `;`. The
document 
is used as an authoritative source for the valid entity
references and their corresponding code points.

```````````````````````````````` example
  & © Æ Ď
¾ ℋ ⅆ
∲ ≧̸
.

  & © Æ Ď
¾ ℋ ⅆ
∲ ≧̸

````````````````````````````````


[Decimal numeric character
references](@)
consist of `&#` + a string of 1--7 arabic digits + `;`. A
numeric character reference is parsed as the corresponding
Unicode character. Invalid Unicode code points will be replaced by
the REPLACEMENT CHARACTER (`U+FFFD`).  For security reasons,
the code point `U+0000` will also be replaced by `U+FFFD`.

```````````````````````````````` example
# Ӓ Ϡ �
.

# Ӓ Ϡ �

````````````````````````````````


[Hexadecimal numeric character
references](@) consist of `&#` +
either `X` or `x` + a string of 1-6 hexadecimal digits + `;`.
They too are parsed as the corresponding Unicode character (this
time specified with a hexadecimal numeral instead of decimal).

```````````````````````````````` example
" ആ ಫ
.

" ആ ಫ

````````````````````````````````


Here are some nonentities:

```````````````````````````````` example
  &x; &#; &#x;
�
&#abcdef0;
&ThisIsNotDefined; &hi?;
.

&nbsp &x; &#; &#x;
&#87654321;
&#abcdef0;
&ThisIsNotDefined; &hi?;

````````````````````````````````


Although HTML5 does accept some entity references
without a trailing semicolon (such as `©`), these are not
recognized here, because it makes the grammar too ambiguous:

```````````````````````````````` example
©
.

&copy

````````````````````````````````


Strings that are not on the list of HTML5 named entities are not
recognized as entity references either:

```````````````````````````````` example
&MadeUpEntity;
.

&MadeUpEntity;

````````````````````````````````


Entity and numeric character references are recognized in any
context besides code spans or code blocks, including
URLs, [link titles], and [fenced code block][] [info strings]:

```````````````````````````````` example

.

````````````````````````````````


```````````````````````````````` example
[foo](/föö "föö")
.

foo

````````````````````````````````


```````````````````````````````` example
[foo]

[foo]: /föö "föö"
.

foo

````````````````````````````````


```````````````````````````````` example
``` föö
foo
```
.

foo


````````````````````````````````


Entity and numeric character references are treated as literal
text in code spans and code blocks:

```````````````````````````````` example
`föö`
.

f&ouml;&ouml;

````````````````````````````````


```````````````````````````````` example
    föfö
.

f&ouml;f&ouml;


````````````````````````````````


Entity and numeric character references cannot be used
in place of symbols indicating structure in CommonMark
documents.

```````````````````````````````` example
*foo*
*foo*
.

*foo*
foo

````````````````````````````````

```````````````````````````````` example
* foo

* foo
.

* foo


    

  • foo
    • 


````````````````````````````````

```````````````````````````````` example
foo

bar
.

foo

bar

````````````````````````````````

```````````````````````````````` example
	foo
.

→foo

````````````````````````````````


```````````````````````````````` example
[a](url "tit")
.

[a](url "tit")

````````````````````````````````



# Blocks and inlines

We can think of a document as a sequence of
[blocks](@)---structural elements like paragraphs, block
quotations, lists, headings, rules, and code blocks.  Some blocks (like
block quotes and list items) contain other blocks; others (like
headings and paragraphs) contain [inline](@) content---text,
links, emphasized text, images, code spans, and so on.

## Precedence

Indicators of block structure always take precedence over indicators
of inline structure.  So, for example, the following is a list with
two items, not a list with one item containing a code span:

```````````````````````````````` example
- `one
- two`
.

    

  • `one
    • 

  • two`
    • 


````````````````````````````````


This means that parsing can proceed in two steps:  first, the block
structure of the document can be discerned; second, text lines inside
paragraphs, headings, and other block constructs can be parsed for inline
structure.  The second step requires information about link reference
definitions that will be available only at the end of the first
step.  Note that the first step requires processing lines in sequence,
but the second can be parallelized, since the inline parsing of
one block element does not affect the inline parsing of any other.

## Container blocks and leaf blocks

We can divide blocks into two types:
[container blocks](#container-blocks),
which can contain other blocks, and [leaf blocks](#leaf-blocks),
which cannot.

# Leaf blocks

This section describes the different kinds of leaf block that make up a
Markdown document.

## Thematic breaks

A line consisting of optionally up to three spaces of indentation, followed by a
sequence of three or more matching `-`, `_`, or `*` characters, each followed
optionally by any number of spaces or tabs, forms a
[thematic break](@).

```````````````````````````````` example
***
---
___
.






````````````````````````````````


Wrong characters:

```````````````````````````````` example
+++
.

+++

````````````````````````````````


```````````````````````````````` example
===
.

===

````````````````````````````````


Not enough characters:

```````````````````````````````` example
--
**
__
.

--
**
__

````````````````````````````````


Up to three spaces of indentation are allowed:

```````````````````````````````` example
 ***
  ***
   ***
.






````````````````````````````````


Four spaces of indentation is too many:

```````````````````````````````` example
    ***
.

***


````````````````````````````````


```````````````````````````````` example
Foo
    ***
.

Foo
***

````````````````````````````````


More than three characters may be used:

```````````````````````````````` example
_____________________________________
.


````````````````````````````````


Spaces and tabs are allowed between the characters:

```````````````````````````````` example
 - - -
.


````````````````````````````````


```````````````````````````````` example
 **  * ** * ** * **
.


````````````````````````````````


```````````````````````````````` example
-     -      -      -
.


````````````````````````````````


Spaces and tabs are allowed at the end:

```````````````````````````````` example
- - - -    
.


````````````````````````````````


However, no other characters may occur in the line:

```````````````````````````````` example
_ _ _ _ a

a------

---a---
.

_ _ _ _ a


a------


---a---

````````````````````````````````


It is required that all of the characters other than spaces or tabs be the same.
So, this is not a thematic break:

```````````````````````````````` example
 *-*
.

-

````````````````````````````````


Thematic breaks do not need blank lines before or after:

```````````````````````````````` example
- foo
***
- bar
.

    

  • foo
    • 





    

  • bar
    • 


````````````````````````````````


Thematic breaks can interrupt a paragraph:

```````````````````````````````` example
Foo
***
bar
.

Foo




bar

````````````````````````````````


If a line of dashes that meets the above conditions for being a
thematic break could also be interpreted as the underline of a [setext
heading], the interpretation as a
[setext heading] takes precedence. Thus, for example,
this is a setext heading, not a paragraph followed by a thematic break:

```````````````````````````````` example
Foo
---
bar
.

Foo


bar

````````````````````````````````


When both a thematic break and a list item are possible
interpretations of a line, the thematic break takes precedence:

```````````````````````````````` example
* Foo
* * *
* Bar
.

    

  • Foo
    • 





    

  • Bar
    • 


````````````````````````````````


If you want a thematic break in a list item, use a different bullet:

```````````````````````````````` example
- Foo
- * * *
.

    

  • Foo
    • 

  • 

    

    • 


````````````````````````````````


## ATX headings

An [ATX heading](@)
consists of a string of characters, parsed as inline content, between an
opening sequence of 1--6 unescaped `#` characters and an optional
closing sequence of any number of unescaped `#` characters.
The opening sequence of `#` characters must be followed by spaces or tabs, or
by the end of line. The optional closing sequence of `#`s must be preceded by
spaces or tabs and may be followed by spaces or tabs only.  The opening
`#` character may be preceded by up to three spaces of indentation.  The raw
contents of the heading are stripped of leading and trailing space or tabs
before being parsed as inline content.  The heading level is equal to the number
of `#` characters in the opening sequence.

Simple headings:

```````````````````````````````` example
# foo
## foo
### foo
#### foo
##### foo
###### foo
.

foo


foo


foo


foo


foo


foo

````````````````````````````````


More than six `#` characters is not a heading:

```````````````````````````````` example
####### foo
.

####### foo

````````````````````````````````


At least one space or tab is required between the `#` characters and the
heading's contents, unless the heading is empty.  Note that many
implementations currently do not require the space.  However, the
space was required by the
[original ATX implementation](http://www.aaronsw.com/2002/atx/atx.py),
and it helps prevent things like the following from being parsed as
headings:

```````````````````````````````` example
#5 bolt

#hashtag
.

#5 bolt


#hashtag

````````````````````````````````


This is not a heading, because the first `#` is escaped:

```````````````````````````````` example
\## foo
.

## foo

````````````````````````````````


Contents are parsed as inlines:

```````````````````````````````` example
# foo *bar* \*baz\*
.

foo bar *baz*

````````````````````````````````


Leading and trailing spaces or tabs are ignored in parsing inline content:

```````````````````````````````` example
#                  foo                     
.

foo

````````````````````````````````


Up to three spaces of indentation are allowed:

```````````````````````````````` example
 ### foo
  ## foo
   # foo
.

foo


foo


foo

````````````````````````````````


Four spaces of indentation is too many:

```````````````````````````````` example
    # foo
.

# foo


````````````````````````````````


```````````````````````````````` example
foo
    # bar
.

foo
# bar

````````````````````````````````


A closing sequence of `#` characters is optional:

```````````````````````````````` example
## foo ##
  ###   bar    ###
.

foo


bar

````````````````````````````````


It need not be the same length as the opening sequence:

```````````````````````````````` example
# foo ##################################
##### foo ##
.

foo


foo

````````````````````````````````


Spaces or tabs are allowed after the closing sequence:

```````````````````````````````` example
### foo ###     
.

foo

````````````````````````````````


A sequence of `#` characters with anything but spaces or tabs following it
is not a closing sequence, but counts as part of the contents of the
heading:

```````````````````````````````` example
### foo ### b
.

foo ### b

````````````````````````````````


The closing sequence must be preceded by a space or tab:

```````````````````````````````` example
# foo#
.

foo#

````````````````````````````````


Backslash-escaped `#` characters do not count as part
of the closing sequence:

```````````````````````````````` example
### foo \###
## foo #\##
# foo \#
.

foo ###


foo ###


foo #

````````````````````````````````


ATX headings need not be separated from surrounding content by blank
lines, and they can interrupt paragraphs:

```````````````````````````````` example
****
## foo
****
.



foo



````````````````````````````````


```````````````````````````````` example
Foo bar
# baz
Bar foo
.

Foo bar


baz


Bar foo

````````````````````````````````


ATX headings can be empty:

```````````````````````````````` example
## 
#
### ###
.






````````````````````````````````


## Setext headings

A [setext heading](@) consists of one or more
lines of text, not interrupted by a blank line, of which the first line does not
have more than 3 spaces of indentation, followed by
a [setext heading underline].  The lines of text must be such
that, were they not followed by the setext heading underline,
they would be interpreted as a paragraph:  they cannot be
interpretable as a [code fence], [ATX heading][ATX headings],
[block quote][block quotes], [thematic break][thematic breaks],
[list item][list items], or [HTML block][HTML blocks].

A [setext heading underline](@) is a sequence of
`=` characters or a sequence of `-` characters, with no more than 3
spaces of indentation and any number of trailing spaces or tabs.

The heading is a level 1 heading if `=` characters are used in
the [setext heading underline], and a level 2 heading if `-`
characters are used.  The contents of the heading are the result
of parsing the preceding lines of text as CommonMark inline
content.

In general, a setext heading need not be preceded or followed by a
blank line.  However, it cannot interrupt a paragraph, so when a
setext heading comes after a paragraph, a blank line is needed between
them.

Simple examples:

```````````````````````````````` example
Foo *bar*
=========

Foo *bar*
---------
.

Foo bar


Foo bar

````````````````````````````````


The content of the header may span more than one line:

```````````````````````````````` example
Foo *bar
baz*
====
.

Foo bar
baz

````````````````````````````````

The contents are the result of parsing the headings's raw
content as inlines.  The heading's raw content is formed by
concatenating the lines and removing initial and final
spaces or tabs.

```````````````````````````````` example
  Foo *bar
baz*→
====
.

Foo bar
baz

````````````````````````````````


The underlining can be any length:

```````````````````````````````` example
Foo
-------------------------

Foo
=
.

Foo


Foo

````````````````````````````````


The heading content can be preceded by up to three spaces of indentation, and
need not line up with the underlining:

```````````````````````````````` example
   Foo
---

  Foo
-----

  Foo
  ===
.

Foo


Foo


Foo

````````````````````````````````


Four spaces of indentation is too many:

```````````````````````````````` example
    Foo
    ---

    Foo
---
.

Foo
---

Foo




````````````````````````````````


The setext heading underline can be preceded by up to three spaces of
indentation, and may have trailing spaces or tabs:

```````````````````````````````` example
Foo
   ----      
.

Foo

````````````````````````````````


Four spaces of indentation is too many:

```````````````````````````````` example
Foo
    ---
.

Foo
---

````````````````````````````````


The setext heading underline cannot contain internal spaces or tabs:

```````````````````````````````` example
Foo
= =

Foo
--- -
.

Foo
= =


Foo



````````````````````````````````


Trailing spaces or tabs in the content line do not cause a hard line break:

```````````````````````````````` example
Foo  
-----
.

Foo

````````````````````````````````


Nor does a backslash at the end:

```````````````````````````````` example
Foo\
----
.

Foo\

````````````````````````````````


Since indicators of block structure take precedence over
indicators of inline structure, the following are setext headings:

```````````````````````````````` example
`Foo
----
`


.

`Foo


`


<a title="a lot


of dashes"/>

````````````````````````````````


The setext heading underline cannot be a [lazy continuation
line] in a list item or block quote:

```````````````````````````````` example
> Foo
---
.



Foo





````````````````````````````````


```````````````````````````````` example
> foo
bar
===
.



foo
bar
===



````````````````````````````````


```````````````````````````````` example
- Foo
---
.

    

  • Foo
    • 




````````````````````````````````


A blank line is needed between a paragraph and a following
setext heading, since otherwise the paragraph becomes part
of the heading's content:

```````````````````````````````` example
Foo
Bar
---
.

Foo
Bar

````````````````````````````````


But in general a blank line is not required before or after
setext headings:

```````````````````````````````` example
---
Foo
---
Bar
---
Baz
.



Foo


Bar


Baz

````````````````````````````````


Setext headings cannot be empty:

```````````````````````````````` example

====
.

====

````````````````````````````````


Setext heading text lines must not be interpretable as block
constructs other than paragraphs.  So, the line of dashes
in these examples gets interpreted as a thematic break:

```````````````````````````````` example
---
---
.




````````````````````````````````


```````````````````````````````` example
- foo
-----
.

    

  • foo
    • 




````````````````````````````````


```````````````````````````````` example
    foo
---
.

foo




````````````````````````````````


```````````````````````````````` example
> foo
-----
.



foo





````````````````````````````````


If you want a heading with `> foo` as its literal text, you can
use backslash escapes:

```````````````````````````````` example
\> foo
------
.

> foo

````````````````````````````````


**Compatibility note:**  Most existing Markdown implementations
do not allow the text of setext headings to span multiple lines.
But there is no consensus about how to interpret

``` markdown
Foo
bar
---
baz
```

One can find four different interpretations:

1. paragraph "Foo", heading "bar", paragraph "baz"
2. paragraph "Foo bar", thematic break, paragraph "baz"
3. paragraph "Foo bar --- baz"
4. heading "Foo bar", paragraph "baz"

We find interpretation 4 most natural, and interpretation 4
increases the expressive power of CommonMark, by allowing
multiline headings.  Authors who want interpretation 1 can
put a blank line after the first paragraph:

```````````````````````````````` example
Foo

bar
---
baz
.

Foo


bar


baz

````````````````````````````````


Authors who want interpretation 2 can put blank lines around
the thematic break,

```````````````````````````````` example
Foo
bar

---

baz
.

Foo
bar




baz

````````````````````````````````


or use a thematic break that cannot count as a [setext heading
underline], such as

```````````````````````````````` example
Foo
bar
* * *
baz
.

Foo
bar




baz

````````````````````````````````


Authors who want interpretation 3 can use backslash escapes:

```````````````````````````````` example
Foo
bar
\---
baz
.

Foo
bar
---
baz

````````````````````````````````


## Indented code blocks

An [indented code block](@) is composed of one or more
[indented chunks] separated by blank lines.
An [indented chunk](@) is a sequence of non-blank lines,
each preceded by four or more spaces of indentation. The contents of the code
block are the literal contents of the lines, including trailing
[line endings], minus four spaces of indentation.
An indented code block has no [info string].

An indented code block cannot interrupt a paragraph, so there must be
a blank line between a paragraph and a following indented code block.
(A blank line is not needed, however, between a code block and a following
paragraph.)

```````````````````````````````` example
    a simple
      indented code block
.

a simple
  indented code block


````````````````````````````````


If there is any ambiguity between an interpretation of indentation
as a code block and as indicating that material belongs to a [list
item][list items], the list item interpretation takes precedence:

```````````````````````````````` example
  - foo

    bar
.

    

  • 

    foo
    

    bar
    

    • 


````````````````````````````````


```````````````````````````````` example
1.  foo

    - bar
.

    

  1. 

    foo
    

      

    • bar
      • 

    

    2. 


````````````````````````````````



The contents of a code block are literal text, and do not get parsed
as Markdown:

```````````````````````````````` example
    
    *hi*

    - one
.

<a/>
*hi*

- one


````````````````````````````````


Here we have three chunks separated by blank lines:

```````````````````````````````` example
    chunk1

    chunk2
  
 
 
    chunk3
.

chunk1

chunk2



chunk3


````````````````````````````````


Any initial spaces or tabs beyond four spaces of indentation will be included in
the content, even in interior blank lines:

```````````````````````````````` example
    chunk1
      
      chunk2
.

chunk1
  
  chunk2


````````````````````````````````


An indented code block cannot interrupt a paragraph.  (This
allows hanging indents and the like.)

```````````````````````````````` example
Foo
    bar

.

Foo
bar

````````````````````````````````


However, any non-blank line with fewer than four spaces of indentation ends
the code block immediately.  So a paragraph may occur immediately
after indented code:

```````````````````````````````` example
    foo
bar
.

foo



bar

````````````````````````````````


And indented code can occur immediately before and after other kinds of
blocks:

```````````````````````````````` example
# Heading
    foo
Heading
------
    foo
----
.

Heading


foo



Heading


foo




````````````````````````````````


The first line can be preceded by more than four spaces of indentation:

```````````````````````````````` example
        foo
    bar
.

    foo
bar


````````````````````````````````


Blank lines preceding or following an indented code block
are not included in it:

```````````````````````````````` example

    
    foo
    

.

foo


````````````````````````````````


Trailing spaces or tabs are included in the code block's content:

```````````````````````````````` example
    foo  
.

foo  


````````````````````````````````



## Fenced code blocks

A [code fence](@) is a sequence
of at least three consecutive backtick characters (`` ` ``) or
tildes (`~`).  (Tildes and backticks cannot be mixed.)
A [fenced code block](@)
begins with a code fence, preceded by up to three spaces of indentation.

The line with the opening code fence may optionally contain some text
following the code fence; this is trimmed of leading and trailing
spaces or tabs and called the [info string](@). If the [info string] comes
after a backtick fence, it may not contain any backtick
characters.  (The reason for this restriction is that otherwise
some inline code would be incorrectly interpreted as the
beginning of a fenced code block.)

The content of the code block consists of all subsequent lines, until
a closing [code fence] of the same type as the code block
began with (backticks or tildes), and with at least as many backticks
or tildes as the opening code fence.  If the leading code fence is
preceded by N spaces of indentation, then up to N spaces of indentation are
removed from each line of the content (if present).  (If a content line is not
indented, it is preserved unchanged.  If it is indented N spaces or less, all
of the indentation is removed.)

The closing code fence may be preceded by up to three spaces of indentation, and
may be followed only by spaces or tabs, which are ignored.  If the end of the
containing block (or document) is reached and no closing code fence
has been found, the code block contains all of the lines after the
opening code fence until the end of the containing block (or
document).  (An alternative spec would require backtracking in the
event that a closing code fence is not found.  But this makes parsing
much less efficient, and there seems to be no real downside to the
behavior described here.)

A fenced code block may interrupt a paragraph, and does not require
a blank line either before or after.

The content of a code fence is treated as literal text, not parsed
as inlines.  The first word of the [info string] is typically used to
specify the language of the code sample, and rendered in the `class`
attribute of the `code` tag.  However, this spec does not mandate any
particular treatment of the [info string].

Here is a simple example with backticks:

```````````````````````````````` example
```
<
 >
```
.

<
 >


````````````````````````````````


With tildes:

```````````````````````````````` example
~~~
<
 >
~~~
.

<
 >


````````````````````````````````

Fewer than three backticks is not enough:

```````````````````````````````` example
``
foo
``
.

foo

````````````````````````````````

The closing code fence must use the same character as the opening
fence:

```````````````````````````````` example
```
aaa
~~~
```
.

aaa
~~~


````````````````````````````````


```````````````````````````````` example
~~~
aaa
```
~~~
.

aaa
```


````````````````````````````````


The closing code fence must be at least as long as the opening fence:

```````````````````````````````` example
````
aaa
```
``````
.

aaa
```


````````````````````````````````


```````````````````````````````` example
~~~~
aaa
~~~
~~~~
.

aaa
~~~


````````````````````````````````


Unclosed code blocks are closed by the end of the document
(or the enclosing [block quote][block quotes] or [list item][list items]):

```````````````````````````````` example
```
.


````````````````````````````````


```````````````````````````````` example
`````

```
aaa
.


```
aaa


````````````````````````````````


```````````````````````````````` example
> ```
> aaa

bbb
.



aaa





bbb

````````````````````````````````


A code block can have all empty lines as its content:

```````````````````````````````` example
```

  
```
.


  


````````````````````````````````


A code block can be empty:

```````````````````````````````` example
```
```
.


````````````````````````````````


Fences can be indented.  If the opening fence is indented,
content lines will have equivalent opening indentation removed,
if present:

```````````````````````````````` example
 ```
 aaa
aaa
```
.

aaa
aaa


````````````````````````````````


```````````````````````````````` example
  ```
aaa
  aaa
aaa
  ```
.

aaa
aaa
aaa


````````````````````````````````


```````````````````````````````` example
   ```
   aaa
    aaa
  aaa
   ```
.

aaa
 aaa
aaa


````````````````````````````````


Four spaces of indentation is too many:

```````````````````````````````` example
    ```
    aaa
    ```
.

```
aaa
```


````````````````````````````````


Closing fences may be preceded by up to three spaces of indentation, and their
indentation need not match that of the opening fence:

```````````````````````````````` example
```
aaa
  ```
.

aaa


````````````````````````````````


```````````````````````````````` example
   ```
aaa
  ```
.

aaa


````````````````````````````````


This is not a closing fence, because it is indented 4 spaces:

```````````````````````````````` example
```
aaa
    ```
.

aaa
    ```


````````````````````````````````



Code fences (opening and closing) cannot contain internal spaces or tabs:

```````````````````````````````` example
``` ```
aaa
.

 
aaa

````````````````````````````````


```````````````````````````````` example
~~~~~~
aaa
~~~ ~~
.

aaa
~~~ ~~


````````````````````````````````


Fenced code blocks can interrupt paragraphs, and can be followed
directly by paragraphs, without a blank line between:

```````````````````````````````` example
foo
```
bar
```
baz
.

foo


bar



baz

````````````````````````````````


Other blocks can also occur before and after fenced code blocks
without an intervening blank line:

```````````````````````````````` example
foo
---
~~~
bar
~~~
# baz
.

foo


bar



baz

````````````````````````````````


An [info string] can be provided after the opening code fence.
Although this spec doesn't mandate any particular treatment of
the info string, the first word is typically used to specify
the language of the code block. In HTML output, the language is
normally indicated by adding a class to the `code` element consisting
of `language-` followed by the language name.

```````````````````````````````` example
```ruby
def foo(x)
  return 3
end
```
.

def foo(x)
  return 3
end


````````````````````````````````


```````````````````````````````` example
~~~~    ruby startline=3 $%@#$
def foo(x)
  return 3
end
~~~~~~~
.

def foo(x)
  return 3
end


````````````````````````````````


```````````````````````````````` example
````;
````
.


````````````````````````````````


[Info strings] for backtick code blocks cannot contain backticks:

```````````````````````````````` example
``` aa ```
foo
.

aa
foo

````````````````````````````````


[Info strings] for tilde code blocks can contain backticks and tildes:

```````````````````````````````` example
~~~ aa ``` ~~~
foo
~~~
.

foo


````````````````````````````````


Closing code fences cannot have [info strings]:

```````````````````````````````` example
```
``` aaa
```
.

``` aaa


````````````````````````````````



## HTML blocks

An [HTML block](@) is a group of lines that is treated
as raw HTML (and will not be escaped in HTML output).

There are seven kinds of [HTML block], which can be defined by their
start and end conditions.  The block begins with a line that meets a
[start condition](@) (after up to three optional spaces of indentation).
It ends with the first subsequent line that meets a matching
[end condition](@), or the last line of the document, or the last line of
the [container block](#container-blocks) containing the current HTML
block, if no line is encountered that meets the [end condition].  If
the first line meets both the [start condition] and the [end
condition], the block will contain just that line.

1.  **Start condition:**  line begins with the string ``, or the end of the line.\
**End condition:**  line contains an end tag
`
`, ``, ``, or `` (case-insensitive; it need not match the start tag). 2. **Start condition:** line begins with the string ``. 3. **Start condition:** line begins with the string ``. 4. **Start condition:** line begins with the string ``. 5. **Start condition:** line begins with the string ``. 6. **Start condition:** line begins with the string `<` or ``, or the string `/>`.\ **End condition:** line is followed by a [blank line]. 7. **Start condition:** line begins with a complete [open tag] (with any [tag name] other than `pre`, `script`, `style`, or `textarea`) or a complete [closing tag], followed by zero or more spaces and tabs, followed by the end of the line.\ **End condition:** line is followed by a [blank line]. HTML blocks continue until they are closed by their appropriate [end condition], or the last line of the document or other [container block](#container-blocks). This means any HTML **within an HTML block** that might otherwise be recognised as a start condition will be ignored by the parser and passed through as-is, without changing the parser's state. For instance, `
` within an HTML block started by `` will not affect
the parser state; as the HTML block was started in by start condition 6, it
will end at any blank line. This can be surprising:

```````````````````````````````` example



**Hello**,

_world_.




.



**Hello**,

world.




````````````````````````````````

In this case, the HTML block is terminated by the blank line — the `**Hello**`
text remains verbatim — and regular parsing resumes, with a paragraph,
emphasised `world` and inline and block HTML following.

All types of [HTML blocks] except type 7 may interrupt
a paragraph.  Blocks of type 7 may not interrupt a paragraph.
(This restriction is intended to prevent unwanted interpretation
of long tags inside a wrapped paragraph as starting HTML blocks.)

Some simple examples follow.  Here are some basic HTML blocks
of type 6:

```````````````````````````````` example


  

    
           hi
    
  




okay.
.


  

    
           hi
    
  




okay.

````````````````````````````````


```````````````````````````````` example
 
*foo*
````````````````````````````````


Here we have two HTML blocks with a Markdown paragraph between them:

```````````````````````````````` example



*Markdown*



.



Markdown



````````````````````````````````


The tag on the first line can be partial, as long
as it is split where there would be whitespace:

```````````````````````````````` example




.




````````````````````````````````


```````````````````````````````` example




.




````````````````````````````````


An open tag need not be closed:
```````````````````````````````` example


*foo*

*bar*
.


*foo*

bar

````````````````````````````````



A partial tag need not even be completed (garbage
in, garbage out):

```````````````````````````````` example

.

````````````````````````````````


```````````````````````````````` example


foo


.


foo


````````````````````````````````


Everything until the next blank line or end of document
gets included in the HTML block.  So, in the following
example, what looks like a Markdown code block
is actually part of the HTML block, which continues until a blank
line or the end of the document is reached:

```````````````````````````````` example


``` c
int x = 33;
```
.


``` c
int x = 33;
```
````````````````````````````````


To start an [HTML block] with a tag that is *not* in the
list of block-level tags in (6), you must put the tag by
itself on the first line (and it must be complete):

```````````````````````````````` example

*bar*

.

*bar*

````````````````````````````````


In type 7 blocks, the [tag name] can be anything:

```````````````````````````````` example

*bar*

.

*bar*

````````````````````````````````


```````````````````````````````` example

*bar*

.

*bar*

````````````````````````````````


```````````````````````````````` example

*bar*
.

*bar*
````````````````````````````````


These rules are designed to allow us to work with tags that
can function as either block-level or inline-level tags.
The `` tag is a nice example.  We can surround content with
`` tags in three different ways.  In this case, we get a raw
HTML block, because the `` tag is on a line by itself:

```````````````````````````````` example

*foo*

.

*foo*

````````````````````````````````


In this case, we get a raw HTML block that just includes
the `` tag (because it ends with the following blank
line).  So the contents get interpreted as CommonMark:

```````````````````````````````` example


*foo*


.


foo


````````````````````````````````


Finally, in this case, the `` tags are interpreted
as [raw HTML] *inside* the CommonMark paragraph.  (Because
the tag is not on a line by itself, we get inline HTML
rather than an [HTML block].)

```````````````````````````````` example
*foo*
.

foo

````````````````````````````````


HTML tags designed to contain literal content
(`pre`, `script`, `style`, `textarea`), comments, processing instructions,
and declarations are treated somewhat differently.
Instead of ending at the first blank line, these blocks
end at the first line containing a corresponding end tag.
As a result, these blocks can contain blank lines:

A pre tag (type 1):

```````````````````````````````` example


import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags


okay
.


import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags



okay

````````````````````````````````


A script tag (type 1):

```````````````````````````````` example

okay
.


okay

````````````````````````````````


A textarea tag (type 1):

```````````````````````````````` example

.

````````````````````````````````

A style tag (type 1):

```````````````````````````````` example

okay
.


okay

````````````````````````````````


If there is no matching end tag, the block will end at the
end of the document (or the enclosing [block quote][block quotes]
or [list item][list items]):

```````````````````````````````` example

*foo*
.


foo

````````````````````````````````


```````````````````````````````` example
*bar*
*baz*
.
*bar*

baz

````````````````````````````````


Note that anything on the last line after the
end tag will be included in the [HTML block]:

```````````````````````````````` example
1. *bar*
.
1. *bar*
````````````````````````````````


A comment (type 2):

```````````````````````````````` example

okay
.


okay

````````````````````````````````



A processing instruction (type 3):

```````````````````````````````` example
';

?>
okay
.
';

?>

okay

````````````````````````````````


A declaration (type 4):

```````````````````````````````` example

.

````````````````````````````````


CDATA (type 5):

```````````````````````````````` example

okay
.


okay

````````````````````````````````


The opening tag can be preceded by up to three spaces of indentation, but not
four:

```````````````````````````````` example
  

    
.
  

<!-- foo -->


````````````````````````````````


```````````````````````````````` example
  


    

.
  


<div>


````````````````````````````````


An HTML block of types 1--6 can interrupt a paragraph, and need not be
preceded by a blank line.

```````````````````````````````` example
Foo


bar


.

Foo



bar


````````````````````````````````


However, a following blank line is needed, except at the end of
a document, and except for blocks of types 1--5, [above][HTML
block]:

```````````````````````````````` example


bar


*foo*
.


bar


*foo*
````````````````````````````````


HTML blocks of type 7 cannot interrupt a paragraph:

```````````````````````````````` example
Foo

baz
.

Foo

baz

````````````````````````````````


This rule differs from John Gruber's original Markdown syntax
specification, which says:

> The only restrictions are that block-level HTML elements —
> e.g. `
`, ``, `
`, `
`, etc. — must be separated from
> surrounding content by blank lines, and the start and end tags of the
> block should not be indented with spaces or tabs.

In some ways Gruber's rule is more restrictive than the one given
here:

- It requires that an HTML block be preceded by a blank line.
- It does not allow the start tag to be indented.
- It requires a matching end tag, which it also does not allow to
  be indented.

Most Markdown implementations (including some of Gruber's own) do not
respect all of these restrictions.

There is one respect, however, in which Gruber's rule is more liberal
than the one given here, since it allows blank lines to occur inside
an HTML block.  There are two reasons for disallowing them here.
First, it removes the need to parse balanced tags, which is
expensive and can require backtracking from the end of the document
if no matching end tag is found. Second, it provides a very simple
and flexible way of including Markdown content inside HTML tags:
simply separate the Markdown from the HTML using blank lines:

Compare:

```````````````````````````````` example



*Emphasized* text.



.



Emphasized text.



````````````````````````````````


```````````````````````````````` example


*Emphasized* text.


.


*Emphasized* text.


````````````````````````````````


Some Markdown implementations have adopted a convention of
interpreting content inside tags as text if the open tag has
the attribute `markdown=1`.  The rule given above seems a simpler and
more elegant way of achieving the same expressive power, which is also
much simpler to parse.

The main potential drawback is that one can no longer paste HTML
blocks into Markdown documents with 100% reliability.  However,
*in most cases* this will work fine, because the blank lines in
HTML are usually followed by HTML block tags.  For example:

```````````````````````````````` example







Hi







.





Hi





````````````````````````````````


There are problems, however, if the inner tags are indented
*and* separated by spaces, as then they will be interpreted as
an indented code block:

```````````````````````````````` example



  


    
      Hi
    

  




.

<td>
  Hi
</td>


  


  



````````````````````````````````


Fortunately, blank lines are usually not necessary and can be
deleted.  The exception is inside `
` tags, but as described
[above][HTML blocks], raw HTML blocks starting with `
`
*can* contain blank lines.

## Link reference definitions

A [link reference definition](@)
consists of a [link label], optionally preceded by up to three spaces of
indentation, followed
by a colon (`:`), optional spaces or tabs (including up to one
[line ending]), a [link destination],
optional spaces or tabs (including up to one
[line ending]), and an optional [link
title], which if it is present must be separated
from the [link destination] by spaces or tabs.
No further character may occur.

A [link reference definition]
does not correspond to a structural element of a document.  Instead, it
defines a label which can be used in [reference links]
and reference-style [images] elsewhere in the document.  [Link
reference definitions] can come either before or after the links that use
them.

```````````````````````````````` example
[foo]: /url "title"

[foo]
.

foo

````````````````````````````````


```````````````````````````````` example
   [foo]: 
      /url  
           'the title'  

[foo]
.

foo

````````````````````````````````


```````````````````````````````` example
[Foo*bar\]]:my_(url) 'title (with parens)'

[Foo*bar\]]
.

Foo*bar]

````````````````````````````````


```````````````````````````````` example
[Foo bar]:

'title'

[Foo bar]
.

Foo bar

````````````````````````````````


The title may extend over multiple lines:

```````````````````````````````` example
[foo]: /url '
title
line1
line2
'

[foo]
.

foo

````````````````````````````````


However, it may not contain a [blank line]:

```````````````````````````````` example
[foo]: /url 'title

with blank line'

[foo]
.

[foo]: /url 'title


with blank line'


[foo]

````````````````````````````````


The title may be omitted:

```````````````````````````````` example
[foo]:
/url

[foo]
.

foo

````````````````````````````````


The link destination may not be omitted:

```````````````````````````````` example
[foo]:

[foo]
.

[foo]:


[foo]

````````````````````````````````

 However, an empty link destination may be specified using
 angle brackets:

```````````````````````````````` example
[foo]: <>

[foo]
.

foo

````````````````````````````````

The title must be separated from the link destination by
spaces or tabs:

```````````````````````````````` example
[foo]: (baz)

[foo]
.

[foo]: (baz)


[foo]

````````````````````````````````


Both title and destination can contain backslash escapes
and literal backslashes:

```````````````````````````````` example
[foo]: /url\bar\*baz "foo\"bar\baz"

[foo]
.

foo

````````````````````````````````


A link can come before its corresponding definition:

```````````````````````````````` example
[foo]

[foo]: url
.

foo

````````````````````````````````


If there are several matching definitions, the first one takes
precedence:

```````````````````````````````` example
[foo]

[foo]: first
[foo]: second
.

foo

````````````````````````````````


As noted in the section on [Links], matching of labels is
case-insensitive (see [matches]).

```````````````````````````````` example
[FOO]: /url

[Foo]
.

Foo

````````````````````````````````


```````````````````````````````` example
[ΑΓΩ]: /φου

[αγω]
.

αγω

````````````````````````````````


Whether something is a [link reference definition] is
independent of whether the link reference it defines is
used in the document.  Thus, for example, the following
document contains just a link reference definition, and
no visible content:

```````````````````````````````` example
[foo]: /url
.
````````````````````````````````


Here is another one:

```````````````````````````````` example
[
foo
]: /url
bar
.

bar

````````````````````````````````


This is not a link reference definition, because there are
characters other than spaces or tabs after the title:

```````````````````````````````` example
[foo]: /url "title" ok
.

[foo]: /url "title" ok

````````````````````````````````


This is a link reference definition, but it has no title:

```````````````````````````````` example
[foo]: /url
"title" ok
.

"title" ok

````````````````````````````````


This is not a link reference definition, because it is indented
four spaces:

```````````````````````````````` example
    [foo]: /url "title"

[foo]
.

[foo]: /url "title"



[foo]

````````````````````````````````


This is not a link reference definition, because it occurs inside
a code block:

```````````````````````````````` example
```
[foo]: /url
```

[foo]
.

[foo]: /url



[foo]

````````````````````````````````


A [link reference definition] cannot interrupt a paragraph.

```````````````````````````````` example
Foo
[bar]: /baz

[bar]
.

Foo
[bar]: /baz


[bar]

````````````````````````````````


However, it can directly follow other block elements, such as headings
and thematic breaks, and it need not be followed by a blank line.

```````````````````````````````` example
# [Foo]
[foo]: /url
> bar
.

Foo




bar



````````````````````````````````

```````````````````````````````` example
[foo]: /url
bar
===
[foo]
.

bar


foo

````````````````````````````````

```````````````````````````````` example
[foo]: /url
===
[foo]
.

===
foo

````````````````````````````````


Several [link reference definitions]
can occur one after another, without intervening blank lines.

```````````````````````````````` example
[foo]: /foo-url "foo"
[bar]: /bar-url
  "bar"
[baz]: /baz-url

[foo],
[bar],
[baz]
.

foo,
bar,
baz

````````````````````````````````


[Link reference definitions] can occur
inside block containers, like lists and block quotations.  They
affect the entire document, not just the container in which they
are defined:

```````````````````````````````` example
[foo]

> [foo]: /url
.

foo





````````````````````````````````


## Paragraphs

A sequence of non-blank lines that cannot be interpreted as other
kinds of blocks forms a [paragraph](@).
The contents of the paragraph are the result of parsing the
paragraph's raw content as inlines.  The paragraph's raw content
is formed by concatenating the lines and removing initial and final
spaces or tabs.

A simple example with two paragraphs:

```````````````````````````````` example
aaa

bbb
.

aaa


bbb

````````````````````````````````


Paragraphs can contain multiple lines, but no blank lines:

```````````````````````````````` example
aaa
bbb

ccc
ddd
.

aaa
bbb


ccc
ddd

````````````````````````````````


Multiple blank lines between paragraphs have no effect:

```````````````````````````````` example
aaa


bbb
.

aaa


bbb

````````````````````````````````


Leading spaces or tabs are skipped:

```````````````````````````````` example
  aaa
 bbb
.

aaa
bbb

````````````````````````````````


Lines after the first may be indented any amount, since indented
code blocks cannot interrupt paragraphs.

```````````````````````````````` example
aaa
             bbb
                                       ccc
.

aaa
bbb
ccc

````````````````````````````````


However, the first line may be preceded by up to three spaces of indentation.
Four spaces of indentation is too many:

```````````````````````````````` example
   aaa
bbb
.

aaa
bbb

````````````````````````````````


```````````````````````````````` example
    aaa
bbb
.

aaa



bbb

````````````````````````````````


Final spaces or tabs are stripped before inline parsing, so a paragraph
that ends with two or more spaces will not end with a [hard line
break]:

```````````````````````````````` example
aaa     
bbb     
.

aaa

bbb

````````````````````````````````


## Blank lines

[Blank lines] between block-level elements are ignored,
except for the role they play in determining whether a [list]
is [tight] or [loose].

Blank lines at the beginning and end of the document are also ignored.

```````````````````````````````` example
  

aaa
  

# aaa

  
.

aaa


aaa

````````````````````````````````



# Container blocks

A [container block](#container-blocks) is a block that has other
blocks as its contents.  There are two basic kinds of container blocks:
[block quotes] and [list items].
[Lists] are meta-containers for [list items].

We define the syntax for container blocks recursively.  The general
form of the definition is:

> If X is a sequence of blocks, then the result of
> transforming X in such-and-such a way is a container of type Y
> with these blocks as its content.

So, we explain what counts as a block quote or list item by explaining
how these can be *generated* from their contents. This should suffice
to define the syntax, although it does not give a recipe for *parsing*
these constructions.  (A recipe is provided below in the section entitled
[A parsing strategy](#appendix-a-parsing-strategy).)

## Block quotes

A [block quote marker](@),
optionally preceded by up to three spaces of indentation,
consists of (a) the character `>` together with a following space of
indentation, or (b) a single character `>` not followed by a space of
indentation.

The following rules define [block quotes]:

1.  **Basic case.**  If a string of lines *Ls* constitute a sequence
    of blocks *Bs*, then the result of prepending a [block quote
    marker] to the beginning of each line in *Ls*
    is a [block quote](#block-quotes) containing *Bs*.

2.  **Laziness.**  If a string of lines *Ls* constitute a [block
    quote](#block-quotes) with contents *Bs*, then the result of deleting
    the initial [block quote marker] from one or
    more lines in which the next character other than a space or tab after the
    [block quote marker] is [paragraph continuation
    text] is a block quote with *Bs* as its content.
    [Paragraph continuation text](@) is text
    that will be parsed as part of the content of a paragraph, but does
    not occur at the beginning of the paragraph.

3.  **Consecutiveness.**  A document cannot contain two [block
    quotes] in a row unless there is a [blank line] between them.

Nothing else counts as a [block quote](#block-quotes).

Here is a simple example:

```````````````````````````````` example
> # Foo
> bar
> baz
.



Foo


bar
baz



````````````````````````````````


The space or tab after the `>` characters can be omitted:

```````````````````````````````` example
># Foo
>bar
> baz
.



Foo


bar
baz



````````````````````````````````


The `>` characters can be preceded by up to three spaces of indentation:

```````````````````````````````` example
   > # Foo
   > bar
 > baz
.



Foo


bar
baz



````````````````````````````````


Four spaces of indentation is too many:

```````````````````````````````` example
    > # Foo
    > bar
    > baz
.

> # Foo
> bar
> baz


````````````````````````````````


The Laziness clause allows us to omit the `>` before
[paragraph continuation text]:

```````````````````````````````` example
> # Foo
> bar
baz
.



Foo


bar
baz



````````````````````````````````


A block quote can contain some lazy and some non-lazy
continuation lines:

```````````````````````````````` example
> bar
baz
> foo
.



bar
baz
foo



````````````````````````````````


Laziness only applies to lines that would have been continuations of
paragraphs had they been prepended with [block quote markers].
For example, the `> ` cannot be omitted in the second line of

``` markdown
> foo
> ---
```

without changing the meaning:

```````````````````````````````` example
> foo
---
.



foo





````````````````````````````````


Similarly, if we omit the `> ` in the second line of

``` markdown
> - foo
> - bar
```

then the block quote ends after the first line:

```````````````````````````````` example
> - foo
- bar
.



    

  • foo
    • 





    

  • bar
    • 


````````````````````````````````


For the same reason, we can't omit the `> ` in front of
subsequent lines of an indented or fenced code block:

```````````````````````````````` example
>     foo
    bar
.



foo





bar


````````````````````````````````


```````````````````````````````` example
> ```
foo
```
.







foo



````````````````````````````````


Note that in the following case, we have a [lazy
continuation line]:

```````````````````````````````` example
> foo
    - bar
.



foo
- bar



````````````````````````````````


To see why, note that in

```markdown
> foo
>     - bar
```

the `- bar` is indented too far to start a list, and can't
be an indented code block because indented code blocks cannot
interrupt paragraphs, so it is [paragraph continuation text].

A block quote can be empty:

```````````````````````````````` example
>
.




````````````````````````````````


```````````````````````````````` example
>
>  
> 
.




````````````````````````````````


A block quote can have initial or final blank lines:

```````````````````````````````` example
>
> foo
>  
.



foo



````````````````````````````````


A blank line always separates block quotes:

```````````````````````````````` example
> foo

> bar
.



foo






bar



````````````````````````````````


(Most current Markdown implementations, including John Gruber's
original `Markdown.pl`, will parse this example as a single block quote
with two paragraphs.  But it seems better to allow the author to decide
whether two block quotes or one are wanted.)

Consecutiveness means that if we put these block quotes together,
we get a single block quote:

```````````````````````````````` example
> foo
> bar
.



foo
bar



````````````````````````````````


To get a block quote with two paragraphs, use:

```````````````````````````````` example
> foo
>
> bar
.



foo


bar



````````````````````````````````


Block quotes can interrupt paragraphs:

```````````````````````````````` example
foo
> bar
.

foo




bar



````````````````````````````````


In general, blank lines are not needed before or after block
quotes:

```````````````````````````````` example
> aaa
***
> bbb
.



aaa








bbb



````````````````````````````````


However, because of laziness, a blank line is needed between
a block quote and a following paragraph:

```````````````````````````````` example
> bar
baz
.



bar
baz



````````````````````````````````


```````````````````````````````` example
> bar

baz
.



bar




baz

````````````````````````````````


```````````````````````````````` example
> bar
>
baz
.



bar




baz

````````````````````````````````


It is a consequence of the Laziness rule that any number
of initial `>`s may be omitted on a continuation line of a
nested block quote:

```````````````````````````````` example
> > > foo
bar
.







foo
bar







````````````````````````````````


```````````````````````````````` example
>>> foo
> bar
>>baz
.







foo
bar
baz







````````````````````````````````


When including an indented code block in a block quote,
remember that the [block quote marker] includes
both the `>` and a following space of indentation.  So *five spaces* are needed
after the `>`:

```````````````````````````````` example
>     code

>    not code
.



code







not code



````````````````````````````````



## List items

A [list marker](@) is a
[bullet list marker] or an [ordered list marker].

A [bullet list marker](@)
is a `-`, `+`, or `*` character.

An [ordered list marker](@)
is a sequence of 1--9 arabic digits (`0-9`), followed by either a
`.` character or a `)` character.  (The reason for the length
limit is that with 10 digits we start seeing integer overflows
in some browsers.)

The following rules define [list items]:

1.  **Basic case.**  If a sequence of lines *Ls* constitute a sequence of
    blocks *Bs* starting with a character other than a space or tab, and *M* is
    a list marker of width *W* followed by 1 ≤ *N* ≤ 4 spaces of indentation,
    then the result of prepending *M* and the following spaces to the first line
    of *Ls*, and indenting subsequent lines of *Ls* by *W + N* spaces, is a
    list item with *Bs* as its contents.  The type of the list item
    (bullet or ordered) is determined by the type of its list marker.
    If the list item is ordered, then it is also assigned a start
    number, based on the ordered list marker.

    Exceptions:

    1. When the first list item in a [list] interrupts
       a paragraph---that is, when it starts on a line that would
       otherwise count as [paragraph continuation text]---then (a)
       the lines *Ls* must not begin with a blank line, and (b) if
       the list item is ordered, the start number must be 1.
    2. If any line is a [thematic break][thematic breaks] then
       that line is not a list item.

For example, let *Ls* be the lines

```````````````````````````````` example
A paragraph
with two lines.

    indented code

> A block quote.
.

A paragraph
with two lines.


indented code





A block quote.



````````````````````````````````


And let *M* be the marker `1.`, and *N* = 2.  Then rule #1 says
that the following is an ordered list item with start number 1,
and the same contents as *Ls*:

```````````````````````````````` example
1.  A paragraph
    with two lines.

        indented code

    > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


The most important thing to notice is that the position of
the text after the list marker determines how much indentation
is needed in subsequent blocks in the list item.  If the list
marker takes up two spaces of indentation, and there are three spaces between
the list marker and the next character other than a space or tab, then blocks
must be indented five spaces in order to fall under the list
item.

Here are some examples showing how far content must be indented to be
put under the list item:

```````````````````````````````` example
- one

 two
.

    

  • one
    • 



two

````````````````````````````````


```````````````````````````````` example
- one

  two
.

    

  • 

    one
    

    two
    

    • 


````````````````````````````````


```````````````````````````````` example
 -    one

     two
.

    

  • one
    • 



 two


````````````````````````````````


```````````````````````````````` example
 -    one

      two
.

    

  • 

    one
    

    two
    

    • 


````````````````````````````````


It is tempting to think of this in terms of columns:  the continuation
blocks must be indented at least to the column of the first character other than
a space or tab after the list marker.  However, that is not quite right.
The spaces of indentation after the list marker determine how much relative
indentation is needed.  Which column this indentation reaches will depend on
how the list item is embedded in other constructions, as shown by
this example:

```````````````````````````````` example
   > > 1.  one
>>
>>     two
.





    

  1. 

    one
    

    two
    

    2. 






````````````````````````````````


Here `two` occurs in the same column as the list marker `1.`,
but is actually contained in the list item, because there is
sufficient indentation after the last containing blockquote marker.

The converse is also possible.  In the following example, the word `two`
occurs far to the right of the initial text of the list item, `one`, but
it is not considered part of the list item, because it is not indented
far enough past the blockquote marker:

```````````````````````````````` example
>>- one
>>
  >  > two
.





    

  • one
    • 



two





````````````````````````````````


Note that at least one space or tab is needed between the list marker and
any following content, so these are not list items:

```````````````````````````````` example
-one

2.two
.

-one


2.two

````````````````````````````````


A list item may contain blocks that are separated by more than
one blank line.

```````````````````````````````` example
- foo


  bar
.

    

  • 

    foo
    

    bar
    

    • 


````````````````````````````````


A list item may contain any kind of block:

```````````````````````````````` example
1.  foo

    ```
    bar
    ```

    baz

    > bam
.

    

  1. 

    foo
    

    bar

    

    baz
    

    

    bam
    

    

    2. 


````````````````````````````````


A list item that contains an indented code block will preserve
empty lines within the code block verbatim.

```````````````````````````````` example
- Foo

      bar


      baz
.

    

  • 

    Foo
    

    bar


baz

    

    • 


````````````````````````````````

Note that ordered list start numbers must be nine digits or less:

```````````````````````````````` example
123456789. ok
.

    

  1. ok
    2. 


````````````````````````````````


```````````````````````````````` example
1234567890. not ok
.

1234567890. not ok

````````````````````````````````


A start number may begin with 0s:

```````````````````````````````` example
0. ok
.

    

  1. ok
    2. 


````````````````````````````````


```````````````````````````````` example
003. ok
.

    

  1. ok
    2. 


````````````````````````````````


A start number may not be negative:

```````````````````````````````` example
-1. not ok
.

-1. not ok

````````````````````````````````



2.  **Item starting with indented code.**  If a sequence of lines *Ls*
    constitute a sequence of blocks *Bs* starting with an indented code
    block, and *M* is a list marker of width *W* followed by
    one space of indentation, then the result of prepending *M* and the
    following space to the first line of *Ls*, and indenting subsequent lines
    of *Ls* by *W + 1* spaces, is a list item with *Bs* as its contents.
    If a line is empty, then it need not be indented.  The type of the
    list item (bullet or ordered) is determined by the type of its list
    marker.  If the list item is ordered, then it is also assigned a
    start number, based on the ordered list marker.

An indented code block will have to be preceded by four spaces of indentation
beyond the edge of the region where text will be included in the list item.
In the following case that is 6 spaces:

```````````````````````````````` example
- foo

      bar
.

    

  • 

    foo
    

    bar

    

    • 


````````````````````````````````


And in this case it is 11 spaces:

```````````````````````````````` example
  10.  foo

           bar
.

    

  1. 

    foo
    

    bar

    

    2. 


````````````````````````````````


If the *first* block in the list item is an indented code block,
then by rule #2, the contents must be preceded by *one* space of indentation
after the list marker:

```````````````````````````````` example
    indented code

paragraph

    more code
.

indented code



paragraph


more code


````````````````````````````````


```````````````````````````````` example
1.     indented code

   paragraph

       more code
.

    

  1. 

    indented code

    

    paragraph
    

    more code

    

    2. 


````````````````````````````````


Note that an additional space of indentation is interpreted as space
inside the code block:

```````````````````````````````` example
1.      indented code

   paragraph

       more code
.

    

  1. 

     indented code

    

    paragraph
    

    more code

    

    2. 


````````````````````````````````


Note that rules #1 and #2 only apply to two cases:  (a) cases
in which the lines to be included in a list item begin with a
character other than a space or tab, and (b) cases in which
they begin with an indented code
block.  In a case like the following, where the first block begins with
three spaces of indentation, the rules do not allow us to form a list item by
indenting the whole thing and prepending a list marker:

```````````````````````````````` example
   foo

bar
.

foo


bar

````````````````````````````````


```````````````````````````````` example
-    foo

  bar
.

    

  • foo
    • 



bar

````````````````````````````````


This is not a significant restriction, because when a block is preceded by up to
three spaces of indentation, the indentation can always be removed without
a change in interpretation, allowing rule #1 to be applied.  So, in
the above case:

```````````````````````````````` example
-  foo

   bar
.

    

  • 

    foo
    

    bar
    

    • 


````````````````````````````````


3.  **Item starting with a blank line.**  If a sequence of lines *Ls*
    starting with a single [blank line] constitute a (possibly empty)
    sequence of blocks *Bs*, and *M* is a list marker of width *W*,
    then the result of prepending *M* to the first line of *Ls*, and
    preceding subsequent lines of *Ls* by *W + 1* spaces of indentation, is a
    list item with *Bs* as its contents.
    If a line is empty, then it need not be indented.  The type of the
    list item (bullet or ordered) is determined by the type of its list
    marker.  If the list item is ordered, then it is also assigned a
    start number, based on the ordered list marker.

Here are some list items that start with a blank line but are not empty:

```````````````````````````````` example
-
  foo
-
  ```
  bar
  ```
-
      baz
.

    

  • foo
    • 

  • 

    bar

    

    • 

  • 

    baz

    

    • 


````````````````````````````````

When the list item starts with a blank line, the number of spaces
following the list marker doesn't change the required indentation:

```````````````````````````````` example
-   
  foo
.

    

  • foo
    • 


````````````````````````````````


A list item can begin with at most one blank line.
In the following example, `foo` is not part of the list
item:

```````````````````````````````` example
-

  foo
.

    

  • 



foo

````````````````````````````````


Here is an empty bullet list item:

```````````````````````````````` example
- foo
-
- bar
.

    

  • foo
    • 

  • 

  • bar
    • 


````````````````````````````````


It does not matter whether there are spaces or tabs following the [list marker]:

```````````````````````````````` example
- foo
-   
- bar
.

    

  • foo
    • 

  • 

  • bar
    • 


````````````````````````````````


Here is an empty ordered list item:

```````````````````````````````` example
1. foo
2.
3. bar
.

    

  1. foo
    2. 

  2. 

  3. bar
    4. 


````````````````````````````````


A list may start or end with an empty list item:

```````````````````````````````` example
*
.

    

  • 


````````````````````````````````

However, an empty list item cannot interrupt a paragraph:

```````````````````````````````` example
foo
*

foo
1.
.

foo
*


foo
1.

````````````````````````````````


4.  **Indentation.**  If a sequence of lines *Ls* constitutes a list item
    according to rule #1, #2, or #3, then the result of preceding each line
    of *Ls* by up to three spaces of indentation (the same for each line) also
    constitutes a list item with the same contents and attributes.  If a line is
    empty, then it need not be indented.

Indented one space:

```````````````````````````````` example
 1.  A paragraph
     with two lines.

         indented code

     > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Indented two spaces:

```````````````````````````````` example
  1.  A paragraph
      with two lines.

          indented code

      > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Indented three spaces:

```````````````````````````````` example
   1.  A paragraph
       with two lines.

           indented code

       > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Four spaces indent gives a code block:

```````````````````````````````` example
    1.  A paragraph
        with two lines.

            indented code

        > A block quote.
.

1.  A paragraph
    with two lines.

        indented code

    > A block quote.


````````````````````````````````



5.  **Laziness.**  If a string of lines *Ls* constitute a [list
    item](#list-items) with contents *Bs*, then the result of deleting
    some or all of the indentation from one or more lines in which the
    next character other than a space or tab after the indentation is
    [paragraph continuation text] is a
    list item with the same contents and attributes.  The unindented
    lines are called
    [lazy continuation line](@)s.

Here is an example with [lazy continuation lines]:

```````````````````````````````` example
  1.  A paragraph
with two lines.

          indented code

      > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


````````````````````````````````


Indentation can be partially deleted:

```````````````````````````````` example
  1.  A paragraph
    with two lines.
.

    

  1. A paragraph
with two lines.
    2. 


````````````````````````````````


These examples show how laziness can work in nested structures:

```````````````````````````````` example
> 1. > Blockquote
continued here.
.



    

  1. 

    

    Blockquote
continued here.
    

    

    2. 




````````````````````````````````


```````````````````````````````` example
> 1. > Blockquote
> continued here.
.



    

  1. 

    

    Blockquote
continued here.
    

    

    2. 




````````````````````````````````



6.  **That's all.** Nothing that is not counted as a list item by rules
    #1--5 counts as a [list item](#list-items).

The rules for sublists follow from the general rules
[above][List items].  A sublist must be indented the same number
of spaces of indentation a paragraph would need to be in order to be included
in the list item.

So, in this case we need two spaces indent:

```````````````````````````````` example
- foo
  - bar
    - baz
      - boo
.

    

  • foo

      

    • bar

        

      • baz

          

        • boo
          • 

        

        • 

      

      • 

    

    • 


````````````````````````````````


One is not enough:

```````````````````````````````` example
- foo
 - bar
  - baz
   - boo
.

    

  • foo
    • 

  • bar
    • 

  • baz
    • 

  • boo
    • 


````````````````````````````````


Here we need four, because the list marker is wider:

```````````````````````````````` example
10) foo
    - bar
.

    

  1. foo

      

    • bar
      • 

    

    2. 


````````````````````````````````


Three is not enough:

```````````````````````````````` example
10) foo
   - bar
.

    

  1. foo
    2. 



    

  • bar
    • 


````````````````````````````````


A list may be the first block in a list item:

```````````````````````````````` example
- - foo
.

    

  • 

      

    • foo
      • 

    

    • 


````````````````````````````````


```````````````````````````````` example
1. - 2. foo
.

    

  1. 

      

    • 

        

      1. foo
        2. 

      

      • 

    

    2. 


````````````````````````````````


A list item can contain a heading:

```````````````````````````````` example
- # Foo
- Bar
  ---
  baz
.

    

  • 

    Foo
    

    • 

  • 

    Bar
    
baz
    • 


````````````````````````````````


### Motivation

John Gruber's Markdown spec says the following about list items:

1. "List markers typically start at the left margin, but may be indented
   by up to three spaces. List markers must be followed by one or more
   spaces or a tab."

2. "To make lists look nice, you can wrap items with hanging indents....
   But if you don't want to, you don't have to."

3. "List items may consist of multiple paragraphs. Each subsequent
   paragraph in a list item must be indented by either 4 spaces or one
   tab."

4. "It looks nice if you indent every line of the subsequent paragraphs,
   but here again, Markdown will allow you to be lazy."

5. "To put a blockquote within a list item, the blockquote's `>`
   delimiters need to be indented."

6. "To put a code block within a list item, the code block needs to be
   indented twice — 8 spaces or two tabs."

These rules specify that a paragraph under a list item must be indented
four spaces (presumably, from the left margin, rather than the start of
the list marker, but this is not said), and that code under a list item
must be indented eight spaces instead of the usual four.  They also say
that a block quote must be indented, but not by how much; however, the
example given has four spaces indentation.  Although nothing is said
about other kinds of block-level content, it is certainly reasonable to
infer that *all* block elements under a list item, including other
lists, must be indented four spaces.  This principle has been called the
*four-space rule*.

The four-space rule is clear and principled, and if the reference
implementation `Markdown.pl` had followed it, it probably would have
become the standard.  However, `Markdown.pl` allowed paragraphs and
sublists to start with only two spaces indentation, at least on the
outer level.  Worse, its behavior was inconsistent: a sublist of an
outer-level list needed two spaces indentation, but a sublist of this
sublist needed three spaces.  It is not surprising, then, that different
implementations of Markdown have developed very different rules for
determining what comes under a list item.  (Pandoc and python-Markdown,
for example, stuck with Gruber's syntax description and the four-space
rule, while discount, redcarpet, marked, PHP Markdown, and others
followed `Markdown.pl`'s behavior more closely.)

Unfortunately, given the divergences between implementations, there
is no way to give a spec for list items that will be guaranteed not
to break any existing documents.  However, the spec given here should
correctly handle lists formatted with either the four-space rule or
the more forgiving `Markdown.pl` behavior, provided they are laid out
in a way that is natural for a human to read.

The strategy here is to let the width and indentation of the list marker
determine the indentation necessary for blocks to fall under the list
item, rather than having a fixed and arbitrary number.  The writer can
think of the body of the list item as a unit which gets indented to the
right enough to fit the list marker (and any indentation on the list
marker).  (The laziness rule, #5, then allows continuation lines to be
unindented if needed.)

This rule is superior, we claim, to any rule requiring a fixed level of
indentation from the margin.  The four-space rule is clear but
unnatural. It is quite unintuitive that

``` markdown
- foo

  bar

  - baz
```

should be parsed as two lists with an intervening paragraph,

``` html

    

  • foo
    • 



bar


    

  • baz
    • 


```

as the four-space rule demands, rather than a single list,

``` html

    

  • 

    foo
    

    bar
    

      

    • baz
      • 

    

    • 


```

The choice of four spaces is arbitrary.  It can be learned, but it is
not likely to be guessed, and it trips up beginners regularly.

Would it help to adopt a two-space rule?  The problem is that such
a rule, together with the rule allowing up to three spaces of indentation for
the initial list marker, allows text that is indented *less than* the
original list marker to be included in the list item. For example,
`Markdown.pl` parses

``` markdown
   - one

  two
```

as a single list item, with `two` a continuation paragraph:

``` html

    

  • 

    one
    

    two
    

    • 


```

and similarly

``` markdown
>   - one
>
>  two
```

as

``` html



    

  • 

    one
    

    two
    

    • 




```

This is extremely unintuitive.

Rather than requiring a fixed indent from the margin, we could require
a fixed indent (say, two spaces, or even one space) from the list marker (which
may itself be indented).  This proposal would remove the last anomaly
discussed.  Unlike the spec presented above, it would count the following
as a list item with a subparagraph, even though the paragraph `bar`
is not indented as far as the first paragraph `foo`:

``` markdown
 10. foo

   bar  
```

Arguably this text does read like a list item with `bar` as a subparagraph,
which may count in favor of the proposal.  However, on this proposal indented
code would have to be indented six spaces after the list marker.  And this
would break a lot of existing Markdown, which has the pattern:

``` markdown
1.  foo

        indented code
```

where the code is indented eight spaces.  The spec above, by contrast, will
parse this text as expected, since the code block's indentation is measured
from the beginning of `foo`.

The one case that needs special treatment is a list item that *starts*
with indented code.  How much indentation is required in that case, since
we don't have a "first paragraph" to measure from?  Rule #2 simply stipulates
that in such cases, we require one space indentation from the list marker
(and then the normal four spaces for the indented code).  This will match the
four-space rule in cases where the list marker plus its initial indentation
takes four spaces (a common case), but diverge in other cases.

## Lists

A [list](@) is a sequence of one or more
list items [of the same type].  The list items
may be separated by any number of blank lines.

Two list items are [of the same type](@)
if they begin with a [list marker] of the same type.
Two list markers are of the
same type if (a) they are bullet list markers using the same character
(`-`, `+`, or `*`) or (b) they are ordered list numbers with the same
delimiter (either `.` or `)`).

A list is an [ordered list](@)
if its constituent list items begin with
[ordered list markers], and a
[bullet list](@) if its constituent list
items begin with [bullet list markers].

The [start number](@)
of an [ordered list] is determined by the list number of
its initial list item.  The numbers of subsequent list items are
disregarded.

A list is [loose](@) if any of its constituent
list items are separated by blank lines, or if any of its constituent
list items directly contain two block-level elements with a blank line
between them.  Otherwise a list is [tight](@).
(The difference in HTML output is that paragraphs in a loose list are
wrapped in `
` tags, while paragraphs in a tight list are not.)

Changing the bullet or ordered list delimiter starts a new list:

```````````````````````````````` example
- foo
- bar
+ baz
.

    

  • foo
    • 

  • bar
    • 



    

  • baz
    • 


````````````````````````````````


```````````````````````````````` example
1. foo
2. bar
3) baz
.

    

  1. foo
    2. 

  2. bar
    3. 



    

  1. baz
    2. 


````````````````````````````````


In CommonMark, a list can interrupt a paragraph. That is,
no blank line is needed to separate a paragraph from a following
list:

```````````````````````````````` example
Foo
- bar
- baz
.

Foo


    

  • bar
    • 

  • baz
    • 


````````````````````````````````

`Markdown.pl` does not allow this, through fear of triggering a list
via a numeral in a hard-wrapped line:

``` markdown
The number of windows in my house is
14.  The number of doors is 6.
```

Oddly, though, `Markdown.pl` *does* allow a blockquote to
interrupt a paragraph, even though the same considerations might
apply.

In CommonMark, we do allow lists to interrupt paragraphs, for
two reasons.  First, it is natural and not uncommon for people
to start lists without blank lines:

``` markdown
I need to buy
- new shoes
- a coat
- a plane ticket
```

Second, we are attracted to a

> [principle of uniformity](@):
> if a chunk of text has a certain
> meaning, it will continue to have the same meaning when put into a
> container block (such as a list item or blockquote).

(Indeed, the spec for [list items] and [block quotes] presupposes
this principle.) This principle implies that if

``` markdown
  * I need to buy
    - new shoes
    - a coat
    - a plane ticket
```

is a list item containing a paragraph followed by a nested sublist,
as all Markdown implementations agree it is (though the paragraph
may be rendered without `
` tags, since the list is "tight"),
then

``` markdown
I need to buy
- new shoes
- a coat
- a plane ticket
```

by itself should be a paragraph followed by a nested sublist.

Since it is well established Markdown practice to allow lists to
interrupt paragraphs inside list items, the [principle of
uniformity] requires us to allow this outside list items as
well.  ([reStructuredText](https://docutils.sourceforge.net/rst.html)
takes a different approach, requiring blank lines before lists
even inside other list items.)

In order to solve the problem of unwanted lists in paragraphs with
hard-wrapped numerals, we allow only lists starting with `1` to
interrupt paragraphs.  Thus,

```````````````````````````````` example
The number of windows in my house is
14.  The number of doors is 6.
.

The number of windows in my house is
14.  The number of doors is 6.

````````````````````````````````

We may still get an unintended result in cases like

```````````````````````````````` example
The number of windows in my house is
1.  The number of doors is 6.
.

The number of windows in my house is


    

  1. The number of doors is 6.
    2. 


````````````````````````````````

but this rule should prevent most spurious list captures.

There can be any number of blank lines between items:

```````````````````````````````` example
- foo

- bar


- baz
.

    

  • 

    foo
    

    • 

  • 

    bar
    

    • 

  • 

    baz
    

    • 


````````````````````````````````

```````````````````````````````` example
- foo
  - bar
    - baz


      bim
.

    

  • foo

      

    • bar

        

      • 

        baz
        

        bim
        

        • 

      

      • 

    

    • 


````````````````````````````````


To separate consecutive lists of the same type, or to separate a
list from an indented code block that would otherwise be parsed
as a subparagraph of the final list item, you can insert a blank HTML
comment:

```````````````````````````````` example
- foo
- bar



- baz
- bim
.

    

  • foo
    • 

  • bar
    • 




    

  • baz
    • 

  • bim
    • 


````````````````````````````````


```````````````````````````````` example
-   foo

    notcode

-   foo



    code
.

    

  • 

    foo
    

    notcode
    

    • 

  • 

    foo
    

    • 




code


````````````````````````````````


List items need not be indented to the same level.  The following
list items will be treated as items at the same list level,
since none is indented enough to belong to the previous list
item:

```````````````````````````````` example
- a
 - b
  - c
   - d
  - e
 - f
- g
.

    

  • a
    • 

  • b
    • 

  • c
    • 

  • d
    • 

  • e
    • 

  • f
    • 

  • g
    • 


````````````````````````````````


```````````````````````````````` example
1. a

  2. b

   3. c
.

    

  1. 

    a
    

    2. 

  2. 

    b
    

    3. 

  3. 

    c
    

    4. 


````````````````````````````````

Note, however, that list items may not be preceded by more than
three spaces of indentation.  Here `- e` is treated as a paragraph continuation
line, because it is indented more than three spaces:

```````````````````````````````` example
- a
 - b
  - c
   - d
    - e
.

    

  • a
    • 

  • b
    • 

  • c
    • 

  • d
- e
    • 


````````````````````````````````

And here, `3. c` is treated as in indented code block,
because it is indented four spaces and preceded by a
blank line.

```````````````````````````````` example
1. a

  2. b

    3. c
.

    

  1. 

    a
    

    2. 

  2. 

    b
    

    3. 



3. c


````````````````````````````````


This is a loose list, because there is a blank line between
two of the list items:

```````````````````````````````` example
- a
- b

- c
.

    

  • 

    a
    

    • 

  • 

    b
    

    • 

  • 

    c
    

    • 


````````````````````````````````


So is this, with a empty second item:

```````````````````````````````` example
* a
*

* c
.

    

  • 

    a
    

    • 

  • 

  • 

    c
    

    • 


````````````````````````````````


These are loose lists, even though there are no blank lines between the items,
because one of the items directly contains two block-level elements
with a blank line between them:

```````````````````````````````` example
- a
- b

  c
- d
.

    

  • 

    a
    

    • 

  • 

    b
    

    c
    

    • 

  • 

    d
    

    • 


````````````````````````````````


```````````````````````````````` example
- a
- b

  [ref]: /url
- d
.

    

  • 

    a
    

    • 

  • 

    b
    

    • 

  • 

    d
    

    • 


````````````````````````````````


This is a tight list, because the blank lines are in a code block:

```````````````````````````````` example
- a
- ```
  b


  ```
- c
.

    

  • a
    • 

  • 

    b



    

    • 

  • c
    • 


````````````````````````````````


This is a tight list, because the blank line is between two
paragraphs of a sublist.  So the sublist is loose while
the outer list is tight:

```````````````````````````````` example
- a
  - b

    c
- d
.

    

  • a

      

    • 

      b
      

      c
      

      • 

    

    • 

  • d
    • 


````````````````````````````````


This is a tight list, because the blank line is inside the
block quote:

```````````````````````````````` example
* a
  > b
  >
* c
.

    

  • a

    

    b
    

    

    • 

  • c
    • 


````````````````````````````````


This list is tight, because the consecutive block elements
are not separated by blank lines:

```````````````````````````````` example
- a
  > b
  ```
  c
  ```
- d
.

    

  • a

    

    b
    

    

    c

    

    • 

  • d
    • 


````````````````````````````````


A single-paragraph list is tight:

```````````````````````````````` example
- a
.

    

  • a
    • 


````````````````````````````````


```````````````````````````````` example
- a
  - b
.

    

  • a

      

    • b
      • 

    

    • 


````````````````````````````````


This list is loose, because of the blank line between the
two block elements in the list item:

```````````````````````````````` example
1. ```
   foo
   ```

   bar
.

    

  1. 

    foo

    

    bar
    

    2. 


````````````````````````````````


Here the outer list is loose, the inner list tight:

```````````````````````````````` example
* foo
  * bar

  baz
.

    

  • 

    foo
    

      

    • bar
      • 

    

    baz
    

    • 


````````````````````````````````


```````````````````````````````` example
- a
  - b
  - c

- d
  - e
  - f
.

    

  • 

    a
    

      

    • b
      • 

    • c
      • 

    

    • 

  • 

    d
    

      

    • e
      • 

    • f
      • 

    

    • 


````````````````````````````````


# Inlines

Inlines are parsed sequentially from the beginning of the character
stream to the end (left to right, in left-to-right languages).
Thus, for example, in

```````````````````````````````` example
`hi`lo`
.

hilo`

````````````````````````````````

`hi` is parsed as code, leaving the backtick at the end as a literal
backtick.



## Code spans

A [backtick string](@)
is a string of one or more backtick characters (`` ` ``) that is neither
preceded nor followed by a backtick.

A [code span](@) begins with a backtick string and ends with
a backtick string of equal length.  The contents of the code span are
the characters between these two backtick strings, normalized in the
following ways:

- First, [line endings] are converted to [spaces].
- If the resulting string both begins *and* ends with a [space]
  character, but does not consist entirely of [space]
  characters, a single [space] character is removed from the
  front and back.  This allows you to include code that begins
  or ends with backtick characters, which must be separated by
  whitespace from the opening or closing backtick strings.

This is a simple code span:

```````````````````````````````` example
`foo`
.

foo

````````````````````````````````


Here two backticks are used, because the code contains a backtick.
This example also illustrates stripping of a single leading and
trailing space:

```````````````````````````````` example
`` foo ` bar ``
.

foo ` bar

````````````````````````````````


This example shows the motivation for stripping leading and trailing
spaces:

```````````````````````````````` example
` `` `
.

``

````````````````````````````````

Note that only *one* space is stripped:

```````````````````````````````` example
`  ``  `
.

 `` 

````````````````````````````````

The stripping only happens if the space is on both
sides of the string:

```````````````````````````````` example
` a`
.

 a

````````````````````````````````

Only [spaces], and not [unicode whitespace] in general, are
stripped in this way:

```````````````````````````````` example
` b `
.

 b 

````````````````````````````````

No stripping occurs if the code span contains only spaces:

```````````````````````````````` example
` `
`  `
.

 
  

````````````````````````````````


[Line endings] are treated like spaces:

```````````````````````````````` example
``
foo
bar  
baz
``
.

foo bar   baz

````````````````````````````````

```````````````````````````````` example
``
foo 
``
.

foo 

````````````````````````````````


Interior spaces are not collapsed:

```````````````````````````````` example
`foo   bar 
baz`
.

foo   bar  baz

````````````````````````````````

Note that browsers will typically collapse consecutive spaces
when rendering `` elements, so it is recommended that
the following CSS be used:

    code{white-space: pre-wrap;}


Note that backslash escapes do not work in code spans. All backslashes
are treated literally:

```````````````````````````````` example
`foo\`bar`
.

foo\bar`

````````````````````````````````


Backslash escapes are never needed, because one can always choose a
string of *n* backtick characters as delimiters, where the code does
not contain any strings of exactly *n* backtick characters.

```````````````````````````````` example
``foo`bar``
.

foo`bar

````````````````````````````````

```````````````````````````````` example
` foo `` bar `
.

foo `` bar

````````````````````````````````


Code span backticks have higher precedence than any other inline
constructs except HTML tags and autolinks.  Thus, for example, this is
not parsed as emphasized text, since the second `*` is part of a code
span:

```````````````````````````````` example
*foo`*`
.

*foo*

````````````````````````````````


And this is not parsed as a link:

```````````````````````````````` example
[not a `link](/foo`)
.

[not a link](/foo)

````````````````````````````````


Code spans, HTML tags, and autolinks have the same precedence.
Thus, this is code:

```````````````````````````````` example
``
.

<a href="">`

````````````````````````````````


But this is an HTML tag:

```````````````````````````````` example
`
.

`

````````````````````````````````


And this is code:

```````````````````````````````` example
``
.

<https://foo.bar.baz>`

````````````````````````````````


But this is an autolink:

```````````````````````````````` example
`
.

https://foo.bar.`baz`

````````````````````````````````


When a backtick string is not closed by a matching backtick string,
we just have literal backticks:

```````````````````````````````` example
```foo``
.

```foo``

````````````````````````````````


```````````````````````````````` example
`foo
.

`foo

````````````````````````````````

The following case also illustrates the need for opening and
closing backtick strings to be equal in length:

```````````````````````````````` example
`foo``bar``
.

`foobar

````````````````````````````````


## Emphasis and strong emphasis

John Gruber's original [Markdown syntax
description](https://daringfireball.net/projects/markdown/syntax#em) says:

> Markdown treats asterisks (`*`) and underscores (`_`) as indicators of
> emphasis. Text wrapped with one `*` or `_` will be wrapped with an HTML
> `` tag; double `*`'s or `_`'s will be wrapped with an HTML ``
> tag.

This is enough for most users, but these rules leave much undecided,
especially when it comes to nested emphasis.  The original
`Markdown.pl` test suite makes it clear that triple `***` and
`___` delimiters can be used for strong emphasis, and most
implementations have also allowed the following patterns:

``` markdown
***strong emph***
***strong** in emph*
***emph* in strong**
**in strong *emph***
*in emph **strong***
```

The following patterns are less widely supported, but the intent
is clear and they are useful (especially in contexts like bibliography
entries):

``` markdown
*emph *with emph* in it*
**strong **with strong** in it**
```

Many implementations have also restricted intraword emphasis to
the `*` forms, to avoid unwanted emphasis in words containing
internal underscores.  (It is best practice to put these in code
spans, but users often do not.)

``` markdown
internal emphasis: foo*bar*baz
no emphasis: foo_bar_baz
```

The rules given below capture all of these patterns, while allowing
for efficient parsing strategies that do not backtrack.

First, some definitions.  A [delimiter run](@) is either
a sequence of one or more `*` characters that is not preceded or
followed by a non-backslash-escaped `*` character, or a sequence
of one or more `_` characters that is not preceded or followed by
a non-backslash-escaped `_` character.

A [left-flanking delimiter run](@) is
a [delimiter run] that is (1) not followed by [Unicode whitespace],
and either (2a) not followed by a [Unicode punctuation character], or
(2b) followed by a [Unicode punctuation character] and
preceded by [Unicode whitespace] or a [Unicode punctuation character].
For purposes of this definition, the beginning and the end of
the line count as Unicode whitespace.

A [right-flanking delimiter run](@) is
a [delimiter run] that is (1) not preceded by [Unicode whitespace],
and either (2a) not preceded by a [Unicode punctuation character], or
(2b) preceded by a [Unicode punctuation character] and
followed by [Unicode whitespace] or a [Unicode punctuation character].
For purposes of this definition, the beginning and the end of
the line count as Unicode whitespace.

Here are some examples of delimiter runs.

  - left-flanking but not right-flanking:

    ```
    ***abc
      _abc
    **"abc"
     _"abc"
    ```

  - right-flanking but not left-flanking:

    ```
     abc***
     abc_
    "abc"**
    "abc"_
    ```

  - Both left and right-flanking:

    ```
     abc***def
    "abc"_"def"
    ```

  - Neither left nor right-flanking:

    ```
    abc *** def
    a _ b
    ```

(The idea of distinguishing left-flanking and right-flanking
delimiter runs based on the character before and the character
after comes from Roopesh Chander's
[vfmd](https://web.archive.org/web/20220608143320/http://www.vfmd.org/vfmd-spec/specification/#procedure-for-identifying-emphasis-tags).
vfmd uses the terminology "emphasis indicator string" instead of "delimiter
run," and its rules for distinguishing left- and right-flanking runs
are a bit more complex than the ones given here.)

The following rules define emphasis and strong emphasis:

1.  A single `*` character [can open emphasis](@)
    iff (if and only if) it is part of a [left-flanking delimiter run].

2.  A single `_` character [can open emphasis] iff
    it is part of a [left-flanking delimiter run]
    and either (a) not part of a [right-flanking delimiter run]
    or (b) part of a [right-flanking delimiter run]
    preceded by a [Unicode punctuation character].

3.  A single `*` character [can close emphasis](@)
    iff it is part of a [right-flanking delimiter run].

4.  A single `_` character [can close emphasis] iff
    it is part of a [right-flanking delimiter run]
    and either (a) not part of a [left-flanking delimiter run]
    or (b) part of a [left-flanking delimiter run]
    followed by a [Unicode punctuation character].

5.  A double `**` [can open strong emphasis](@)
    iff it is part of a [left-flanking delimiter run].

6.  A double `__` [can open strong emphasis] iff
    it is part of a [left-flanking delimiter run]
    and either (a) not part of a [right-flanking delimiter run]
    or (b) part of a [right-flanking delimiter run]
    preceded by a [Unicode punctuation character].

7.  A double `**` [can close strong emphasis](@)
    iff it is part of a [right-flanking delimiter run].

8.  A double `__` [can close strong emphasis] iff
    it is part of a [right-flanking delimiter run]
    and either (a) not part of a [left-flanking delimiter run]
    or (b) part of a [left-flanking delimiter run]
    followed by a [Unicode punctuation character].

9.  Emphasis begins with a delimiter that [can open emphasis] and ends
    with a delimiter that [can close emphasis], and that uses the same
    character (`_` or `*`) as the opening delimiter.  The
    opening and closing delimiters must belong to separate
    [delimiter runs].  If one of the delimiters can both
    open and close emphasis, then the sum of the lengths of the
    delimiter runs containing the opening and closing delimiters
    must not be a multiple of 3 unless both lengths are
    multiples of 3.

10. Strong emphasis begins with a delimiter that
    [can open strong emphasis] and ends with a delimiter that
    [can close strong emphasis], and that uses the same character
    (`_` or `*`) as the opening delimiter.  The
    opening and closing delimiters must belong to separate
    [delimiter runs].  If one of the delimiters can both open
    and close strong emphasis, then the sum of the lengths of
    the delimiter runs containing the opening and closing
    delimiters must not be a multiple of 3 unless both lengths
    are multiples of 3.

11. A literal `*` character cannot occur at the beginning or end of
    `*`-delimited emphasis or `**`-delimited strong emphasis, unless it
    is backslash-escaped.

12. A literal `_` character cannot occur at the beginning or end of
    `_`-delimited emphasis or `__`-delimited strong emphasis, unless it
    is backslash-escaped.

Where rules 1--12 above are compatible with multiple parsings,
the following principles resolve ambiguity:

13. The number of nestings should be minimized. Thus, for example,
    an interpretation `...` is always preferred to
    `...`.

14. An interpretation `...` is always
    preferred to `...`.

15. When two potential emphasis or strong emphasis spans overlap,
    so that the second begins before the first ends and ends after
    the first ends, the first takes precedence. Thus, for example,
    `*foo _bar* baz_` is parsed as `foo _bar baz_` rather
    than `*foo bar* baz`.

16. When there are two potential emphasis or strong emphasis spans
    with the same closing delimiter, the shorter one (the one that
    opens later) takes precedence. Thus, for example,
    `**foo **bar baz**` is parsed as `**foo bar baz`
    rather than `foo **bar baz`.

17. Inline code spans, links, images, and HTML tags group more tightly
    than emphasis.  So, when there is a choice between an interpretation
    that contains one of these elements and one that does not, the
    former always wins.  Thus, for example, `*[foo*](bar)` is
    parsed as `*foo*` rather than as
    `[foo](bar)`.

These rules can be illustrated through a series of examples.

Rule 1:

```````````````````````````````` example
*foo bar*
.

foo bar

````````````````````````````````


This is not emphasis, because the opening `*` is followed by
whitespace, and hence not part of a [left-flanking delimiter run]:

```````````````````````````````` example
a * foo bar*
.

a * foo bar*

````````````````````````````````


This is not emphasis, because the opening `*` is preceded
by an alphanumeric and followed by punctuation, and hence
not part of a [left-flanking delimiter run]:

```````````````````````````````` example
a*"foo"*
.

a*"foo"*

````````````````````````````````


Unicode nonbreaking spaces count as whitespace, too:

```````````````````````````````` example
* a *
.

* a *

````````````````````````````````


Unicode symbols count as punctuation, too:

```````````````````````````````` example
*$*alpha.

*£*bravo.

*€*charlie.
.

*$*alpha.


*£*bravo.


*€*charlie.

````````````````````````````````


Intraword emphasis with `*` is permitted:

```````````````````````````````` example
foo*bar*
.

foobar

````````````````````````````````


```````````````````````````````` example
5*6*78
.

5678

````````````````````````````````


Rule 2:

```````````````````````````````` example
_foo bar_
.

foo bar

````````````````````````````````


This is not emphasis, because the opening `_` is followed by
whitespace:

```````````````````````````````` example
_ foo bar_
.

_ foo bar_

````````````````````````````````


This is not emphasis, because the opening `_` is preceded
by an alphanumeric and followed by punctuation:

```````````````````````````````` example
a_"foo"_
.

a_"foo"_

````````````````````````````````


Emphasis with `_` is not allowed inside words:

```````````````````````````````` example
foo_bar_
.

foo_bar_

````````````````````````````````


```````````````````````````````` example
5_6_78
.

5_6_78

````````````````````````````````


```````````````````````````````` example
пристаням_стремятся_
.

пристаням_стремятся_

````````````````````````````````


Here `_` does not generate emphasis, because the first delimiter run
is right-flanking and the second left-flanking:

```````````````````````````````` example
aa_"bb"_cc
.

aa_"bb"_cc

````````````````````````````````


This is emphasis, even though the opening delimiter is
both left- and right-flanking, because it is preceded by
punctuation:

```````````````````````````````` example
foo-_(bar)_
.

foo-(bar)

````````````````````````````````


Rule 3:

This is not emphasis, because the closing delimiter does
not match the opening delimiter:

```````````````````````````````` example
_foo*
.

_foo*

````````````````````````````````


This is not emphasis, because the closing `*` is preceded by
whitespace:

```````````````````````````````` example
*foo bar *
.

*foo bar *

````````````````````````````````


A line ending also counts as whitespace:

```````````````````````````````` example
*foo bar
*
.

*foo bar
*

````````````````````````````````


This is not emphasis, because the second `*` is
preceded by punctuation and followed by an alphanumeric
(hence it is not part of a [right-flanking delimiter run]:

```````````````````````````````` example
*(*foo)
.

*(*foo)

````````````````````````````````


The point of this restriction is more easily appreciated
with this example:

```````````````````````````````` example
*(*foo*)*
.

(foo)

````````````````````````````````


Intraword emphasis with `*` is allowed:

```````````````````````````````` example
*foo*bar
.

foobar

````````````````````````````````



Rule 4:

This is not emphasis, because the closing `_` is preceded by
whitespace:

```````````````````````````````` example
_foo bar _
.

_foo bar _

````````````````````````````````


This is not emphasis, because the second `_` is
preceded by punctuation and followed by an alphanumeric:

```````````````````````````````` example
_(_foo)
.

_(_foo)

````````````````````````````````


This is emphasis within emphasis:

```````````````````````````````` example
_(_foo_)_
.

(foo)

````````````````````````````````


Intraword emphasis is disallowed for `_`:

```````````````````````````````` example
_foo_bar
.

_foo_bar

````````````````````````````````


```````````````````````````````` example
_пристаням_стремятся
.

_пристаням_стремятся

````````````````````````````````


```````````````````````````````` example
_foo_bar_baz_
.

foo_bar_baz

````````````````````````````````


This is emphasis, even though the closing delimiter is
both left- and right-flanking, because it is followed by
punctuation:

```````````````````````````````` example
_(bar)_.
.

(bar).

````````````````````````````````


Rule 5:

```````````````````````````````` example
**foo bar**
.

foo bar

````````````````````````````````


This is not strong emphasis, because the opening delimiter is
followed by whitespace:

```````````````````````````````` example
** foo bar**
.

** foo bar**

````````````````````````````````


This is not strong emphasis, because the opening `**` is preceded
by an alphanumeric and followed by punctuation, and hence
not part of a [left-flanking delimiter run]:

```````````````````````````````` example
a**"foo"**
.

a**"foo"**

````````````````````````````````


Intraword strong emphasis with `**` is permitted:

```````````````````````````````` example
foo**bar**
.

foobar

````````````````````````````````


Rule 6:

```````````````````````````````` example
__foo bar__
.

foo bar

````````````````````````````````


This is not strong emphasis, because the opening delimiter is
followed by whitespace:

```````````````````````````````` example
__ foo bar__
.

__ foo bar__

````````````````````````````````


A line ending counts as whitespace:
```````````````````````````````` example
__
foo bar__
.

__
foo bar__

````````````````````````````````


This is not strong emphasis, because the opening `__` is preceded
by an alphanumeric and followed by punctuation:

```````````````````````````````` example
a__"foo"__
.

a__"foo"__

````````````````````````````````


Intraword strong emphasis is forbidden with `__`:

```````````````````````````````` example
foo__bar__
.

foo__bar__

````````````````````````````````


```````````````````````````````` example
5__6__78
.

5__6__78

````````````````````````````````


```````````````````````````````` example
пристаням__стремятся__
.

пристаням__стремятся__

````````````````````````````````


```````````````````````````````` example
__foo, __bar__, baz__
.

foo, bar, baz

````````````````````````````````


This is strong emphasis, even though the opening delimiter is
both left- and right-flanking, because it is preceded by
punctuation:

```````````````````````````````` example
foo-__(bar)__
.

foo-(bar)

````````````````````````````````



Rule 7:

This is not strong emphasis, because the closing delimiter is preceded
by whitespace:

```````````````````````````````` example
**foo bar **
.

**foo bar **

````````````````````````````````


(Nor can it be interpreted as an emphasized `*foo bar *`, because of
Rule 11.)

This is not strong emphasis, because the second `**` is
preceded by punctuation and followed by an alphanumeric:

```````````````````````````````` example
**(**foo)
.

**(**foo)

````````````````````````````````


The point of this restriction is more easily appreciated
with these examples:

```````````````````````````````` example
*(**foo**)*
.

(foo)

````````````````````````````````


```````````````````````````````` example
**Gomphocarpus (*Gomphocarpus physocarpus*, syn.
*Asclepias physocarpa*)**
.

Gomphocarpus (Gomphocarpus physocarpus, syn.
Asclepias physocarpa)

````````````````````````````````


```````````````````````````````` example
**foo "*bar*" foo**
.

foo "bar" foo

````````````````````````````````


Intraword emphasis:

```````````````````````````````` example
**foo**bar
.

foobar

````````````````````````````````


Rule 8:

This is not strong emphasis, because the closing delimiter is
preceded by whitespace:

```````````````````````````````` example
__foo bar __
.

__foo bar __

````````````````````````````````


This is not strong emphasis, because the second `__` is
preceded by punctuation and followed by an alphanumeric:

```````````````````````````````` example
__(__foo)
.

__(__foo)

````````````````````````````````


The point of this restriction is more easily appreciated
with this example:

```````````````````````````````` example
_(__foo__)_
.

(foo)

````````````````````````````````


Intraword strong emphasis is forbidden with `__`:

```````````````````````````````` example
__foo__bar
.

__foo__bar

````````````````````````````````


```````````````````````````````` example
__пристаням__стремятся
.

__пристаням__стремятся

````````````````````````````````


```````````````````````````````` example
__foo__bar__baz__
.

foo__bar__baz

````````````````````````````````


This is strong emphasis, even though the closing delimiter is
both left- and right-flanking, because it is followed by
punctuation:

```````````````````````````````` example
__(bar)__.
.

(bar).

````````````````````````````````


Rule 9:

Any nonempty sequence of inline elements can be the contents of an
emphasized span.

```````````````````````````````` example
*foo [bar](/url)*
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo
bar*
.

foo
bar

````````````````````````````````


In particular, emphasis and strong emphasis can be nested
inside emphasis:

```````````````````````````````` example
_foo __bar__ baz_
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
_foo _bar_ baz_
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
__foo_ bar_
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo *bar**
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo **bar** baz*
.

foo bar baz

````````````````````````````````

```````````````````````````````` example
*foo**bar**baz*
.

foobarbaz

````````````````````````````````

Note that in the preceding case, the interpretation

``` markdown

foobarbaz

```


is precluded by the condition that a delimiter that
can both open and close (like the `*` after `foo`)
cannot form emphasis if the sum of the lengths of
the delimiter runs containing the opening and
closing delimiters is a multiple of 3 unless
both lengths are multiples of 3.


For the same reason, we don't get two consecutive
emphasis sections in this example:

```````````````````````````````` example
*foo**bar*
.

foo**bar

````````````````````````````````


The same condition ensures that the following
cases are all strong emphasis nested inside
emphasis, even when the interior whitespace is
omitted:


```````````````````````````````` example
***foo** bar*
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo **bar***
.

foo bar

````````````````````````````````


```````````````````````````````` example
*foo**bar***
.

foobar

````````````````````````````````


When the lengths of the interior closing and opening
delimiter runs are *both* multiples of 3, though,
they can match to create emphasis:

```````````````````````````````` example
foo***bar***baz
.

foobarbaz

````````````````````````````````

```````````````````````````````` example
foo******bar*********baz
.

foobar***baz

````````````````````````````````


Indefinite levels of nesting are possible:

```````````````````````````````` example
*foo **bar *baz* bim** bop*
.

foo bar baz bim bop

````````````````````````````````


```````````````````````````````` example
*foo [*bar*](/url)*
.

foo bar

````````````````````````````````


There can be no empty emphasis or strong emphasis:

```````````````````````````````` example
** is not an empty emphasis
.

** is not an empty emphasis

````````````````````````````````


```````````````````````````````` example
**** is not an empty strong emphasis
.

**** is not an empty strong emphasis

````````````````````````````````



Rule 10:

Any nonempty sequence of inline elements can be the contents of an
strongly emphasized span.

```````````````````````````````` example
**foo [bar](/url)**
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo
bar**
.

foo
bar

````````````````````````````````


In particular, emphasis and strong emphasis can be nested
inside strong emphasis:

```````````````````````````````` example
__foo _bar_ baz__
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
__foo __bar__ baz__
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
____foo__ bar__
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo **bar****
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo *bar* baz**
.

foo bar baz

````````````````````````````````


```````````````````````````````` example
**foo*bar*baz**
.

foobarbaz

````````````````````````````````


```````````````````````````````` example
***foo* bar**
.

foo bar

````````````````````````````````


```````````````````````````````` example
**foo *bar***
.

foo bar

````````````````````````````````


Indefinite levels of nesting are possible:

```````````````````````````````` example
**foo *bar **baz**
bim* bop**
.

foo bar baz
bim bop

````````````````````````````````


```````````````````````````````` example
**foo [*bar*](/url)**
.

foo bar

````````````````````````````````


There can be no empty emphasis or strong emphasis:

```````````````````````````````` example
__ is not an empty emphasis
.

__ is not an empty emphasis

````````````````````````````````


```````````````````````````````` example
____ is not an empty strong emphasis
.

____ is not an empty strong emphasis

````````````````````````````````



Rule 11:

```````````````````````````````` example
foo ***
.

foo ***

````````````````````````````````


```````````````````````````````` example
foo *\**
.

foo *

````````````````````````````````


```````````````````````````````` example
foo *_*
.

foo _

````````````````````````````````


```````````````````````````````` example
foo *****
.

foo *****

````````````````````````````````


```````````````````````````````` example
foo **\***
.

foo *

````````````````````````````````


```````````````````````````````` example
foo **_**
.

foo _

````````````````````````````````


Note that when delimiters do not match evenly, Rule 11 determines
that the excess literal `*` characters will appear outside of the
emphasis, rather than inside it:

```````````````````````````````` example
**foo*
.

*foo

````````````````````````````````


```````````````````````````````` example
*foo**
.

foo*

````````````````````````````````


```````````````````````````````` example
***foo**
.

*foo

````````````````````````````````


```````````````````````````````` example
****foo*
.

***foo

````````````````````````````````


```````````````````````````````` example
**foo***
.

foo*

````````````````````````````````


```````````````````````````````` example
*foo****
.

foo***

````````````````````````````````



Rule 12:

```````````````````````````````` example
foo ___
.

foo ___

````````````````````````````````


```````````````````````````````` example
foo _\__
.

foo _

````````````````````````````````


```````````````````````````````` example
foo _*_
.

foo *

````````````````````````````````


```````````````````````````````` example
foo _____
.

foo _____

````````````````````````````````


```````````````````````````````` example
foo __\___
.

foo _

````````````````````````````````


```````````````````````````````` example
foo __*__
.

foo *

````````````````````````````````


```````````````````````````````` example
__foo_
.

_foo

````````````````````````````````


Note that when delimiters do not match evenly, Rule 12 determines
that the excess literal `_` characters will appear outside of the
emphasis, rather than inside it:

```````````````````````````````` example
_foo__
.

foo_

````````````````````````````````


```````````````````````````````` example
___foo__
.

_foo

````````````````````````````````


```````````````````````````````` example
____foo_
.

___foo

````````````````````````````````


```````````````````````````````` example
__foo___
.

foo_

````````````````````````````````


```````````````````````````````` example
_foo____
.

foo___

````````````````````````````````


Rule 13 implies that if you want emphasis nested directly inside
emphasis, you must use different delimiters:

```````````````````````````````` example
**foo**
.

foo

````````````````````````````````


```````````````````````````````` example
*_foo_*
.

foo

````````````````````````````````


```````````````````````````````` example
__foo__
.

foo

````````````````````````````````


```````````````````````````````` example
_*foo*_
.

foo

````````````````````````````````


However, strong emphasis within strong emphasis is possible without
switching delimiters:

```````````````````````````````` example
****foo****
.

foo

````````````````````````````````


```````````````````````````````` example
____foo____
.

foo

````````````````````````````````



Rule 13 can be applied to arbitrarily long sequences of
delimiters:

```````````````````````````````` example
******foo******
.

foo

````````````````````````````````


Rule 14:

```````````````````````````````` example
***foo***
.

foo

````````````````````````````````


```````````````````````````````` example
_____foo_____
.

foo

````````````````````````````````


Rule 15:

```````````````````````````````` example
*foo _bar* baz_
.

foo _bar baz_

````````````````````````````````


```````````````````````````````` example
*foo __bar *baz bim__ bam*
.

foo bar *baz bim bam

````````````````````````````````


Rule 16:

```````````````````````````````` example
**foo **bar baz**
.

**foo bar baz

````````````````````````````````


```````````````````````````````` example
*foo *bar baz*
.

*foo bar baz

````````````````````````````````


Rule 17:

```````````````````````````````` example
*[bar*](/url)
.

*bar*

````````````````````````````````


```````````````````````````````` example
_foo [bar_](/url)
.

_foo bar_

````````````````````````````````


```````````````````````````````` example
*
.

*

````````````````````````````````


```````````````````````````````` example
**
.

**

````````````````````````````````


```````````````````````````````` example
__
.

__

````````````````````````````````


```````````````````````````````` example
*a `*`*
.

a *

````````````````````````````````


```````````````````````````````` example
_a `_`_
.

a _

````````````````````````````````


```````````````````````````````` example
**a
.

**ahttps://foo.bar/?q=**

````````````````````````````````


```````````````````````````````` example
__a
.

__ahttps://foo.bar/?q=__

````````````````````````````````



## Links

A link contains [link text] (the visible text), a [link destination]
(the URI that is the link destination), and optionally a [link title].
There are two basic kinds of links in Markdown.  In [inline links] the
destination and title are given immediately after the link text.  In
[reference links] the destination and title are defined elsewhere in
the document.

A [link text](@) consists of a sequence of zero or more
inline elements enclosed by square brackets (`[` and `]`).  The
following rules apply:

- Links may not contain other links, at any level of nesting. If
  multiple otherwise valid link definitions appear nested inside each
  other, the inner-most definition is used.

- Brackets are allowed in the [link text] only if (a) they
  are backslash-escaped or (b) they appear as a matched pair of brackets,
  with an open bracket `[`, a sequence of zero or more inlines, and
  a close bracket `]`.

- Backtick [code spans], [autolinks], and raw [HTML tags] bind more tightly
  than the brackets in link text.  Thus, for example,
  `` [foo`]` `` could not be a link text, since the second `]`
  is part of a code span.

- The brackets in link text bind more tightly than markers for
  [emphasis and strong emphasis]. Thus, for example, `*[foo*](url)` is a link.

A [link destination](@) consists of either

- a sequence of zero or more characters between an opening `<` and a
  closing `>` that contains no line endings or unescaped
  `<` or `>` characters, or

- a nonempty sequence of characters that does not start with `<`,
  does not include [ASCII control characters][ASCII control character]
  or [space] character, and includes parentheses only if (a) they are
  backslash-escaped or (b) they are part of a balanced pair of
  unescaped parentheses.
  (Implementations may impose limits on parentheses nesting to
  avoid performance issues, but at least three levels of nesting
  should be supported.)

A [link title](@)  consists of either

- a sequence of zero or more characters between straight double-quote
  characters (`"`), including a `"` character only if it is
  backslash-escaped, or

- a sequence of zero or more characters between straight single-quote
  characters (`'`), including a `'` character only if it is
  backslash-escaped, or

- a sequence of zero or more characters between matching parentheses
  (`(...)`), including a `(` or `)` character only if it is
  backslash-escaped.

Although [link titles] may span multiple lines, they may not contain
a [blank line].

An [inline link](@) consists of a [link text] followed immediately
by a left parenthesis `(`, an optional [link destination], an optional
[link title], and a right parenthesis `)`.
These four components may be separated by spaces, tabs, and up to one line
ending.
If both [link destination] and [link title] are present, they *must* be
separated by spaces, tabs, and up to one line ending.

The link's text consists of the inlines contained
in the [link text] (excluding the enclosing square brackets).
The link's URI consists of the link destination, excluding enclosing
`<...>` if present, with backslash-escapes in effect as described
above.  The link's title consists of the link title, excluding its
enclosing delimiters, with backslash-escapes in effect as described
above.

Here is a simple inline link:

```````````````````````````````` example
[link](/uri "title")
.

link

````````````````````````````````


The title, the link text and even 
the destination may be omitted:

```````````````````````````````` example
[link](/uri)
.

link

````````````````````````````````

```````````````````````````````` example
[](./target.md)
.


````````````````````````````````


```````````````````````````````` example
[link]()
.

link

````````````````````````````````


```````````````````````````````` example
[link](<>)
.

link

````````````````````````````````


```````````````````````````````` example
[]()
.


````````````````````````````````

The destination can only contain spaces if it is
enclosed in pointy brackets:

```````````````````````````````` example
[link](/my uri)
.

[link](/my uri)

````````````````````````````````

```````````````````````````````` example
[link]()
.

link

````````````````````````````````

The destination cannot contain line endings,
even if enclosed in pointy brackets:

```````````````````````````````` example
[link](foo
bar)
.

[link](foo
bar)

````````````````````````````````

```````````````````````````````` example
[link]()
.

[link]()

````````````````````````````````

The destination can contain `)` if it is enclosed
in pointy brackets:

```````````````````````````````` example
[a]()
.

a

````````````````````````````````

Pointy brackets that enclose links must be unescaped:

```````````````````````````````` example
[link]()
.

[link](<foo>)

````````````````````````````````

These are not links, because the opening pointy bracket
is not matched properly:

```````````````````````````````` example
[a](
[a](c)
.

[a](<b)c
[a](<b)c>
[a](c)

````````````````````````````````

Parentheses inside the link destination may be escaped:

```````````````````````````````` example
[link](\(foo\))
.

link

````````````````````````````````

Any number of parentheses are allowed without escaping, as long as they are
balanced:

```````````````````````````````` example
[link](foo(and(bar)))
.

link

````````````````````````````````

However, if you have unbalanced parentheses, you need to escape or use the
`<...>` form:

```````````````````````````````` example
[link](foo(and(bar))
.

[link](foo(and(bar))

````````````````````````````````


```````````````````````````````` example
[link](foo\(and\(bar\))
.

link

````````````````````````````````


```````````````````````````````` example
[link]()
.

link

````````````````````````````````


Parentheses and other symbols can also be escaped, as usual
in Markdown:

```````````````````````````````` example
[link](foo\)\:)
.

link

````````````````````````````````


A link can contain fragment identifiers and queries:

```````````````````````````````` example
[link](#fragment)

[link](https://example.com#fragment)

[link](https://example.com?foo=3#frag)
.

link


link


link

````````````````````````````````


Note that a backslash before a non-escapable character is
just a backslash:

```````````````````````````````` example
[link](foo\bar)
.

link

````````````````````````````````


URL-escaping should be left alone inside the destination, as all
URL-escaped characters are also valid URL characters. Entity and
numerical character references in the destination will be parsed
into the corresponding Unicode code points, as usual.  These may
be optionally URL-escaped when written as HTML, but this spec
does not enforce any particular policy for rendering URLs in
HTML or other formats.  Renderers may make different decisions
about how to escape or normalize URLs in the output.

```````````````````````````````` example
[link](foo%20bä)
.

link

````````````````````````````````


Note that, because titles can often be parsed as destinations,
if you try to omit the destination and keep the title, you'll
get unexpected results:

```````````````````````````````` example
[link]("title")
.

link

````````````````````````````````


Titles may be in single quotes, double quotes, or parentheses:

```````````````````````````````` example
[link](/url "title")
[link](/url 'title')
[link](/url (title))
.

link
link
link

````````````````````````````````


Backslash escapes and entity and numeric character references
may be used in titles:

```````````````````````````````` example
[link](/url "title \""")
.

link

````````````````````````````````


Titles must be separated from the link using spaces, tabs, and up to one line
ending.
Other [Unicode whitespace] like non-breaking space doesn't work.

```````````````````````````````` example
[link](/url "title")
.

link

````````````````````````````````


Nested balanced quotes are not allowed without escaping:

```````````````````````````````` example
[link](/url "title "and" title")
.

[link](/url "title "and" title")

````````````````````````````````


But it is easy to work around this by using a different quote type:

```````````````````````````````` example
[link](/url 'title "and" title')
.

link

````````````````````````````````


(Note:  `Markdown.pl` did allow double quotes inside a double-quoted
title, and its test suite included a test demonstrating this.
But it is hard to see a good rationale for the extra complexity this
brings, since there are already many ways---backslash escaping,
entity and numeric character references, or using a different
quote type for the enclosing title---to write titles containing
double quotes.  `Markdown.pl`'s handling of titles has a number
of other strange features.  For example, it allows single-quoted
titles in inline links, but not reference links.  And, in
reference links but not inline links, it allows a title to begin
with `"` and end with `)`.  `Markdown.pl` 1.0.1 even allows
titles with no closing quotation mark, though 1.0.2b8 does not.
It seems preferable to adopt a simple, rational rule that works
the same way in inline links and link reference definitions.)

Spaces, tabs, and up to one line ending is allowed around the destination and
title:

```````````````````````````````` example
[link](   /uri
  "title"  )
.

link

````````````````````````````````


But it is not allowed between the link text and the
following parenthesis:

```````````````````````````````` example
[link] (/uri)
.

[link] (/uri)

````````````````````````````````


The link text may contain balanced brackets, but not unbalanced ones,
unless they are escaped:

```````````````````````````````` example
[link [foo [bar]]](/uri)
.

link [foo [bar]]

````````````````````````````````


```````````````````````````````` example
[link] bar](/uri)
.

[link] bar](/uri)

````````````````````````````````


```````````````````````````````` example
[link [bar](/uri)
.

[link bar

````````````````````````````````


```````````````````````````````` example
[link \[bar](/uri)
.

link [bar

````````````````````````````````


The link text may contain inline content:

```````````````````````````````` example
[link *foo **bar** `#`*](/uri)
.

link foo bar #

````````````````````````````````


```````````````````````````````` example
[![moon](moon.jpg)](/uri)
.

moon

````````````````````````````````


However, links may not contain other links, at any level of nesting.

```````````````````````````````` example
[foo [bar](/uri)](/uri)
.

[foo bar](/uri)

````````````````````````````````


```````````````````````````````` example
[foo *[bar [baz](/uri)](/uri)*](/uri)
.

[foo [bar baz](/uri)](/uri)

````````````````````````````````


```````````````````````````````` example
![[[foo](uri1)](uri2)](uri3)
.

[foo](uri2)

````````````````````````````````


These cases illustrate the precedence of link text grouping over
emphasis grouping:

```````````````````````````````` example
*[foo*](/uri)
.

*foo*

````````````````````````````````


```````````````````````````````` example
[foo *bar](baz*)
.

foo *bar

````````````````````````````````


Note that brackets that *aren't* part of links do not take
precedence:

```````````````````````````````` example
*foo [bar* baz]
.

foo [bar baz]

````````````````````````````````


These cases illustrate the precedence of HTML tags, code spans,
and autolinks over link grouping:

```````````````````````````````` example
[foo 
.

[foo 

````````````````````````````````


```````````````````````````````` example
[foo`](/uri)`
.

[foo](/uri)

````````````````````````````````


```````````````````````````````` example
[foo
.

[foohttps://example.com/?search=](uri)

````````````````````````````````


There are three kinds of [reference link](@)s:
[full](#full-reference-link), [collapsed](#collapsed-reference-link),
and [shortcut](#shortcut-reference-link).

A [full reference link](@)
consists of a [link text] immediately followed by a [link label]
that [matches] a [link reference definition] elsewhere in the document.

A [link label](@)  begins with a left bracket (`[`) and ends
with the first right bracket (`]`) that is not backslash-escaped.
Between these brackets there must be at least one character that is not a space,
tab, or line ending.
Unescaped square bracket characters are not allowed inside the
opening and closing square brackets of [link labels].  A link
label can have at most 999 characters inside the square
brackets.

One label [matches](@)
another just in case their normalized forms are equal.  To normalize a
label, strip off the opening and closing brackets,
perform the *Unicode case fold*, strip leading and trailing
spaces, tabs, and line endings, and collapse consecutive internal
spaces, tabs, and line endings to a single space.  If there are multiple
matching reference link definitions, the one that comes first in the
document is used.  (It is desirable in such cases to emit a warning.)

The link's URI and title are provided by the matching [link
reference definition].

Here is a simple example:

```````````````````````````````` example
[foo][bar]

[bar]: /url "title"
.

foo

````````````````````````````````


The rules for the [link text] are the same as with
[inline links].  Thus:

The link text may contain balanced brackets, but not unbalanced ones,
unless they are escaped:

```````````````````````````````` example
[link [foo [bar]]][ref]

[ref]: /uri
.

link [foo [bar]]

````````````````````````````````


```````````````````````````````` example
[link \[bar][ref]

[ref]: /uri
.

link [bar

````````````````````````````````


The link text may contain inline content:

```````````````````````````````` example
[link *foo **bar** `#`*][ref]

[ref]: /uri
.

link foo bar #

````````````````````````````````


```````````````````````````````` example
[![moon](moon.jpg)][ref]

[ref]: /uri
.

moon

````````````````````````````````


However, links may not contain other links, at any level of nesting.

```````````````````````````````` example
[foo [bar](/uri)][ref]

[ref]: /uri
.

[foo bar]ref

````````````````````````````````


```````````````````````````````` example
[foo *bar [baz][ref]*][ref]

[ref]: /uri
.

[foo bar baz]ref

````````````````````````````````


(In the examples above, we have two [shortcut reference links]
instead of one [full reference link].)

The following cases illustrate the precedence of link text grouping over
emphasis grouping:

```````````````````````````````` example
*[foo*][ref]

[ref]: /uri
.

*foo*

````````````````````````````````


```````````````````````````````` example
[foo *bar][ref]*

[ref]: /uri
.

foo *bar*

````````````````````````````````


These cases illustrate the precedence of HTML tags, code spans,
and autolinks over link grouping:

```````````````````````````````` example
[foo 

[ref]: /uri
.

[foo 

````````````````````````````````


```````````````````````````````` example
[foo`][ref]`

[ref]: /uri
.

[foo][ref]

````````````````````````````````


```````````````````````````````` example
[foo

[ref]: /uri
.

[foohttps://example.com/?search=][ref]

````````````````````````````````


Matching is case-insensitive:

```````````````````````````````` example
[foo][BaR]

[bar]: /url "title"
.

foo

````````````````````````````````


Unicode case fold is used:

```````````````````````````````` example
[ẞ]

[SS]: /url
.

ẞ

````````````````````````````````


Consecutive internal spaces, tabs, and line endings are treated as one space for
purposes of determining matching:

```````````````````````````````` example
[Foo
  bar]: /url

[Baz][Foo bar]
.

Baz

````````````````````````````````


No spaces, tabs, or line endings are allowed between the [link text] and the
[link label]:

```````````````````````````````` example
[foo] [bar]

[bar]: /url "title"
.

[foo] bar

````````````````````````````````


```````````````````````````````` example
[foo]
[bar]

[bar]: /url "title"
.

[foo]
bar

````````````````````````````````


This is a departure from John Gruber's original Markdown syntax
description, which explicitly allows whitespace between the link
text and the link label.  It brings reference links in line with
[inline links], which (according to both original Markdown and
this spec) cannot have whitespace after the link text.  More
importantly, it prevents inadvertent capture of consecutive
[shortcut reference links]. If whitespace is allowed between the
link text and the link label, then in the following we will have
a single reference link, not two shortcut reference links, as
intended:

``` markdown
[foo]
[bar]

[foo]: /url1
[bar]: /url2
```

(Note that [shortcut reference links] were introduced by Gruber
himself in a beta version of `Markdown.pl`, but never included
in the official syntax description.  Without shortcut reference
links, it is harmless to allow space between the link text and
link label; but once shortcut references are introduced, it is
too dangerous to allow this, as it frequently leads to
unintended results.)

When there are multiple matching [link reference definitions],
the first is used:

```````````````````````````````` example
[foo]: /url1

[foo]: /url2

[bar][foo]
.

bar

````````````````````````````````


Note that matching is performed on normalized strings, not parsed
inline content.  So the following does not match, even though the
labels define equivalent inline content:

```````````````````````````````` example
[bar][foo\!]

[foo!]: /url
.

[bar][foo!]

````````````````````````````````


[Link labels] cannot contain brackets, unless they are
backslash-escaped:

```````````````````````````````` example
[foo][ref[]

[ref[]: /uri
.

[foo][ref[]


[ref[]: /uri

````````````````````````````````


```````````````````````````````` example
[foo][ref[bar]]

[ref[bar]]: /uri
.

[foo][ref[bar]]


[ref[bar]]: /uri

````````````````````````````````


```````````````````````````````` example
[[[foo]]]

[[[foo]]]: /url
.

[[[foo]]]


[[[foo]]]: /url

````````````````````````````````


```````````````````````````````` example
[foo][ref\[]

[ref\[]: /uri
.

foo

````````````````````````````````


Note that in this example `]` is not backslash-escaped:

```````````````````````````````` example
[bar\\]: /uri

[bar\\]
.

bar\

````````````````````````````````


A [link label] must contain at least one character that is not a space, tab, or
line ending:

```````````````````````````````` example
[]

[]: /uri
.

[]


[]: /uri

````````````````````````````````


```````````````````````````````` example
[
 ]

[
 ]: /uri
.

[
]


[
]: /uri

````````````````````````````````


A [collapsed reference link](@)
consists of a [link label] that [matches] a
[link reference definition] elsewhere in the
document, followed by the string `[]`.
The contents of the link label are parsed as inlines,
which are used as the link's text.  The link's URI and title are
provided by the matching reference link definition.  Thus,
`[foo][]` is equivalent to `[foo][foo]`.

```````````````````````````````` example
[foo][]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
[*foo* bar][]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


The link labels are case-insensitive:

```````````````````````````````` example
[Foo][]

[foo]: /url "title"
.

Foo

````````````````````````````````



As with full reference links, spaces, tabs, or line endings are not
allowed between the two sets of brackets:

```````````````````````````````` example
[foo] 
[]

[foo]: /url "title"
.

foo
[]

````````````````````````````````


A [shortcut reference link](@)
consists of a [link label] that [matches] a
[link reference definition] elsewhere in the
document and is not followed by `[]` or a link label.
The contents of the link label are parsed as inlines,
which are used as the link's text.  The link's URI and title
are provided by the matching link reference definition.
Thus, `[foo]` is equivalent to `[foo][]`.

```````````````````````````````` example
[foo]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
[*foo* bar]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


```````````````````````````````` example
[[*foo* bar]]

[*foo* bar]: /url "title"
.

[foo bar]

````````````````````````````````


```````````````````````````````` example
[[bar [foo]

[foo]: /url
.

[[bar foo

````````````````````````````````


The link labels are case-insensitive:

```````````````````````````````` example
[Foo]

[foo]: /url "title"
.

Foo

````````````````````````````````


A space after the link text should be preserved:

```````````````````````````````` example
[foo] bar

[foo]: /url
.

foo bar

````````````````````````````````


If you just want bracketed text, you can backslash-escape the
opening bracket to avoid links:

```````````````````````````````` example
\[foo]

[foo]: /url "title"
.

[foo]

````````````````````````````````


Note that this is a link, because a link label ends with the first
following closing bracket:

```````````````````````````````` example
[foo*]: /url

*[foo*]
.

*foo*

````````````````````````````````


Full and collapsed references take precedence over shortcut
references:

```````````````````````````````` example
[foo][bar]

[foo]: /url1
[bar]: /url2
.

foo

````````````````````````````````

```````````````````````````````` example
[foo][]

[foo]: /url1
.

foo

````````````````````````````````

Inline links also take precedence:

```````````````````````````````` example
[foo]()

[foo]: /url1
.

foo

````````````````````````````````

```````````````````````````````` example
[foo](not a link)

[foo]: /url1
.

foo(not a link)

````````````````````````````````

In the following case `[bar][baz]` is parsed as a reference,
`[foo]` as normal text:

```````````````````````````````` example
[foo][bar][baz]

[baz]: /url
.

[foo]bar

````````````````````````````````


Here, though, `[foo][bar]` is parsed as a reference, since
`[bar]` is defined:

```````````````````````````````` example
[foo][bar][baz]

[baz]: /url1
[bar]: /url2
.

foobaz

````````````````````````````````


Here `[foo]` is not parsed as a shortcut reference, because it
is followed by a link label (even though `[bar]` is not defined):

```````````````````````````````` example
[foo][bar][baz]

[baz]: /url1
[foo]: /url2
.

[foo]bar

````````````````````````````````



## Images

Syntax for images is like the syntax for links, with one
difference. Instead of [link text], we have an
[image description](@).  The rules for this are the
same as for [link text], except that (a) an
image description starts with `![` rather than `[`, and
(b) an image description may contain links.
An image description has inline elements
as its contents.  When an image is rendered to HTML,
this is standardly used as the image's `alt` attribute.

```````````````````````````````` example
![foo](/url "title")
.

foo

````````````````````````````````


```````````````````````````````` example
![foo *bar*]

[foo *bar*]: train.jpg "train & tracks"
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo ![bar](/url)](/url2)
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo [bar](/url)](/url2)
.

foo bar

````````````````````````````````


Though this spec is concerned with parsing, not rendering, it is
recommended that in rendering to HTML, only the plain string content
of the [image description] be used.  Note that in
the above example, the alt attribute's value is `foo bar`, not `foo
[bar](/url)` or `foo bar`.  Only the plain string
content is rendered, without formatting.

```````````````````````````````` example
![foo *bar*][]

[foo *bar*]: train.jpg "train & tracks"
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo *bar*][foobar]

[FOOBAR]: train.jpg "train & tracks"
.

foo bar

````````````````````````````````


```````````````````````````````` example
![foo](train.jpg)
.

foo

````````````````````````````````


```````````````````````````````` example
My ![foo bar](/path/to/train.jpg  "title"   )
.

My foo bar

````````````````````````````````


```````````````````````````````` example
![foo]()
.

foo

````````````````````````````````


```````````````````````````````` example
![](/url)
.


````````````````````````````````


Reference-style:

```````````````````````````````` example
![foo][bar]

[bar]: /url
.

foo

````````````````````````````````


```````````````````````````````` example
![foo][bar]

[BAR]: /url
.

foo

````````````````````````````````


Collapsed:

```````````````````````````````` example
![foo][]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
![*foo* bar][]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


The labels are case-insensitive:

```````````````````````````````` example
![Foo][]

[foo]: /url "title"
.

Foo

````````````````````````````````


As with reference links, spaces, tabs, and line endings, are not allowed
between the two sets of brackets:

```````````````````````````````` example
![foo] 
[]

[foo]: /url "title"
.

foo
[]

````````````````````````````````


Shortcut:

```````````````````````````````` example
![foo]

[foo]: /url "title"
.

foo

````````````````````````````````


```````````````````````````````` example
![*foo* bar]

[*foo* bar]: /url "title"
.

foo bar

````````````````````````````````


Note that link labels cannot contain unescaped brackets:

```````````````````````````````` example
![[foo]]

[[foo]]: /url "title"
.

![[foo]]


[[foo]]: /url "title"

````````````````````````````````


The link labels are case-insensitive:

```````````````````````````````` example
![Foo]

[foo]: /url "title"
.

Foo

````````````````````````````````


If you just want a literal `!` followed by bracketed text, you can
backslash-escape the opening `[`:

```````````````````````````````` example
!\[foo]

[foo]: /url "title"
.

![foo]

````````````````````````````````


If you want a link after a literal `!`, backslash-escape the
`!`:

```````````````````````````````` example
\![foo]

[foo]: /url "title"
.

!foo

````````````````````````````````


## Autolinks

[Autolink](@)s are absolute URIs and email addresses inside
`<` and `>`. They are parsed as links, with the URL or email address
as the link label.

A [URI autolink](@) consists of `<`, followed by an
[absolute URI] followed by `>`.  It is parsed as
a link to the URI, with the URI as the link's label.

An [absolute URI](@),
for these purposes, consists of a [scheme] followed by a colon (`:`)
followed by zero or more characters other than [ASCII control
characters][ASCII control character], [space], `<`, and `>`.
If the URI includes these characters, they must be percent-encoded
(e.g. `%20` for a space).

For purposes of this spec, a [scheme](@) is any sequence
of 2--32 characters beginning with an ASCII letter and followed
by any combination of ASCII letters, digits, or the symbols plus
("+"), period ("."), or hyphen ("-").

Here are some valid autolinks:

```````````````````````````````` example

.

http://foo.bar.baz

````````````````````````````````


```````````````````````````````` example

.

https://foo.bar.baz/test?q=hello&id=22&boolean

````````````````````````````````


```````````````````````````````` example

.

irc://foo.bar:2233/baz

````````````````````````````````


Uppercase is also fine:

```````````````````````````````` example

.

MAILTO:FOO@BAR.BAZ

````````````````````````````````


Note that many strings that count as [absolute URIs] for
purposes of this spec are not valid URIs, because their
schemes are not registered or because of other problems
with their syntax:

```````````````````````````````` example

.

a+b+c:d

````````````````````````````````


```````````````````````````````` example

.

made-up-scheme://foo,bar

````````````````````````````````


```````````````````````````````` example

.

https://../

````````````````````````````````


```````````````````````````````` example

.

localhost:5001/foo

````````````````````````````````


Spaces are not allowed in autolinks:

```````````````````````````````` example

.

<https://foo.bar/baz bim>

````````````````````````````````


Backslash-escapes do not work inside autolinks:

```````````````````````````````` example

.

https://example.com/\[\

````````````````````````````````


An [email autolink](@)
consists of `<`, followed by an [email address],
followed by `>`.  The link's label is the email address,
and the URL is `mailto:` followed by the email address.

An [email address](@),
for these purposes, is anything that matches
the [non-normative regex from the HTML5
spec](https://html.spec.whatwg.org/multipage/forms.html#e-mail-state-(type=email)):

    /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?
    (?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/

Examples of email autolinks:

```````````````````````````````` example

.

foo@bar.example.com

````````````````````````````````


```````````````````````````````` example

.

foo+special@Bar.baz-bar0.com

````````````````````````````````


Backslash-escapes do not work inside email autolinks:

```````````````````````````````` example

.

<foo+@bar.example.com>

````````````````````````````````


These are not autolinks:

```````````````````````````````` example
<>
.

<>

````````````````````````````````


```````````````````````````````` example
< https://foo.bar >
.

< https://foo.bar >

````````````````````````````````


```````````````````````````````` example

.

<m:abc>

````````````````````````````````


```````````````````````````````` example

.

<foo.bar.baz>

````````````````````````````````


```````````````````````````````` example
https://example.com
.

https://example.com

````````````````````````````````


```````````````````````````````` example
foo@bar.example.com
.

foo@bar.example.com

````````````````````````````````


## Raw HTML

Text between `<` and `>` that looks like an HTML tag is parsed as a
raw HTML tag and will be rendered in HTML without escaping.
Tag and attribute names are not limited to current HTML tags,
so custom tags (and even, say, DocBook tags) may be used.

Here is the grammar for tags:

A [tag name](@) consists of an ASCII letter
followed by zero or more ASCII letters, digits, or
hyphens (`-`).

An [attribute](@) consists of spaces, tabs, and up to one line ending,
an [attribute name], and an optional
[attribute value specification].

An [attribute name](@)
consists of an ASCII letter, `_`, or `:`, followed by zero or more ASCII
letters, digits, `_`, `.`, `:`, or `-`.  (Note:  This is the XML
specification restricted to ASCII.  HTML5 is laxer.)

An [attribute value specification](@)
consists of optional spaces, tabs, and up to one line ending,
a `=` character, optional spaces, tabs, and up to one line ending,
and an [attribute value].

An [attribute value](@)
consists of an [unquoted attribute value],
a [single-quoted attribute value], or a [double-quoted attribute value].

An [unquoted attribute value](@)
is a nonempty string of characters not
including spaces, tabs, line endings, `"`, `'`, `=`, `<`, `>`, or `` ` ``.

A [single-quoted attribute value](@)
consists of `'`, zero or more
characters not including `'`, and a final `'`.

A [double-quoted attribute value](@)
consists of `"`, zero or more
characters not including `"`, and a final `"`.

An [open tag](@) consists of a `<` character, a [tag name],
zero or more [attributes], optional spaces, tabs, and up to one line ending,
an optional `/` character, and a `>` character.

A [closing tag](@) consists of the string ``.

An [HTML comment](@) consists of ``, ``, or  ``, and `-->` (see the
[HTML spec](https://html.spec.whatwg.org/multipage/parsing.html#markup-declaration-open-state)).

A [processing instruction](@)
consists of the string ``, and the string
`?>`.

A [declaration](@) consists of the string ``, and the character `>`.

A [CDATA section](@) consists of
the string ``, and the string `]]>`.

An [HTML tag](@) consists of an [open tag], a [closing tag],
an [HTML comment], a [processing instruction], a [declaration],
or a [CDATA section].

Here are some simple open tags:

```````````````````````````````` example

.


````````````````````````````````


Empty elements:

```````````````````````````````` example

.


````````````````````````````````


Whitespace is allowed:

```````````````````````````````` example

.


````````````````````````````````


With attributes:

```````````````````````````````` example

.


````````````````````````````````


Custom tag names can be used:

```````````````````````````````` example
Foo 
.

Foo 

````````````````````````````````


Illegal tag names, not parsed as HTML:

```````````````````````````````` example
<33> <__>
.

<33> <__>

````````````````````````````````


Illegal attribute names:

```````````````````````````````` example

.

<a h*#ref="hi">

````````````````````````````````


Illegal attribute values:

```````````````````````````````` example

.

</a href="foo">

````````````````````````````````


Comments:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````

```````````````````````````````` example
foo  foo -->

foo  foo -->
.

foo  foo -->


foo  foo -->

````````````````````````````````


Processing instructions:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


Declarations:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


CDATA sections:

```````````````````````````````` example
foo &<]]>
.

foo &<]]>

````````````````````````````````


Entity and numeric character references are preserved in HTML
attributes:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


Backslash escapes do not work in HTML attributes:

```````````````````````````````` example
foo 
.

foo 

````````````````````````````````


```````````````````````````````` example

.

<a href=""">

````````````````````````````````


## Hard line breaks

A line ending (not in a code span or HTML tag) that is preceded
by two or more spaces and does not occur at the end of a block
is parsed as a [hard line break](@) (rendered
in HTML as a `
` tag):

```````````````````````````````` example
foo  
baz
.

foo

baz

````````````````````````````````


For a more visible alternative, a backslash before the
[line ending] may be used instead of two or more spaces:

```````````````````````````````` example
foo\
baz
.

foo

baz

````````````````````````````````


More than two spaces can be used:

```````````````````````````````` example
foo       
baz
.

foo

baz

````````````````````````````````


Leading spaces at the beginning of the next line are ignored:

```````````````````````````````` example
foo  
     bar
.

foo

bar

````````````````````````````````


```````````````````````````````` example
foo\
     bar
.

foo

bar

````````````````````````````````


Hard line breaks can occur inside emphasis, links, and other constructs
that allow inline content:

```````````````````````````````` example
*foo  
bar*
.

foo

bar

````````````````````````````````


```````````````````````````````` example
*foo\
bar*
.

foo

bar

````````````````````````````````


Hard line breaks do not occur inside code spans

```````````````````````````````` example
`code  
span`
.

code   span

````````````````````````````````


```````````````````````````````` example
`code\
span`
.

code\ span

````````````````````````````````


or HTML tags:

```````````````````````````````` example

.


````````````````````````````````


```````````````````````````````` example

.


````````````````````````````````


Hard line breaks are for separating inline content within a block.
Neither syntax for hard line breaks works at the end of a paragraph or
other block element:

```````````````````````````````` example
foo\
.

foo\

````````````````````````````````


```````````````````````````````` example
foo  
.

foo

````````````````````````````````


```````````````````````````````` example
### foo\
.

foo\

````````````````````````````````


```````````````````````````````` example
### foo  
.

foo

````````````````````````````````


## Soft line breaks

A regular line ending (not in a code span or HTML tag) that is not
preceded by two or more spaces or a backslash is parsed as a
[softbreak](@).  (A soft line break may be rendered in HTML either as a
[line ending] or as a space. The result will be the same in
browsers. In the examples here, a [line ending] will be used.)

```````````````````````````````` example
foo
baz
.

foo
baz

````````````````````````````````


Spaces at the end of the line and beginning of the next line are
removed:

```````````````````````````````` example
foo 
 baz
.

foo
baz

````````````````````````````````


A conforming parser may render a soft line break in HTML either as a
line ending or as a space.

A renderer may also provide an option to render soft line breaks
as hard line breaks.

## Textual content

Any characters not given an interpretation by the above rules will
be parsed as plain textual content.

```````````````````````````````` example
hello $.;'there
.

hello $.;'there

````````````````````````````````


```````````````````````````````` example
Foo χρῆν
.

Foo χρῆν

````````````````````````````````


Internal spaces are preserved verbatim:

```````````````````````````````` example
Multiple     spaces
.

Multiple     spaces

````````````````````````````````




# Appendix: A parsing strategy

In this appendix we describe some features of the parsing strategy
used in the CommonMark reference implementations.

## Overview

Parsing has two phases:

1. In the first phase, lines of input are consumed and the block
structure of the document---its division into paragraphs, block quotes,
list items, and so on---is constructed.  Text is assigned to these
blocks but not parsed. Link reference definitions are parsed and a
map of links is constructed.

2. In the second phase, the raw text contents of paragraphs and headings
are parsed into sequences of Markdown inline elements (strings,
code spans, links, emphasis, and so on), using the map of link
references constructed in phase 1.

At each point in processing, the document is represented as a tree of
**blocks**.  The root of the tree is a `document` block.  The `document`
may have any number of other blocks as **children**.  These children
may, in turn, have other blocks as children.  The last child of a block
is normally considered **open**, meaning that subsequent lines of input
can alter its contents.  (Blocks that are not open are **closed**.)
Here, for example, is a possible document tree, with the open blocks
marked by arrows:

``` tree
-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
         list_item
           paragraph
             "Qui *quodsi iracundia*"
      -> list_item
        -> paragraph
             "aliquando id"
```

## Phase 1: block structure

Each line that is processed has an effect on this tree.  The line is
analyzed and, depending on its contents, the document may be altered
in one or more of the following ways:

1. One or more open blocks may be closed.
2. One or more new blocks may be created as children of the
   last open block.
3. Text may be added to the last (deepest) open block remaining
   on the tree.

Once a line has been incorporated into the tree in this way,
it can be discarded, so input can be read in a stream.

For each line, we follow this procedure:

1. First we iterate through the open blocks, starting with the
root document, and descending through last children down to the last
open block.  Each block imposes a condition that the line must satisfy
if the block is to remain open.  For example, a block quote requires a
`>` character.  A paragraph requires a non-blank line.
In this phase we may match all or just some of the open
blocks.  But we cannot close unmatched blocks yet, because we may have a
[lazy continuation line].

2.  Next, after consuming the continuation markers for existing
blocks, we look for new block starts (e.g. `>` for a block quote).
If we encounter a new block start, we close any blocks unmatched
in step 1 before creating the new block as a child of the last
matched container block.

3.  Finally, we look at the remainder of the line (after block
markers like `>`, list markers, and indentation have been consumed).
This is text that can be incorporated into the last open
block (a paragraph, code block, heading, or raw HTML).

Setext headings are formed when we see a line of a paragraph
that is a [setext heading underline].

Reference link definitions are detected when a paragraph is closed;
the accumulated text lines are parsed to see if they begin with
one or more reference link definitions.  Any remainder becomes a
normal paragraph.

We can see how this works by considering how the tree above is
generated by four lines of Markdown:

``` markdown
> Lorem ipsum dolor
sit amet.
> - Qui *quodsi iracundia*
> - aliquando id
```

At the outset, our document model is just

``` tree
-> document
```

The first line of our text,

``` markdown
> Lorem ipsum dolor
```

causes a `block_quote` block to be created as a child of our
open `document` block, and a `paragraph` block as a child of
the `block_quote`.  Then the text is added to the last open
block, the `paragraph`:

``` tree
-> document
  -> block_quote
    -> paragraph
         "Lorem ipsum dolor"
```

The next line,

``` markdown
sit amet.
```

is a "lazy continuation" of the open `paragraph`, so it gets added
to the paragraph's text:

``` tree
-> document
  -> block_quote
    -> paragraph
         "Lorem ipsum dolor\nsit amet."
```

The third line,

``` markdown
> - Qui *quodsi iracundia*
```

causes the `paragraph` block to be closed, and a new `list` block
opened as a child of the `block_quote`.  A `list_item` is also
added as a child of the `list`, and a `paragraph` as a child of
the `list_item`.  The text is then added to the new `paragraph`:

``` tree
-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
      -> list_item
        -> paragraph
             "Qui *quodsi iracundia*"
```

The fourth line,

``` markdown
> - aliquando id
```

causes the `list_item` (and its child the `paragraph`) to be closed,
and a new `list_item` opened up as child of the `list`.  A `paragraph`
is added as a child of the new `list_item`, to contain the text.
We thus obtain the final tree:

``` tree
-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
         list_item
           paragraph
             "Qui *quodsi iracundia*"
      -> list_item
        -> paragraph
             "aliquando id"
```

## Phase 2: inline structure

Once all of the input has been parsed, all open blocks are closed.

We then "walk the tree," visiting every node, and parse raw
string contents of paragraphs and headings as inlines.  At this
point we have seen all the link reference definitions, so we can
resolve reference links as we go.

``` tree
document
  block_quote
    paragraph
      str "Lorem ipsum dolor"
      softbreak
      str "sit amet."
    list (type=bullet tight=true bullet_char=-)
      list_item
        paragraph
          str "Qui "
          emph
            str "quodsi iracundia"
      list_item
        paragraph
          str "aliquando id"
```

Notice how the [line ending] in the first paragraph has
been parsed as a `softbreak`, and the asterisks in the first list item
have become an `emph`.

### An algorithm for parsing nested emphasis and links

By far the trickiest part of inline parsing is handling emphasis,
strong emphasis, links, and images.  This is done using the following
algorithm.

When we're parsing inlines and we hit either

- a run of `*` or `_` characters, or
- a `[` or `![`

we insert a text node with these symbols as its literal content, and we
add a pointer to this text node to the [delimiter stack](@).

The [delimiter stack] is a doubly linked list.  Each
element contains a pointer to a text node, plus information about

- the type of delimiter (`[`, `![`, `*`, `_`)
- the number of delimiters,
- whether the delimiter is "active" (all are active to start), and
- whether the delimiter is a potential opener, a potential closer,
  or both (which depends on what sort of characters precede
  and follow the delimiters).

When we hit a `]` character, we call the *look for link or image*
procedure (see below).

When we hit the end of the input, we call the *process emphasis*
procedure (see below), with `stack_bottom` = NULL.

#### *look for link or image*

Starting at the top of the delimiter stack, we look backwards
through the stack for an opening `[` or `![` delimiter.

- If we don't find one, we return a literal text node `]`.

- If we do find one, but it's not *active*, we remove the inactive
  delimiter from the stack, and return a literal text node `]`.

- If we find one and it's active, then we parse ahead to see if
  we have an inline link/image, reference link/image, collapsed reference
  link/image, or shortcut reference link/image.

  + If we don't, then we remove the opening delimiter from the
    delimiter stack and return a literal text node `]`.

  + If we do, then

    * We return a link or image node whose children are the inlines
      after the text node pointed to by the opening delimiter.

    * We run *process emphasis* on these inlines, with the `[` opener
      as `stack_bottom`.

    * We remove the opening delimiter.

    * If we have a link (and not an image), we also set all
      `[` delimiters before the opening delimiter to *inactive*.  (This
      will prevent us from getting links within links.)

#### *process emphasis*

Parameter `stack_bottom` sets a lower bound to how far we
descend in the [delimiter stack].  If it is NULL, we can
go all the way to the bottom.  Otherwise, we stop before
visiting `stack_bottom`.

Let `current_position` point to the element on the [delimiter stack]
just above `stack_bottom` (or the first element if `stack_bottom`
is NULL).

We keep track of the `openers_bottom` for each delimiter
type (`*`, `_`), indexed to the length of the closing delimiter run
(modulo 3) and to whether the closing delimiter can also be an
opener.  Initialize this to `stack_bottom`.

Then we repeat the following until we run out of potential
closers:

- Move `current_position` forward in the delimiter stack (if needed)
  until we find the first potential closer with delimiter `*` or `_`.
  (This will be the potential closer closest
  to the beginning of the input -- the first one in parse order.)

- Now, look back in the stack (staying above `stack_bottom` and
  the `openers_bottom` for this delimiter type) for the
  first matching potential opener ("matching" means same delimiter).

- If one is found:

  + Figure out whether we have emphasis or strong emphasis:
    if both closer and opener spans have length >= 2, we have
    strong, otherwise regular.

  + Insert an emph or strong emph node accordingly, after
    the text node corresponding to the opener.

  + Remove any delimiters between the opener and closer from
    the delimiter stack.

  + Remove 1 (for regular emph) or 2 (for strong emph) delimiters
    from the opening and closing text nodes.  If they become empty
    as a result, remove them and remove the corresponding element
    of the delimiter stack.  If the closing node is removed, reset
    `current_position` to the next element in the stack.

- If none is found:

  + Set `openers_bottom` to the element before `current_position`.
    (We know that there are no openers for this kind of closer up to and
    including this point, so this puts a lower bound on future searches.)

  + If the closer at `current_position` is not a potential opener,
    remove it from the delimiter stack (since we know it can't
    be a closer either).

  + Advance `current_position` to the next element in the stack.

After we're done, we remove all delimiters above `stack_bottom` from the
delimiter stack.
markdown-it-py-4.2.0/tests/test_cmark_spec/test_spec.py000066400000000000000000000020441517710005200232500ustar00rootroot00000000000000"""In this module tests are run against the full test set,
provided by https://github.com/commonmark/CommonMark.git.
"""

import json
from pathlib import Path

import pytest

from markdown_it import MarkdownIt

SPEC_INPUT = Path(__file__).parent.joinpath("spec.md")
TESTS_INPUT = Path(__file__).parent.joinpath("commonmark.json")


def test_file(file_regression):
    md = MarkdownIt("commonmark")
    file_regression.check(md.render(SPEC_INPUT.read_text()), extension=".html")


@pytest.mark.parametrize("entry", json.loads(TESTS_INPUT.read_text()))
def test_spec(entry):
    md = MarkdownIt("commonmark")
    output = md.render(entry["markdown"])
    expected = entry["html"]

    if entry["example"] == 596:
        # this doesn't have any bearing on the output
        output = output.replace("mailto", "MAILTO")
    if entry["example"] in [218, 239, 240]:
        # this doesn't have any bearing on the output
        output = output.replace(
            "
", "
\n
"
        )

    assert output == expected
markdown-it-py-4.2.0/tests/test_cmark_spec/test_spec/000077500000000000000000000000001517710005200226765ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_cmark_spec/test_spec/test_file.html000066400000000000000000006761361517710005200255650ustar00rootroot00000000000000


title: CommonMark Spec
author: John MacFarlane
version: '0.31.2'
date: '2024-01-28'
license: 'CC-BY-SA 4.0'
...


Introduction


What is Markdown?


Markdown is a plain text format for writing structured documents,
based on conventions for indicating formatting in email
and usenet posts.  It was developed by John Gruber (with
help from Aaron Swartz) and released in 2004 in the form of a
syntax description
and a Perl script (Markdown.pl) for converting Markdown to
HTML.  In the next decade, dozens of implementations were
developed in many languages.  Some extended the original
Markdown syntax with conventions for footnotes, tables, and
other document elements.  Some allowed Markdown documents to be
rendered in formats other than HTML.  Websites like Reddit,
StackOverflow, and GitHub had millions of people using Markdown.
And Markdown started to be used beyond the web, to author books,
articles, slide shows, letters, and lecture notes.


What distinguishes Markdown from many other lightweight markup
syntaxes, which are often easier to write, is its readability.
As Gruber writes:




The overriding design goal for Markdown's formatting syntax is
to make it as readable as possible. The idea is that a
Markdown-formatted document should be publishable as-is, as
plain text, without looking like it's been marked up with tags
or formatting instructions.
(https://daringfireball.net/projects/markdown/)




The point can be illustrated by comparing a sample of
AsciiDoc with
an equivalent sample of Markdown.  Here is a sample of
AsciiDoc from the AsciiDoc manual:


1. List item one.
+
List item one continued with a second paragraph followed by an
Indented block.
+
.................
$ ls *.sh
$ mv *.sh ~/tmp
.................
+
List item continued with a third paragraph.

2. List item two continued with an open block.
+
--
This paragraph is part of the preceding list item.

a. This list is nested and does not require explicit item
continuation.
+
This paragraph is part of the preceding list item.

b. List item b.

This paragraph belongs to item two of the outer list.
--



And here is the equivalent in Markdown:


1.  List item one.

    List item one continued with a second paragraph followed by an
    Indented block.

        $ ls *.sh
        $ mv *.sh ~/tmp

    List item continued with a third paragraph.

2.  List item two continued with an open block.

    This paragraph is part of the preceding list item.

    1. This list is nested and does not require explicit item continuation.

       This paragraph is part of the preceding list item.

    2. List item b.

    This paragraph belongs to item two of the outer list.



The AsciiDoc version is, arguably, easier to write. You don't need
to worry about indentation.  But the Markdown version is much easier
to read.  The nesting of list items is apparent to the eye in the
source, not just in the processed document.


Why is a spec needed?


John Gruber's canonical description of Markdown's
syntax
does not specify the syntax unambiguously.  Here are some examples of
questions it does not answer:


    

  1. 

    How much indentation is needed for a sublist?  The spec says that
continuation paragraphs need to be indented four spaces, but is
not fully explicit about sublists.  It is natural to think that
they, too, must be indented four spaces, but Markdown.pl does
not require that.  This is hardly a "corner case," and divergences
between implementations on this issue often lead to surprises for
users in real documents. (See this comment by John
Gruber.)
    

    2. 

  2. 

    Is a blank line needed before a block quote or heading?
Most implementations do not require the blank line.  However,
this can lead to unexpected results in hard-wrapped text, and
also to ambiguities in parsing (note that some implementations
put the heading inside the blockquote, while others do not).
(John Gruber has also spoken in favor of requiring the blank
lines.)
    

    3. 

  3. 

    Is a blank line needed before an indented code block?
(Markdown.pl requires it, but this is not mentioned in the
documentation, and some implementations do not require it.)
    

    paragraph
    code?

    

    4. 

  4. 

    What is the exact rule for determining when list items get
wrapped in <p> tags?  Can a list be partially "loose" and partially
"tight"?  What should we do with a list like this?
    

    1. one

2. two
3. three

    

    Or this?
    

    1.  one
    - a

    - b
2.  two

    

    (There are some relevant comments by John Gruber
here.)
    

    5. 

  5. 

    Can list markers be indented?  Can ordered list markers be right-aligned?
    

     8. item 1
 9. item 2
10. item 2a

    

    6. 

  6. 

    Is this one list with a thematic break in its second item,
or two lists separated by a thematic break?
    

    * a
* * * * *
* b

    

    7. 

  7. 

    When list markers change from numbers to bullets, do we have
two lists or one?  (The Markdown syntax description suggests two,
but the perl scripts and many other implementations produce one.)
    

    1. fee
2. fie
-  foe
-  fum

    

    8. 

  8. 

    What are the precedence rules for the markers of inline structure?
For example, is the following a valid link, or does the code span
take precedence ?
    

    [a backtick (`)](/url) and [another backtick (`)](/url).

    

    9. 

  9. 

    What are the precedence rules for markers of emphasis and strong
emphasis?  For example, how should the following be parsed?
    

    *foo *bar* baz*

    

    10. 

  10. 

    What are the precedence rules between block-level and inline-level
structure?  For example, how should the following be parsed?
    

    - `a long code span can contain a hyphen like this
  - and it can screw things up`

    

    11. 

  11. 

    Can list items include section headings?  (Markdown.pl does not
allow this, but does allow blockquotes to include headings.)
    

    - # Heading

    

    12. 

  12. 

    Can list items be empty?
    

    * a
*
* b

    

    13. 

  13. 

    Can link references be defined inside block quotes or list items?
    

    > Blockquote [foo].
>
> [foo]: /url

    

    14. 

  14. 

    If there are multiple definitions for the same reference, which takes
precedence?
    

    [foo]: /url1
[foo]: /url2

[foo][]

    

    15. 



In the absence of a spec, early implementers consulted Markdown.pl
to resolve these ambiguities.  But Markdown.pl was quite buggy, and
gave manifestly bad results in many cases, so it was not a
satisfactory replacement for a spec.


Because there is no unambiguous spec, implementations have diverged
considerably.  As a result, users are often surprised to find that
a document that renders one way on one system (say, a GitHub wiki)
renders differently on another (say, converting to docbook using
pandoc).  To make matters worse, because nothing in Markdown counts
as a "syntax error," the divergence often isn't discovered right away.


About this document


This document attempts to specify Markdown syntax unambiguously.
It contains many examples with side-by-side Markdown and
HTML.  These are intended to double as conformance tests.  An
accompanying script spec_tests.py can be used to run the tests
against any Markdown program:


python test/spec_tests.py --spec spec.txt --program PROGRAM



Since this document describes how Markdown is to be parsed into
an abstract syntax tree, it would have made sense to use an abstract
representation of the syntax tree instead of HTML.  But HTML is capable
of representing the structural distinctions we need to make, and the
choice of HTML for the tests makes it possible to run the tests against
an implementation without writing an abstract syntax tree renderer.


Note that not every feature of the HTML samples is mandated by
the spec.  For example, the spec says what counts as a link
destination, but it doesn't mandate that non-ASCII characters in
the URL be percent-encoded.  To use the automatic tests,
implementers will need to provide a renderer that conforms to
the expectations of the spec examples (percent-encoding
non-ASCII characters in URLs).  But a conforming implementation
can use a different renderer and may choose not to
percent-encode non-ASCII characters in URLs.


This document is generated from a text file, spec.txt, written
in Markdown with a small extension for the side-by-side tests.
The script tools/makespec.py can be used to convert spec.txt into
HTML or CommonMark (which can then be converted into other formats).


In the examples, the → character is used to represent tabs.


Preliminaries


Characters and lines


Any sequence of [characters] is a valid CommonMark
document.


A character is a Unicode code point.  Although some
code points (for example, combining accents) do not correspond to
characters in an intuitive sense, all code points count as characters
for purposes of this spec.


This spec does not specify an encoding; it thinks of lines as composed
of [characters] rather than bytes.  A conforming parser may be limited
to a certain encoding.


A line is a sequence of zero or more [characters]
other than line feed (U+000A) or carriage return (U+000D),
followed by a [line ending] or by the end of file.


A line ending is a line feed (U+000A), a carriage return
(U+000D) not followed by a line feed, or a carriage return and a
following line feed.


A line containing no characters, or a line containing only spaces
(U+0020) or tabs (U+0009), is called a blank line.


The following definitions of character classes will be used in this spec:


A Unicode whitespace character is a character in the Unicode Zs general
category, or a tab (U+0009), line feed (U+000A), form feed (U+000C), or
carriage return (U+000D).


Unicode whitespace is a sequence of one or more
[Unicode whitespace characters].


A tab is U+0009.


A space is U+0020.


An ASCII control character is a character between U+0000–1F (both
including) or U+007F.


An ASCII punctuation character
is !, ", #, $, %, &, ', (, ),
*, +, ,, -, ., / (U+0021–2F),
:, ;, <, =, >, ?, @ (U+003A–0040),
[, \, ], ^, _, ` (U+005B–0060),
{, |, }, or ~ (U+007B–007E).


A Unicode punctuation character is a character in the Unicode P
(puncuation) or S (symbol) general categories.


Tabs


Tabs in lines are not expanded to [spaces].  However,
in contexts where spaces help to define block structure,
tabs behave as if they were replaced by spaces with a tab stop
of 4 characters.


Thus, for example, a tab can be used instead of four spaces
in an indented code block.  (Note, however, that internal
tabs are passed through as literal tabs, not expanded to
spaces.)


→foo→baz→→bim
.
<pre><code>foo→baz→→bim
</code></pre>



  →foo→baz→→bim
.
<pre><code>foo→baz→→bim
</code></pre>



    a→a
    ὐ→a
.
<pre><code>a→a
ὐ→a
</code></pre>



In the following example, a continuation paragraph of a list
item is indented with a tab; this has exactly the same effect
as indentation with four spaces would:


  - foo

→bar
.
<ul>
<li>
<p>foo</p>
<p>bar</p>
</li>
</ul>



- foo

→→bar
.
<ul>
<li>
<p>foo</p>
<pre><code>  bar
</code></pre>
</li>
</ul>



Normally the > that begins a block quote may be followed
optionally by a space, which is not considered part of the
content.  In the following case > is followed by a tab,
which is treated as if it were expanded into three spaces.
Since one of these spaces is considered part of the
delimiter, foo is considered to be indented six spaces
inside the block quote context, so we get an indented
code block starting with two spaces.


>→→foo
.
<blockquote>
<pre><code>  foo
</code></pre>
</blockquote>



-→→foo
.
<ul>
<li>
<pre><code>  foo
</code></pre>
</li>
</ul>



    foo
→bar
.
<pre><code>foo
bar
</code></pre>



 - foo
   - bar
→ - baz
.
<ul>
<li>foo
<ul>
<li>bar
<ul>
<li>baz</li>
</ul>
</li>
</ul>
</li>
</ul>



#→Foo
.
<h1>Foo</h1>



*→*→*→
.
<hr />



Insecure characters


For security reasons, the Unicode character U+0000 must be replaced
with the REPLACEMENT CHARACTER (U+FFFD).


Backslash escapes


Any ASCII punctuation character may be backslash-escaped:


\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~
.
<p>!&quot;#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~</p>



Backslashes before other characters are treated as literal
backslashes:


\→\A\a\ \3\φ\«
.
<p>\→\A\a\ \3\φ\«</p>



Escaped characters are treated as regular characters and do
not have their usual Markdown meanings:


\*not emphasized*
\<br/> not a tag
\[not a link](/foo)
\`not code`
1\. not a list
\* not a list
\# not a heading
\[foo]: /url "not a reference"
\&ouml; not a character entity
.
<p>*not emphasized*
&lt;br/&gt; not a tag
[not a link](/foo)
`not code`
1. not a list
* not a list
# not a heading
[foo]: /url &quot;not a reference&quot;
&amp;ouml; not a character entity</p>



If a backslash is itself escaped, the following character is not:


\\*emphasis*
.
<p>\<em>emphasis</em></p>



A backslash at the end of the line is a [hard line break]:


foo\
bar
.
<p>foo<br />
bar</p>



Backslash escapes do not work in code blocks, code spans, autolinks, or
raw HTML:


`` \[\` ``
.
<p><code>\[\`</code></p>



    \[\]
.
<pre><code>\[\]
</code></pre>



~~~
\[\]
~~~
.
<pre><code>\[\]
</code></pre>



<https://example.com?find=\*>
.
<p><a href="https://example.com?find=%5C*">https://example.com?find=\*</a></p>



<a href="/bar\/)">
.
<a href="/bar\/)">



But they work in all other contexts, including URLs and link titles,
link references, and [info strings] in [fenced code blocks]:


[foo](/bar\* "ti\*tle")
.
<p><a href="/bar*" title="ti*tle">foo</a></p>



[foo]

[foo]: /bar\* "ti\*tle"
.
<p><a href="/bar*" title="ti*tle">foo</a></p>



``` foo\+bar
foo
```
.
<pre><code class="language-foo+bar">foo
</code></pre>



Entity and numeric character references


Valid HTML entity references and numeric character references
can be used in place of the corresponding Unicode character,
with the following exceptions:


    

  • 

    Entity and character references are not recognized in code
blocks and code spans.
    

    • 

  • 

    Entity and character references cannot stand in place of
special characters that define structural elements in
CommonMark.  For example, although &#42; can be used
in place of a literal * character, &#42; cannot replace
* in emphasis delimiters, bullet list markers, or thematic
breaks.
    

    • 



Conforming CommonMark parsers need not store information about
whether a particular character was represented in the source
using a Unicode character or an entity reference.


Entity references consist of & + any of the valid
HTML5 entity names + ;. The
document https://html.spec.whatwg.org/entities.json
is used as an authoritative source for the valid entity
references and their corresponding code points.


&nbsp; &amp; &copy; &AElig; &Dcaron;
&frac34; &HilbertSpace; &DifferentialD;
&ClockwiseContourIntegral; &ngE;
.
<p>  &amp; © Æ Ď
¾ ℋ ⅆ
∲ ≧̸</p>



Decimal numeric character
references
consist of &# + a string of 1--7 arabic digits + ;. A
numeric character reference is parsed as the corresponding
Unicode character. Invalid Unicode code points will be replaced by
the REPLACEMENT CHARACTER (U+FFFD).  For security reasons,
the code point U+0000 will also be replaced by U+FFFD.


&#35; &#1234; &#992; &#0;
.
<p># Ӓ Ϡ �</p>



Hexadecimal numeric character
references consist of &# +
either X or x + a string of 1-6 hexadecimal digits + ;.
They too are parsed as the corresponding Unicode character (this
time specified with a hexadecimal numeral instead of decimal).


&#X22; &#XD06; &#xcab;
.
<p>&quot; ആ ಫ</p>



Here are some nonentities:


&nbsp &x; &#; &#x;
&#87654321;
&#abcdef0;
&ThisIsNotDefined; &hi?;
.
<p>&amp;nbsp &amp;x; &amp;#; &amp;#x;
&amp;#87654321;
&amp;#abcdef0;
&amp;ThisIsNotDefined; &amp;hi?;</p>



Although HTML5 does accept some entity references
without a trailing semicolon (such as &copy), these are not
recognized here, because it makes the grammar too ambiguous:


&copy
.
<p>&amp;copy</p>



Strings that are not on the list of HTML5 named entities are not
recognized as entity references either:


&MadeUpEntity;
.
<p>&amp;MadeUpEntity;</p>



Entity and numeric character references are recognized in any
context besides code spans or code blocks, including
URLs, [link titles], and [fenced code block][] [info strings]:


<a href="&ouml;&ouml;.html">
.
<a href="&ouml;&ouml;.html">



[foo](/f&ouml;&ouml; "f&ouml;&ouml;")
.
<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p>



[foo]

[foo]: /f&ouml;&ouml; "f&ouml;&ouml;"
.
<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p>



``` f&ouml;&ouml;
foo
```
.
<pre><code class="language-föö">foo
</code></pre>



Entity and numeric character references are treated as literal
text in code spans and code blocks:


`f&ouml;&ouml;`
.
<p><code>f&amp;ouml;&amp;ouml;</code></p>



    f&ouml;f&ouml;
.
<pre><code>f&amp;ouml;f&amp;ouml;
</code></pre>



Entity and numeric character references cannot be used
in place of symbols indicating structure in CommonMark
documents.


&#42;foo&#42;
*foo*
.
<p>*foo*
<em>foo</em></p>



&#42; foo

* foo
.
<p>* foo</p>
<ul>
<li>foo</li>
</ul>



foo&#10;&#10;bar
.
<p>foo

bar</p>



&#9;foo
.
<p>→foo</p>



[a](url &quot;tit&quot;)
.
<p>[a](url &quot;tit&quot;)</p>



Blocks and inlines


We can think of a document as a sequence of
blocks---structural elements like paragraphs, block
quotations, lists, headings, rules, and code blocks.  Some blocks (like
block quotes and list items) contain other blocks; others (like
headings and paragraphs) contain inline content---text,
links, emphasized text, images, code spans, and so on.


Precedence


Indicators of block structure always take precedence over indicators
of inline structure.  So, for example, the following is a list with
two items, not a list with one item containing a code span:


- `one
- two`
.
<ul>
<li>`one</li>
<li>two`</li>
</ul>



This means that parsing can proceed in two steps:  first, the block
structure of the document can be discerned; second, text lines inside
paragraphs, headings, and other block constructs can be parsed for inline
structure.  The second step requires information about link reference
definitions that will be available only at the end of the first
step.  Note that the first step requires processing lines in sequence,
but the second can be parallelized, since the inline parsing of
one block element does not affect the inline parsing of any other.


Container blocks and leaf blocks


We can divide blocks into two types:
container blocks,
which can contain other blocks, and leaf blocks,
which cannot.


Leaf blocks


This section describes the different kinds of leaf block that make up a
Markdown document.


Thematic breaks


A line consisting of optionally up to three spaces of indentation, followed by a
sequence of three or more matching -, _, or * characters, each followed
optionally by any number of spaces or tabs, forms a
thematic break.


***
---
___
.
<hr />
<hr />
<hr />



Wrong characters:


+++
.
<p>+++</p>



===
.
<p>===</p>



Not enough characters:


--
**
__
.
<p>--
**
__</p>



Up to three spaces of indentation are allowed:


 ***
  ***
   ***
.
<hr />
<hr />
<hr />



Four spaces of indentation is too many:


    ***
.
<pre><code>***
</code></pre>



Foo
    ***
.
<p>Foo
***</p>



More than three characters may be used:


_____________________________________
.
<hr />



Spaces and tabs are allowed between the characters:


 - - -
.
<hr />



 **  * ** * ** * **
.
<hr />



-     -      -      -
.
<hr />



Spaces and tabs are allowed at the end:


- - - -    
.
<hr />



However, no other characters may occur in the line:


_ _ _ _ a

a------

---a---
.
<p>_ _ _ _ a</p>
<p>a------</p>
<p>---a---</p>



It is required that all of the characters other than spaces or tabs be the same.
So, this is not a thematic break:


 *-*
.
<p><em>-</em></p>



Thematic breaks do not need blank lines before or after:


- foo
***
- bar
.
<ul>
<li>foo</li>
</ul>
<hr />
<ul>
<li>bar</li>
</ul>



Thematic breaks can interrupt a paragraph:


Foo
***
bar
.
<p>Foo</p>
<hr />
<p>bar</p>



If a line of dashes that meets the above conditions for being a
thematic break could also be interpreted as the underline of a [setext
heading], the interpretation as a
[setext heading] takes precedence. Thus, for example,
this is a setext heading, not a paragraph followed by a thematic break:


Foo
---
bar
.
<h2>Foo</h2>
<p>bar</p>



When both a thematic break and a list item are possible
interpretations of a line, the thematic break takes precedence:


* Foo
* * *
* Bar
.
<ul>
<li>Foo</li>
</ul>
<hr />
<ul>
<li>Bar</li>
</ul>



If you want a thematic break in a list item, use a different bullet:


- Foo
- * * *
.
<ul>
<li>Foo</li>
<li>
<hr />
</li>
</ul>



ATX headings


An ATX heading
consists of a string of characters, parsed as inline content, between an
opening sequence of 1--6 unescaped # characters and an optional
closing sequence of any number of unescaped # characters.
The opening sequence of # characters must be followed by spaces or tabs, or
by the end of line. The optional closing sequence of #s must be preceded by
spaces or tabs and may be followed by spaces or tabs only.  The opening
# character may be preceded by up to three spaces of indentation.  The raw
contents of the heading are stripped of leading and trailing space or tabs
before being parsed as inline content.  The heading level is equal to the number
of # characters in the opening sequence.


Simple headings:


# foo
## foo
### foo
#### foo
##### foo
###### foo
.
<h1>foo</h1>
<h2>foo</h2>
<h3>foo</h3>
<h4>foo</h4>
<h5>foo</h5>
<h6>foo</h6>



More than six # characters is not a heading:


####### foo
.
<p>####### foo</p>



At least one space or tab is required between the # characters and the
heading's contents, unless the heading is empty.  Note that many
implementations currently do not require the space.  However, the
space was required by the
original ATX implementation,
and it helps prevent things like the following from being parsed as
headings:


#5 bolt

#hashtag
.
<p>#5 bolt</p>
<p>#hashtag</p>



This is not a heading, because the first # is escaped:


\## foo
.
<p>## foo</p>



Contents are parsed as inlines:


# foo *bar* \*baz\*
.
<h1>foo <em>bar</em> *baz*</h1>



Leading and trailing spaces or tabs are ignored in parsing inline content:


#                  foo                     
.
<h1>foo</h1>



Up to three spaces of indentation are allowed:


 ### foo
  ## foo
   # foo
.
<h3>foo</h3>
<h2>foo</h2>
<h1>foo</h1>



Four spaces of indentation is too many:


    # foo
.
<pre><code># foo
</code></pre>



foo
    # bar
.
<p>foo
# bar</p>



A closing sequence of # characters is optional:


## foo ##
  ###   bar    ###
.
<h2>foo</h2>
<h3>bar</h3>



It need not be the same length as the opening sequence:


# foo ##################################
##### foo ##
.
<h1>foo</h1>
<h5>foo</h5>



Spaces or tabs are allowed after the closing sequence:


### foo ###     
.
<h3>foo</h3>



A sequence of # characters with anything but spaces or tabs following it
is not a closing sequence, but counts as part of the contents of the
heading:


### foo ### b
.
<h3>foo ### b</h3>



The closing sequence must be preceded by a space or tab:


# foo#
.
<h1>foo#</h1>



Backslash-escaped # characters do not count as part
of the closing sequence:


### foo \###
## foo #\##
# foo \#
.
<h3>foo ###</h3>
<h2>foo ###</h2>
<h1>foo #</h1>



ATX headings need not be separated from surrounding content by blank
lines, and they can interrupt paragraphs:


****
## foo
****
.
<hr />
<h2>foo</h2>
<hr />



Foo bar
# baz
Bar foo
.
<p>Foo bar</p>
<h1>baz</h1>
<p>Bar foo</p>



ATX headings can be empty:


## 
#
### ###
.
<h2></h2>
<h1></h1>
<h3></h3>



Setext headings


A setext heading consists of one or more
lines of text, not interrupted by a blank line, of which the first line does not
have more than 3 spaces of indentation, followed by
a [setext heading underline].  The lines of text must be such
that, were they not followed by the setext heading underline,
they would be interpreted as a paragraph:  they cannot be
interpretable as a [code fence], [ATX heading][ATX headings],
[block quote][block quotes], [thematic break][thematic breaks],
[list item][list items], or [HTML block][HTML blocks].


A setext heading underline is a sequence of
= characters or a sequence of - characters, with no more than 3
spaces of indentation and any number of trailing spaces or tabs.


The heading is a level 1 heading if = characters are used in
the [setext heading underline], and a level 2 heading if -
characters are used.  The contents of the heading are the result
of parsing the preceding lines of text as CommonMark inline
content.


In general, a setext heading need not be preceded or followed by a
blank line.  However, it cannot interrupt a paragraph, so when a
setext heading comes after a paragraph, a blank line is needed between
them.


Simple examples:


Foo *bar*
=========

Foo *bar*
---------
.
<h1>Foo <em>bar</em></h1>
<h2>Foo <em>bar</em></h2>



The content of the header may span more than one line:


Foo *bar
baz*
====
.
<h1>Foo <em>bar
baz</em></h1>



The contents are the result of parsing the headings's raw
content as inlines.  The heading's raw content is formed by
concatenating the lines and removing initial and final
spaces or tabs.


  Foo *bar
baz*→
====
.
<h1>Foo <em>bar
baz</em></h1>



The underlining can be any length:


Foo
-------------------------

Foo
=
.
<h2>Foo</h2>
<h1>Foo</h1>



The heading content can be preceded by up to three spaces of indentation, and
need not line up with the underlining:


   Foo
---

  Foo
-----

  Foo
  ===
.
<h2>Foo</h2>
<h2>Foo</h2>
<h1>Foo</h1>



Four spaces of indentation is too many:


    Foo
    ---

    Foo
---
.
<pre><code>Foo
---

Foo
</code></pre>
<hr />



The setext heading underline can be preceded by up to three spaces of
indentation, and may have trailing spaces or tabs:


Foo
   ----      
.
<h2>Foo</h2>



Four spaces of indentation is too many:


Foo
    ---
.
<p>Foo
---</p>



The setext heading underline cannot contain internal spaces or tabs:


Foo
= =

Foo
--- -
.
<p>Foo
= =</p>
<p>Foo</p>
<hr />



Trailing spaces or tabs in the content line do not cause a hard line break:


Foo  
-----
.
<h2>Foo</h2>



Nor does a backslash at the end:


Foo\
----
.
<h2>Foo\</h2>



Since indicators of block structure take precedence over
indicators of inline structure, the following are setext headings:


`Foo
----
`

<a title="a lot
---
of dashes"/>
.
<h2>`Foo</h2>
<p>`</p>
<h2>&lt;a title=&quot;a lot</h2>
<p>of dashes&quot;/&gt;</p>



The setext heading underline cannot be a [lazy continuation
line] in a list item or block quote:


> Foo
---
.
<blockquote>
<p>Foo</p>
</blockquote>
<hr />



> foo
bar
===
.
<blockquote>
<p>foo
bar
===</p>
</blockquote>



- Foo
---
.
<ul>
<li>Foo</li>
</ul>
<hr />



A blank line is needed between a paragraph and a following
setext heading, since otherwise the paragraph becomes part
of the heading's content:


Foo
Bar
---
.
<h2>Foo
Bar</h2>



But in general a blank line is not required before or after
setext headings:


---
Foo
---
Bar
---
Baz
.
<hr />
<h2>Foo</h2>
<h2>Bar</h2>
<p>Baz</p>



Setext headings cannot be empty:



====
.
<p>====</p>



Setext heading text lines must not be interpretable as block
constructs other than paragraphs.  So, the line of dashes
in these examples gets interpreted as a thematic break:


---
---
.
<hr />
<hr />



- foo
-----
.
<ul>
<li>foo</li>
</ul>
<hr />



    foo
---
.
<pre><code>foo
</code></pre>
<hr />



> foo
-----
.
<blockquote>
<p>foo</p>
</blockquote>
<hr />



If you want a heading with > foo as its literal text, you can
use backslash escapes:


\> foo
------
.
<h2>&gt; foo</h2>



Compatibility note:  Most existing Markdown implementations
do not allow the text of setext headings to span multiple lines.
But there is no consensus about how to interpret


Foo
bar
---
baz



One can find four different interpretations:


    

  1. paragraph "Foo", heading "bar", paragraph "baz"
    2. 

  2. paragraph "Foo bar", thematic break, paragraph "baz"
    3. 

  3. paragraph "Foo bar --- baz"
    4. 

  4. heading "Foo bar", paragraph "baz"
    5. 



We find interpretation 4 most natural, and interpretation 4
increases the expressive power of CommonMark, by allowing
multiline headings.  Authors who want interpretation 1 can
put a blank line after the first paragraph:


Foo

bar
---
baz
.
<p>Foo</p>
<h2>bar</h2>
<p>baz</p>



Authors who want interpretation 2 can put blank lines around
the thematic break,


Foo
bar

---

baz
.
<p>Foo
bar</p>
<hr />
<p>baz</p>



or use a thematic break that cannot count as a [setext heading
underline], such as


Foo
bar
* * *
baz
.
<p>Foo
bar</p>
<hr />
<p>baz</p>



Authors who want interpretation 3 can use backslash escapes:


Foo
bar
\---
baz
.
<p>Foo
bar
---
baz</p>



Indented code blocks


An indented code block is composed of one or more
[indented chunks] separated by blank lines.
An indented chunk is a sequence of non-blank lines,
each preceded by four or more spaces of indentation. The contents of the code
block are the literal contents of the lines, including trailing
[line endings], minus four spaces of indentation.
An indented code block has no [info string].


An indented code block cannot interrupt a paragraph, so there must be
a blank line between a paragraph and a following indented code block.
(A blank line is not needed, however, between a code block and a following
paragraph.)


    a simple
      indented code block
.
<pre><code>a simple
  indented code block
</code></pre>



If there is any ambiguity between an interpretation of indentation
as a code block and as indicating that material belongs to a [list
item][list items], the list item interpretation takes precedence:


  - foo

    bar
.
<ul>
<li>
<p>foo</p>
<p>bar</p>
</li>
</ul>



1.  foo

    - bar
.
<ol>
<li>
<p>foo</p>
<ul>
<li>bar</li>
</ul>
</li>
</ol>



The contents of a code block are literal text, and do not get parsed
as Markdown:


    <a/>
    *hi*

    - one
.
<pre><code>&lt;a/&gt;
*hi*

- one
</code></pre>



Here we have three chunks separated by blank lines:


    chunk1

    chunk2
  
 
 
    chunk3
.
<pre><code>chunk1

chunk2



chunk3
</code></pre>



Any initial spaces or tabs beyond four spaces of indentation will be included in
the content, even in interior blank lines:


    chunk1
      
      chunk2
.
<pre><code>chunk1
  
  chunk2
</code></pre>



An indented code block cannot interrupt a paragraph.  (This
allows hanging indents and the like.)


Foo
    bar

.
<p>Foo
bar</p>



However, any non-blank line with fewer than four spaces of indentation ends
the code block immediately.  So a paragraph may occur immediately
after indented code:


    foo
bar
.
<pre><code>foo
</code></pre>
<p>bar</p>



And indented code can occur immediately before and after other kinds of
blocks:


# Heading
    foo
Heading
------
    foo
----
.
<h1>Heading</h1>
<pre><code>foo
</code></pre>
<h2>Heading</h2>
<pre><code>foo
</code></pre>
<hr />



The first line can be preceded by more than four spaces of indentation:


        foo
    bar
.
<pre><code>    foo
bar
</code></pre>



Blank lines preceding or following an indented code block
are not included in it:



    
    foo
    

.
<pre><code>foo
</code></pre>



Trailing spaces or tabs are included in the code block's content:


    foo  
.
<pre><code>foo  
</code></pre>



Fenced code blocks


A code fence is a sequence
of at least three consecutive backtick characters (`) or
tildes (~).  (Tildes and backticks cannot be mixed.)
A fenced code block
begins with a code fence, preceded by up to three spaces of indentation.


The line with the opening code fence may optionally contain some text
following the code fence; this is trimmed of leading and trailing
spaces or tabs and called the info string. If the [info string] comes
after a backtick fence, it may not contain any backtick
characters.  (The reason for this restriction is that otherwise
some inline code would be incorrectly interpreted as the
beginning of a fenced code block.)


The content of the code block consists of all subsequent lines, until
a closing [code fence] of the same type as the code block
began with (backticks or tildes), and with at least as many backticks
or tildes as the opening code fence.  If the leading code fence is
preceded by N spaces of indentation, then up to N spaces of indentation are
removed from each line of the content (if present).  (If a content line is not
indented, it is preserved unchanged.  If it is indented N spaces or less, all
of the indentation is removed.)


The closing code fence may be preceded by up to three spaces of indentation, and
may be followed only by spaces or tabs, which are ignored.  If the end of the
containing block (or document) is reached and no closing code fence
has been found, the code block contains all of the lines after the
opening code fence until the end of the containing block (or
document).  (An alternative spec would require backtracking in the
event that a closing code fence is not found.  But this makes parsing
much less efficient, and there seems to be no real downside to the
behavior described here.)


A fenced code block may interrupt a paragraph, and does not require
a blank line either before or after.


The content of a code fence is treated as literal text, not parsed
as inlines.  The first word of the [info string] is typically used to
specify the language of the code sample, and rendered in the class
attribute of the code tag.  However, this spec does not mandate any
particular treatment of the [info string].


Here is a simple example with backticks:


```
<
 >
```
.
<pre><code>&lt;
 &gt;
</code></pre>



With tildes:


~~~
<
 >
~~~
.
<pre><code>&lt;
 &gt;
</code></pre>



Fewer than three backticks is not enough:


``
foo
``
.
<p><code>foo</code></p>



The closing code fence must use the same character as the opening
fence:


```
aaa
~~~
```
.
<pre><code>aaa
~~~
</code></pre>



~~~
aaa
```
~~~
.
<pre><code>aaa
```
</code></pre>



The closing code fence must be at least as long as the opening fence:


````
aaa
```
``````
.
<pre><code>aaa
```
</code></pre>



~~~~
aaa
~~~
~~~~
.
<pre><code>aaa
~~~
</code></pre>



Unclosed code blocks are closed by the end of the document
(or the enclosing [block quote][block quotes] or [list item][list items]):


```
.
<pre><code></code></pre>



`````

```
aaa
.
<pre><code>
```
aaa
</code></pre>



> ```
> aaa

bbb
.
<blockquote>
<pre><code>aaa
</code></pre>
</blockquote>
<p>bbb</p>



A code block can have all empty lines as its content:


```

  
```
.
<pre><code>
  
</code></pre>



A code block can be empty:


```
```
.
<pre><code></code></pre>



Fences can be indented.  If the opening fence is indented,
content lines will have equivalent opening indentation removed,
if present:


 ```
 aaa
aaa
```
.
<pre><code>aaa
aaa
</code></pre>



  ```
aaa
  aaa
aaa
  ```
.
<pre><code>aaa
aaa
aaa
</code></pre>



   ```
   aaa
    aaa
  aaa
   ```
.
<pre><code>aaa
 aaa
aaa
</code></pre>



Four spaces of indentation is too many:


    ```
    aaa
    ```
.
<pre><code>```
aaa
```
</code></pre>



Closing fences may be preceded by up to three spaces of indentation, and their
indentation need not match that of the opening fence:


```
aaa
  ```
.
<pre><code>aaa
</code></pre>



   ```
aaa
  ```
.
<pre><code>aaa
</code></pre>



This is not a closing fence, because it is indented 4 spaces:


```
aaa
    ```
.
<pre><code>aaa
    ```
</code></pre>



Code fences (opening and closing) cannot contain internal spaces or tabs:


``` ```
aaa
.
<p><code> </code>
aaa</p>



~~~~~~
aaa
~~~ ~~
.
<pre><code>aaa
~~~ ~~
</code></pre>



Fenced code blocks can interrupt paragraphs, and can be followed
directly by paragraphs, without a blank line between:


foo
```
bar
```
baz
.
<p>foo</p>
<pre><code>bar
</code></pre>
<p>baz</p>



Other blocks can also occur before and after fenced code blocks
without an intervening blank line:


foo
---
~~~
bar
~~~
# baz
.
<h2>foo</h2>
<pre><code>bar
</code></pre>
<h1>baz</h1>



An [info string] can be provided after the opening code fence.
Although this spec doesn't mandate any particular treatment of
the info string, the first word is typically used to specify
the language of the code block. In HTML output, the language is
normally indicated by adding a class to the code element consisting
of language- followed by the language name.


```ruby
def foo(x)
  return 3
end
```
.
<pre><code class="language-ruby">def foo(x)
  return 3
end
</code></pre>



~~~~    ruby startline=3 $%@#$
def foo(x)
  return 3
end
~~~~~~~
.
<pre><code class="language-ruby">def foo(x)
  return 3
end
</code></pre>



````;
````
.
<pre><code class="language-;"></code></pre>



[Info strings] for backtick code blocks cannot contain backticks:


``` aa ```
foo
.
<p><code>aa</code>
foo</p>



[Info strings] for tilde code blocks can contain backticks and tildes:


~~~ aa ``` ~~~
foo
~~~
.
<pre><code class="language-aa">foo
</code></pre>



Closing code fences cannot have [info strings]:


```
``` aaa
```
.
<pre><code>``` aaa
</code></pre>



HTML blocks


An HTML block is a group of lines that is treated
as raw HTML (and will not be escaped in HTML output).


There are seven kinds of [HTML block], which can be defined by their
start and end conditions.  The block begins with a line that meets a
start condition (after up to three optional spaces of indentation).
It ends with the first subsequent line that meets a matching
end condition, or the last line of the document, or the last line of
the container block containing the current HTML
block, if no line is encountered that meets the [end condition].  If
the first line meets both the [start condition] and the [end
condition], the block will contain just that line.


    

  1. 

    Start condition:  line begins with the string <pre,
<script, <style, or <textarea (case-insensitive), followed by a space,
a tab, the string >, or the end of the line.
    
End condition:  line contains an end tag
</pre>, </script>, </style>, or </textarea> (case-insensitive; it
need not match the start tag).
    

    2. 

  2. 

    Start condition: line begins with the string <!--.
    
End condition:  line contains the string -->.
    

    3. 

  3. 

    Start condition: line begins with the string <?.
    
End condition: line contains the string ?>.
    

    4. 

  4. 

    Start condition: line begins with the string <!
followed by an ASCII letter.
    
End condition: line contains the character >.
    

    5. 

  5. 

    Start condition:  line begins with the string
<![CDATA[.
    
End condition: line contains the string ]]>.
    

    6. 

  6. 

    Start condition: line begins with the string < or </
followed by one of the strings (case-insensitive) address,
article, aside, base, basefont, blockquote, body,
caption, center, col, colgroup, dd, details, dialog,
dir, div, dl, dt, fieldset, figcaption, figure,
footer, form, frame, frameset,
h1, h2, h3, h4, h5, h6, head, header, hr,
html, iframe, legend, li, link, main, menu, menuitem,
nav, noframes, ol, optgroup, option, p, param,
search, section, summary, table, tbody, td,
tfoot, th, thead, title, tr, track, ul, followed
by a space, a tab, the end of the line, the string >, or
the string />.
    
End condition: line is followed by a [blank line].
    

    7. 

  7. 

    Start condition:  line begins with a complete [open tag]
(with any [tag name] other than pre, script,
style, or textarea) or a complete [closing tag],
followed by zero or more spaces and tabs, followed by the end of the line.
    
End condition: line is followed by a [blank line].
    

    8. 



HTML blocks continue until they are closed by their appropriate
[end condition], or the last line of the document or other container
block.  This means any HTML within an HTML
block that might otherwise be recognised as a start condition will
be ignored by the parser and passed through as-is, without changing
the parser's state.


For instance, <pre> within an HTML block started by <table> will not affect
the parser state; as the HTML block was started in by start condition 6, it
will end at any blank line. This can be surprising:


<table><tr><td>
<pre>
**Hello**,

_world_.
</pre>
</td></tr></table>
.
<table><tr><td>
<pre>
**Hello**,
<p><em>world</em>.
</pre></p>
</td></tr></table>



In this case, the HTML block is terminated by the blank line — the **Hello**
text remains verbatim — and regular parsing resumes, with a paragraph,
emphasised world and inline and block HTML following.


All types of [HTML blocks] except type 7 may interrupt
a paragraph.  Blocks of type 7 may not interrupt a paragraph.
(This restriction is intended to prevent unwanted interpretation
of long tags inside a wrapped paragraph as starting HTML blocks.)


Some simple examples follow.  Here are some basic HTML blocks
of type 6:


<table>
  <tr>
    <td>
           hi
    </td>
  </tr>
</table>

okay.
.
<table>
  <tr>
    <td>
           hi
    </td>
  </tr>
</table>
<p>okay.</p>



 <div>
  *hello*
         <foo><a>
.
 <div>
  *hello*
         <foo><a>



A block can also start with a closing tag:


</div>
*foo*
.
</div>
*foo*



Here we have two HTML blocks with a Markdown paragraph between them:


<DIV CLASS="foo">

*Markdown*

</DIV>
.
<DIV CLASS="foo">
<p><em>Markdown</em></p>
</DIV>



The tag on the first line can be partial, as long
as it is split where there would be whitespace:


<div id="foo"
  class="bar">
</div>
.
<div id="foo"
  class="bar">
</div>



<div id="foo" class="bar
  baz">
</div>
.
<div id="foo" class="bar
  baz">
</div>



An open tag need not be closed:


<div>
*foo*

*bar*
.
<div>
*foo*
<p><em>bar</em></p>



A partial tag need not even be completed (garbage
in, garbage out):


<div id="foo"
*hi*
.
<div id="foo"
*hi*



<div class
foo
.
<div class
foo



The initial tag doesn't even need to be a valid
tag, as long as it starts like one:


<div *???-&&&-<---
*foo*
.
<div *???-&&&-<---
*foo*



In type 6 blocks, the initial tag need not be on a line by
itself:


<div><a href="bar">*foo*</a></div>
.
<div><a href="bar">*foo*</a></div>



<table><tr><td>
foo
</td></tr></table>
.
<table><tr><td>
foo
</td></tr></table>



Everything until the next blank line or end of document
gets included in the HTML block.  So, in the following
example, what looks like a Markdown code block
is actually part of the HTML block, which continues until a blank
line or the end of the document is reached:


<div></div>
``` c
int x = 33;
```
.
<div></div>
``` c
int x = 33;
```



To start an [HTML block] with a tag that is not in the
list of block-level tags in (6), you must put the tag by
itself on the first line (and it must be complete):


<a href="foo">
*bar*
</a>
.
<a href="foo">
*bar*
</a>



In type 7 blocks, the [tag name] can be anything:


<Warning>
*bar*
</Warning>
.
<Warning>
*bar*
</Warning>



<i class="foo">
*bar*
</i>
.
<i class="foo">
*bar*
</i>



</ins>
*bar*
.
</ins>
*bar*



These rules are designed to allow us to work with tags that
can function as either block-level or inline-level tags.
The <del> tag is a nice example.  We can surround content with
<del> tags in three different ways.  In this case, we get a raw
HTML block, because the <del> tag is on a line by itself:


<del>
*foo*
</del>
.
<del>
*foo*
</del>



In this case, we get a raw HTML block that just includes
the <del> tag (because it ends with the following blank
line).  So the contents get interpreted as CommonMark:


<del>

*foo*

</del>
.
<del>
<p><em>foo</em></p>
</del>



Finally, in this case, the <del> tags are interpreted
as [raw HTML] inside the CommonMark paragraph.  (Because
the tag is not on a line by itself, we get inline HTML
rather than an [HTML block].)


<del>*foo*</del>
.
<p><del><em>foo</em></del></p>



HTML tags designed to contain literal content
(pre, script, style, textarea), comments, processing instructions,
and declarations are treated somewhat differently.
Instead of ending at the first blank line, these blocks
end at the first line containing a corresponding end tag.
As a result, these blocks can contain blank lines:


A pre tag (type 1):


<pre language="haskell"><code>
import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags
</code></pre>
okay
.
<pre language="haskell"><code>
import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags
</code></pre>
<p>okay</p>



A script tag (type 1):


<script type="text/javascript">
// JavaScript example

document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script>
okay
.
<script type="text/javascript">
// JavaScript example

document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script>
<p>okay</p>



A textarea tag (type 1):


<textarea>

*foo*

_bar_

</textarea>
.
<textarea>

*foo*

_bar_

</textarea>



A style tag (type 1):


<style
  type="text/css">
h1 {color:red;}

p {color:blue;}
</style>
okay
.
<style
  type="text/css">
h1 {color:red;}

p {color:blue;}
</style>
<p>okay</p>



If there is no matching end tag, the block will end at the
end of the document (or the enclosing [block quote][block quotes]
or [list item][list items]):


<style
  type="text/css">

foo
.
<style
  type="text/css">

foo



> <div>
> foo

bar
.
<blockquote>
<div>
foo
</blockquote>
<p>bar</p>



- <div>
- foo
.
<ul>
<li>
<div>
</li>
<li>foo</li>
</ul>



The end tag can occur on the same line as the start tag:


<style>p{color:red;}</style>
*foo*
.
<style>p{color:red;}</style>
<p><em>foo</em></p>



<!-- foo -->*bar*
*baz*
.
<!-- foo -->*bar*
<p><em>baz</em></p>



Note that anything on the last line after the
end tag will be included in the [HTML block]:


<script>
foo
</script>1. *bar*
.
<script>
foo
</script>1. *bar*



A comment (type 2):


<!-- Foo

bar
   baz -->
okay
.
<!-- Foo

bar
   baz -->
<p>okay</p>



A processing instruction (type 3):


<?php

  echo '>';

?>
okay
.
<?php

  echo '>';

?>
<p>okay</p>



A declaration (type 4):


<!DOCTYPE html>
.
<!DOCTYPE html>



CDATA (type 5):


<![CDATA[
function matchwo(a,b)
{
  if (a < b && a < 0) then {
    return 1;

  } else {

    return 0;
  }
}
]]>
okay
.
<![CDATA[
function matchwo(a,b)
{
  if (a < b && a < 0) then {
    return 1;

  } else {

    return 0;
  }
}
]]>
<p>okay</p>



The opening tag can be preceded by up to three spaces of indentation, but not
four:


  <!-- foo -->

    <!-- foo -->
.
  <!-- foo -->
<pre><code>&lt;!-- foo --&gt;
</code></pre>



  <div>

    <div>
.
  <div>
<pre><code>&lt;div&gt;
</code></pre>



An HTML block of types 1--6 can interrupt a paragraph, and need not be
preceded by a blank line.


Foo
<div>
bar
</div>
.
<p>Foo</p>
<div>
bar
</div>



However, a following blank line is needed, except at the end of
a document, and except for blocks of types 1--5, [above][HTML
block]:


<div>
bar
</div>
*foo*
.
<div>
bar
</div>
*foo*



HTML blocks of type 7 cannot interrupt a paragraph:


Foo
<a href="bar">
baz
.
<p>Foo
<a href="bar">
baz</p>



This rule differs from John Gruber's original Markdown syntax
specification, which says:




The only restrictions are that block-level HTML elements —
e.g. <div>, <table>, <pre>, <p>, etc. — must be separated from
surrounding content by blank lines, and the start and end tags of the
block should not be indented with spaces or tabs.




In some ways Gruber's rule is more restrictive than the one given
here:


    

  • It requires that an HTML block be preceded by a blank line.
    • 

  • It does not allow the start tag to be indented.
    • 

  • It requires a matching end tag, which it also does not allow to
be indented.
    • 



Most Markdown implementations (including some of Gruber's own) do not
respect all of these restrictions.


There is one respect, however, in which Gruber's rule is more liberal
than the one given here, since it allows blank lines to occur inside
an HTML block.  There are two reasons for disallowing them here.
First, it removes the need to parse balanced tags, which is
expensive and can require backtracking from the end of the document
if no matching end tag is found. Second, it provides a very simple
and flexible way of including Markdown content inside HTML tags:
simply separate the Markdown from the HTML using blank lines:


Compare:


<div>

*Emphasized* text.

</div>
.
<div>
<p><em>Emphasized</em> text.</p>
</div>



<div>
*Emphasized* text.
</div>
.
<div>
*Emphasized* text.
</div>



Some Markdown implementations have adopted a convention of
interpreting content inside tags as text if the open tag has
the attribute markdown=1.  The rule given above seems a simpler and
more elegant way of achieving the same expressive power, which is also
much simpler to parse.


The main potential drawback is that one can no longer paste HTML
blocks into Markdown documents with 100% reliability.  However,
in most cases this will work fine, because the blank lines in
HTML are usually followed by HTML block tags.  For example:


<table>

<tr>

<td>
Hi
</td>

</tr>

</table>
.
<table>
<tr>
<td>
Hi
</td>
</tr>
</table>



There are problems, however, if the inner tags are indented
and separated by spaces, as then they will be interpreted as
an indented code block:


<table>

  <tr>

    <td>
      Hi
    </td>

  </tr>

</table>
.
<table>
  <tr>
<pre><code>&lt;td&gt;
  Hi
&lt;/td&gt;
</code></pre>
  </tr>
</table>



Fortunately, blank lines are usually not necessary and can be
deleted.  The exception is inside <pre> tags, but as described
[above][HTML blocks], raw HTML blocks starting with <pre>
can contain blank lines.


Link reference definitions


A link reference definition
consists of a [link label], optionally preceded by up to three spaces of
indentation, followed
by a colon (:), optional spaces or tabs (including up to one
[line ending]), a [link destination],
optional spaces or tabs (including up to one
[line ending]), and an optional [link
title], which if it is present must be separated
from the [link destination] by spaces or tabs.
No further character may occur.


A [link reference definition]
does not correspond to a structural element of a document.  Instead, it
defines a label which can be used in [reference links]
and reference-style [images] elsewhere in the document.  [Link
reference definitions] can come either before or after the links that use
them.


[foo]: /url "title"

[foo]
.
<p><a href="/url" title="title">foo</a></p>



   [foo]: 
      /url  
           'the title'  

[foo]
.
<p><a href="/url" title="the title">foo</a></p>



[Foo*bar\]]:my_(url) 'title (with parens)'

[Foo*bar\]]
.
<p><a href="my_(url)" title="title (with parens)">Foo*bar]</a></p>



[Foo bar]:
<my url>
'title'

[Foo bar]
.
<p><a href="my%20url" title="title">Foo bar</a></p>



The title may extend over multiple lines:


[foo]: /url '
title
line1
line2
'

[foo]
.
<p><a href="/url" title="
title
line1
line2
">foo</a></p>



However, it may not contain a [blank line]:


[foo]: /url 'title

with blank line'

[foo]
.
<p>[foo]: /url 'title</p>
<p>with blank line'</p>
<p>[foo]</p>



The title may be omitted:


[foo]:
/url

[foo]
.
<p><a href="/url">foo</a></p>



The link destination may not be omitted:


[foo]:

[foo]
.
<p>[foo]:</p>
<p>[foo]</p>



However, an empty link destination may be specified using
angle brackets:


[foo]: <>

[foo]
.
<p><a href="">foo</a></p>



The title must be separated from the link destination by
spaces or tabs:


[foo]: <bar>(baz)

[foo]
.
<p>[foo]: <bar>(baz)</p>
<p>[foo]</p>



Both title and destination can contain backslash escapes
and literal backslashes:


[foo]: /url\bar\*baz "foo\"bar\baz"

[foo]
.
<p><a href="/url%5Cbar*baz" title="foo&quot;bar\baz">foo</a></p>



A link can come before its corresponding definition:


[foo]

[foo]: url
.
<p><a href="url">foo</a></p>



If there are several matching definitions, the first one takes
precedence:


[foo]

[foo]: first
[foo]: second
.
<p><a href="first">foo</a></p>



As noted in the section on [Links], matching of labels is
case-insensitive (see [matches]).


[FOO]: /url

[Foo]
.
<p><a href="/url">Foo</a></p>



[ΑΓΩ]: /φου

[αγω]
.
<p><a href="/%CF%86%CE%BF%CF%85">αγω</a></p>



Whether something is a [link reference definition] is
independent of whether the link reference it defines is
used in the document.  Thus, for example, the following
document contains just a link reference definition, and
no visible content:


[foo]: /url
.



Here is another one:


[
foo
]: /url
bar
.
<p>bar</p>



This is not a link reference definition, because there are
characters other than spaces or tabs after the title:


[foo]: /url "title" ok
.
<p>[foo]: /url &quot;title&quot; ok</p>



This is a link reference definition, but it has no title:


[foo]: /url
"title" ok
.
<p>&quot;title&quot; ok</p>



This is not a link reference definition, because it is indented
four spaces:


    [foo]: /url "title"

[foo]
.
<pre><code>[foo]: /url &quot;title&quot;
</code></pre>
<p>[foo]</p>



This is not a link reference definition, because it occurs inside
a code block:


```
[foo]: /url
```

[foo]
.
<pre><code>[foo]: /url
</code></pre>
<p>[foo]</p>



A [link reference definition] cannot interrupt a paragraph.


Foo
[bar]: /baz

[bar]
.
<p>Foo
[bar]: /baz</p>
<p>[bar]</p>



However, it can directly follow other block elements, such as headings
and thematic breaks, and it need not be followed by a blank line.


# [Foo]
[foo]: /url
> bar
.
<h1><a href="/url">Foo</a></h1>
<blockquote>
<p>bar</p>
</blockquote>



[foo]: /url
bar
===
[foo]
.
<h1>bar</h1>
<p><a href="/url">foo</a></p>



[foo]: /url
===
[foo]
.
<p>===
<a href="/url">foo</a></p>



Several [link reference definitions]
can occur one after another, without intervening blank lines.


[foo]: /foo-url "foo"
[bar]: /bar-url
  "bar"
[baz]: /baz-url

[foo],
[bar],
[baz]
.
<p><a href="/foo-url" title="foo">foo</a>,
<a href="/bar-url" title="bar">bar</a>,
<a href="/baz-url">baz</a></p>



[Link reference definitions] can occur
inside block containers, like lists and block quotations.  They
affect the entire document, not just the container in which they
are defined:


[foo]

> [foo]: /url
.
<p><a href="/url">foo</a></p>
<blockquote>
</blockquote>



Paragraphs


A sequence of non-blank lines that cannot be interpreted as other
kinds of blocks forms a paragraph.
The contents of the paragraph are the result of parsing the
paragraph's raw content as inlines.  The paragraph's raw content
is formed by concatenating the lines and removing initial and final
spaces or tabs.


A simple example with two paragraphs:


aaa

bbb
.
<p>aaa</p>
<p>bbb</p>



Paragraphs can contain multiple lines, but no blank lines:


aaa
bbb

ccc
ddd
.
<p>aaa
bbb</p>
<p>ccc
ddd</p>



Multiple blank lines between paragraphs have no effect:


aaa


bbb
.
<p>aaa</p>
<p>bbb</p>



Leading spaces or tabs are skipped:


  aaa
 bbb
.
<p>aaa
bbb</p>



Lines after the first may be indented any amount, since indented
code blocks cannot interrupt paragraphs.


aaa
             bbb
                                       ccc
.
<p>aaa
bbb
ccc</p>



However, the first line may be preceded by up to three spaces of indentation.
Four spaces of indentation is too many:


   aaa
bbb
.
<p>aaa
bbb</p>



    aaa
bbb
.
<pre><code>aaa
</code></pre>
<p>bbb</p>



Final spaces or tabs are stripped before inline parsing, so a paragraph
that ends with two or more spaces will not end with a [hard line
break]:


aaa     
bbb     
.
<p>aaa<br />
bbb</p>



Blank lines


[Blank lines] between block-level elements are ignored,
except for the role they play in determining whether a [list]
is [tight] or [loose].


Blank lines at the beginning and end of the document are also ignored.


  

aaa
  

# aaa

  
.
<p>aaa</p>
<h1>aaa</h1>



Container blocks


A container block is a block that has other
blocks as its contents.  There are two basic kinds of container blocks:
[block quotes] and [list items].
[Lists] are meta-containers for [list items].


We define the syntax for container blocks recursively.  The general
form of the definition is:




If X is a sequence of blocks, then the result of
transforming X in such-and-such a way is a container of type Y
with these blocks as its content.




So, we explain what counts as a block quote or list item by explaining
how these can be generated from their contents. This should suffice
to define the syntax, although it does not give a recipe for parsing
these constructions.  (A recipe is provided below in the section entitled
A parsing strategy.)


Block quotes


A block quote marker,
optionally preceded by up to three spaces of indentation,
consists of (a) the character > together with a following space of
indentation, or (b) a single character > not followed by a space of
indentation.


The following rules define [block quotes]:


    

  1. 

    Basic case.  If a string of lines Ls constitute a sequence
of blocks Bs, then the result of prepending a [block quote
marker] to the beginning of each line in Ls
is a block quote containing Bs.
    

    2. 

  2. 

    Laziness.  If a string of lines Ls constitute a block
quote with contents Bs, then the result of deleting
the initial [block quote marker] from one or
more lines in which the next character other than a space or tab after the
[block quote marker] is [paragraph continuation
text] is a block quote with Bs as its content.
Paragraph continuation text is text
that will be parsed as part of the content of a paragraph, but does
not occur at the beginning of the paragraph.
    

    3. 

  3. 

    Consecutiveness.  A document cannot contain two [block
quotes] in a row unless there is a [blank line] between them.
    

    4. 



Nothing else counts as a block quote.


Here is a simple example:


> # Foo
> bar
> baz
.
<blockquote>
<h1>Foo</h1>
<p>bar
baz</p>
</blockquote>



The space or tab after the > characters can be omitted:


># Foo
>bar
> baz
.
<blockquote>
<h1>Foo</h1>
<p>bar
baz</p>
</blockquote>



The > characters can be preceded by up to three spaces of indentation:


   > # Foo
   > bar
 > baz
.
<blockquote>
<h1>Foo</h1>
<p>bar
baz</p>
</blockquote>



Four spaces of indentation is too many:


    > # Foo
    > bar
    > baz
.
<pre><code>&gt; # Foo
&gt; bar
&gt; baz
</code></pre>



The Laziness clause allows us to omit the > before
[paragraph continuation text]:


> # Foo
> bar
baz
.
<blockquote>
<h1>Foo</h1>
<p>bar
baz</p>
</blockquote>



A block quote can contain some lazy and some non-lazy
continuation lines:


> bar
baz
> foo
.
<blockquote>
<p>bar
baz
foo</p>
</blockquote>



Laziness only applies to lines that would have been continuations of
paragraphs had they been prepended with [block quote markers].
For example, the >  cannot be omitted in the second line of


> foo
> ---



without changing the meaning:


> foo
---
.
<blockquote>
<p>foo</p>
</blockquote>
<hr />



Similarly, if we omit the >  in the second line of


> - foo
> - bar



then the block quote ends after the first line:


> - foo
- bar
.
<blockquote>
<ul>
<li>foo</li>
</ul>
</blockquote>
<ul>
<li>bar</li>
</ul>



For the same reason, we can't omit the >  in front of
subsequent lines of an indented or fenced code block:


>     foo
    bar
.
<blockquote>
<pre><code>foo
</code></pre>
</blockquote>
<pre><code>bar
</code></pre>



> ```
foo
```
.
<blockquote>
<pre><code></code></pre>
</blockquote>
<p>foo</p>
<pre><code></code></pre>



Note that in the following case, we have a [lazy
continuation line]:


> foo
    - bar
.
<blockquote>
<p>foo
- bar</p>
</blockquote>



To see why, note that in


> foo
>     - bar



the - bar is indented too far to start a list, and can't
be an indented code block because indented code blocks cannot
interrupt paragraphs, so it is [paragraph continuation text].


A block quote can be empty:


>
.
<blockquote>
</blockquote>



>
>  
> 
.
<blockquote>
</blockquote>



A block quote can have initial or final blank lines:


>
> foo
>  
.
<blockquote>
<p>foo</p>
</blockquote>



A blank line always separates block quotes:


> foo

> bar
.
<blockquote>
<p>foo</p>
</blockquote>
<blockquote>
<p>bar</p>
</blockquote>



(Most current Markdown implementations, including John Gruber's
original Markdown.pl, will parse this example as a single block quote
with two paragraphs.  But it seems better to allow the author to decide
whether two block quotes or one are wanted.)


Consecutiveness means that if we put these block quotes together,
we get a single block quote:


> foo
> bar
.
<blockquote>
<p>foo
bar</p>
</blockquote>



To get a block quote with two paragraphs, use:


> foo
>
> bar
.
<blockquote>
<p>foo</p>
<p>bar</p>
</blockquote>



Block quotes can interrupt paragraphs:


foo
> bar
.
<p>foo</p>
<blockquote>
<p>bar</p>
</blockquote>



In general, blank lines are not needed before or after block
quotes:


> aaa
***
> bbb
.
<blockquote>
<p>aaa</p>
</blockquote>
<hr />
<blockquote>
<p>bbb</p>
</blockquote>



However, because of laziness, a blank line is needed between
a block quote and a following paragraph:


> bar
baz
.
<blockquote>
<p>bar
baz</p>
</blockquote>



> bar

baz
.
<blockquote>
<p>bar</p>
</blockquote>
<p>baz</p>



> bar
>
baz
.
<blockquote>
<p>bar</p>
</blockquote>
<p>baz</p>



It is a consequence of the Laziness rule that any number
of initial >s may be omitted on a continuation line of a
nested block quote:


> > > foo
bar
.
<blockquote>
<blockquote>
<blockquote>
<p>foo
bar</p>
</blockquote>
</blockquote>
</blockquote>



>>> foo
> bar
>>baz
.
<blockquote>
<blockquote>
<blockquote>
<p>foo
bar
baz</p>
</blockquote>
</blockquote>
</blockquote>



When including an indented code block in a block quote,
remember that the [block quote marker] includes
both the > and a following space of indentation.  So five spaces are needed
after the >:


>     code

>    not code
.
<blockquote>
<pre><code>code
</code></pre>
</blockquote>
<blockquote>
<p>not code</p>
</blockquote>



List items


A list marker is a
[bullet list marker] or an [ordered list marker].


A bullet list marker
is a -, +, or * character.


An ordered list marker
is a sequence of 1--9 arabic digits (0-9), followed by either a
. character or a ) character.  (The reason for the length
limit is that with 10 digits we start seeing integer overflows
in some browsers.)


The following rules define [list items]:


    

  1. 

    Basic case.  If a sequence of lines Ls constitute a sequence of
blocks Bs starting with a character other than a space or tab, and M is
a list marker of width W followed by 1 ≤ N ≤ 4 spaces of indentation,
then the result of prepending M and the following spaces to the first line
of Ls, and indenting subsequent lines of Ls by W + N spaces, is a
list item with Bs as its contents.  The type of the list item
(bullet or ordered) is determined by the type of its list marker.
If the list item is ordered, then it is also assigned a start
number, based on the ordered list marker.
    

    Exceptions:
    

      

    1. When the first list item in a [list] interrupts
a paragraph---that is, when it starts on a line that would
otherwise count as [paragraph continuation text]---then (a)
the lines Ls must not begin with a blank line, and (b) if
the list item is ordered, the start number must be 1.
      2. 

    2. If any line is a [thematic break][thematic breaks] then
that line is not a list item.
      3. 

    

    2. 



For example, let Ls be the lines


A paragraph
with two lines.

    indented code

> A block quote.
.
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>



And let M be the marker 1., and N = 2.  Then rule #1 says
that the following is an ordered list item with start number 1,
and the same contents as Ls:


1.  A paragraph
    with two lines.

        indented code

    > A block quote.
.
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>



The most important thing to notice is that the position of
the text after the list marker determines how much indentation
is needed in subsequent blocks in the list item.  If the list
marker takes up two spaces of indentation, and there are three spaces between
the list marker and the next character other than a space or tab, then blocks
must be indented five spaces in order to fall under the list
item.


Here are some examples showing how far content must be indented to be
put under the list item:


- one

 two
.
<ul>
<li>one</li>
</ul>
<p>two</p>



- one

  two
.
<ul>
<li>
<p>one</p>
<p>two</p>
</li>
</ul>



 -    one

     two
.
<ul>
<li>one</li>
</ul>
<pre><code> two
</code></pre>



 -    one

      two
.
<ul>
<li>
<p>one</p>
<p>two</p>
</li>
</ul>



It is tempting to think of this in terms of columns:  the continuation
blocks must be indented at least to the column of the first character other than
a space or tab after the list marker.  However, that is not quite right.
The spaces of indentation after the list marker determine how much relative
indentation is needed.  Which column this indentation reaches will depend on
how the list item is embedded in other constructions, as shown by
this example:


   > > 1.  one
>>
>>     two
.
<blockquote>
<blockquote>
<ol>
<li>
<p>one</p>
<p>two</p>
</li>
</ol>
</blockquote>
</blockquote>



Here two occurs in the same column as the list marker 1.,
but is actually contained in the list item, because there is
sufficient indentation after the last containing blockquote marker.


The converse is also possible.  In the following example, the word two
occurs far to the right of the initial text of the list item, one, but
it is not considered part of the list item, because it is not indented
far enough past the blockquote marker:


>>- one
>>
  >  > two
.
<blockquote>
<blockquote>
<ul>
<li>one</li>
</ul>
<p>two</p>
</blockquote>
</blockquote>



Note that at least one space or tab is needed between the list marker and
any following content, so these are not list items:


-one

2.two
.
<p>-one</p>
<p>2.two</p>



A list item may contain blocks that are separated by more than
one blank line.


- foo


  bar
.
<ul>
<li>
<p>foo</p>
<p>bar</p>
</li>
</ul>



A list item may contain any kind of block:


1.  foo

    ```
    bar
    ```

    baz

    > bam
.
<ol>
<li>
<p>foo</p>
<pre><code>bar
</code></pre>
<p>baz</p>
<blockquote>
<p>bam</p>
</blockquote>
</li>
</ol>



A list item that contains an indented code block will preserve
empty lines within the code block verbatim.


- Foo

      bar


      baz
.
<ul>
<li>
<p>Foo</p>
<pre><code>bar


baz
</code></pre>
</li>
</ul>



Note that ordered list start numbers must be nine digits or less:


123456789. ok
.
<ol start="123456789">
<li>ok</li>
</ol>



1234567890. not ok
.
<p>1234567890. not ok</p>



A start number may begin with 0s:


0. ok
.
<ol start="0">
<li>ok</li>
</ol>



003. ok
.
<ol start="3">
<li>ok</li>
</ol>



A start number may not be negative:


-1. not ok
.
<p>-1. not ok</p>



    

  1. Item starting with indented code.  If a sequence of lines Ls
constitute a sequence of blocks Bs starting with an indented code
block, and M is a list marker of width W followed by
one space of indentation, then the result of prepending M and the
following space to the first line of Ls, and indenting subsequent lines
of Ls by W + 1 spaces, is a list item with Bs as its contents.
If a line is empty, then it need not be indented.  The type of the
list item (bullet or ordered) is determined by the type of its list
marker.  If the list item is ordered, then it is also assigned a
start number, based on the ordered list marker.
    2. 



An indented code block will have to be preceded by four spaces of indentation
beyond the edge of the region where text will be included in the list item.
In the following case that is 6 spaces:


- foo

      bar
.
<ul>
<li>
<p>foo</p>
<pre><code>bar
</code></pre>
</li>
</ul>



And in this case it is 11 spaces:


  10.  foo

           bar
.
<ol start="10">
<li>
<p>foo</p>
<pre><code>bar
</code></pre>
</li>
</ol>



If the first block in the list item is an indented code block,
then by rule #2, the contents must be preceded by one space of indentation
after the list marker:


    indented code

paragraph

    more code
.
<pre><code>indented code
</code></pre>
<p>paragraph</p>
<pre><code>more code
</code></pre>



1.     indented code

   paragraph

       more code
.
<ol>
<li>
<pre><code>indented code
</code></pre>
<p>paragraph</p>
<pre><code>more code
</code></pre>
</li>
</ol>



Note that an additional space of indentation is interpreted as space
inside the code block:


1.      indented code

   paragraph

       more code
.
<ol>
<li>
<pre><code> indented code
</code></pre>
<p>paragraph</p>
<pre><code>more code
</code></pre>
</li>
</ol>



Note that rules #1 and #2 only apply to two cases:  (a) cases
in which the lines to be included in a list item begin with a
character other than a space or tab, and (b) cases in which
they begin with an indented code
block.  In a case like the following, where the first block begins with
three spaces of indentation, the rules do not allow us to form a list item by
indenting the whole thing and prepending a list marker:


   foo

bar
.
<p>foo</p>
<p>bar</p>



-    foo

  bar
.
<ul>
<li>foo</li>
</ul>
<p>bar</p>



This is not a significant restriction, because when a block is preceded by up to
three spaces of indentation, the indentation can always be removed without
a change in interpretation, allowing rule #1 to be applied.  So, in
the above case:


-  foo

   bar
.
<ul>
<li>
<p>foo</p>
<p>bar</p>
</li>
</ul>



    

  1. Item starting with a blank line.  If a sequence of lines Ls
starting with a single [blank line] constitute a (possibly empty)
sequence of blocks Bs, and M is a list marker of width W,
then the result of prepending M to the first line of Ls, and
preceding subsequent lines of Ls by W + 1 spaces of indentation, is a
list item with Bs as its contents.
If a line is empty, then it need not be indented.  The type of the
list item (bullet or ordered) is determined by the type of its list
marker.  If the list item is ordered, then it is also assigned a
start number, based on the ordered list marker.
    2. 



Here are some list items that start with a blank line but are not empty:


-
  foo
-
  ```
  bar
  ```
-
      baz
.
<ul>
<li>foo</li>
<li>
<pre><code>bar
</code></pre>
</li>
<li>
<pre><code>baz
</code></pre>
</li>
</ul>



When the list item starts with a blank line, the number of spaces
following the list marker doesn't change the required indentation:


-   
  foo
.
<ul>
<li>foo</li>
</ul>



A list item can begin with at most one blank line.
In the following example, foo is not part of the list
item:


-

  foo
.
<ul>
<li></li>
</ul>
<p>foo</p>



Here is an empty bullet list item:


- foo
-
- bar
.
<ul>
<li>foo</li>
<li></li>
<li>bar</li>
</ul>



It does not matter whether there are spaces or tabs following the [list marker]:


- foo
-   
- bar
.
<ul>
<li>foo</li>
<li></li>
<li>bar</li>
</ul>



Here is an empty ordered list item:


1. foo
2.
3. bar
.
<ol>
<li>foo</li>
<li></li>
<li>bar</li>
</ol>



A list may start or end with an empty list item:


*
.
<ul>
<li></li>
</ul>



However, an empty list item cannot interrupt a paragraph:


foo
*

foo
1.
.
<p>foo
*</p>
<p>foo
1.</p>



    

  1. Indentation.  If a sequence of lines Ls constitutes a list item
according to rule #1, #2, or #3, then the result of preceding each line
of Ls by up to three spaces of indentation (the same for each line) also
constitutes a list item with the same contents and attributes.  If a line is
empty, then it need not be indented.
    2. 



Indented one space:


 1.  A paragraph
     with two lines.

         indented code

     > A block quote.
.
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>



Indented two spaces:


  1.  A paragraph
      with two lines.

          indented code

      > A block quote.
.
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>



Indented three spaces:


   1.  A paragraph
       with two lines.

           indented code

       > A block quote.
.
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>



Four spaces indent gives a code block:


    1.  A paragraph
        with two lines.

            indented code

        > A block quote.
.
<pre><code>1.  A paragraph
    with two lines.

        indented code

    &gt; A block quote.
</code></pre>



    

  1. Laziness.  If a string of lines Ls constitute a list
item with contents Bs, then the result of deleting
some or all of the indentation from one or more lines in which the
next character other than a space or tab after the indentation is
[paragraph continuation text] is a
list item with the same contents and attributes.  The unindented
lines are called
lazy continuation lines.
    2. 



Here is an example with [lazy continuation lines]:


  1.  A paragraph
with two lines.

          indented code

      > A block quote.
.
<ol>
<li>
<p>A paragraph
with two lines.</p>
<pre><code>indented code
</code></pre>
<blockquote>
<p>A block quote.</p>
</blockquote>
</li>
</ol>



Indentation can be partially deleted:


  1.  A paragraph
    with two lines.
.
<ol>
<li>A paragraph
with two lines.</li>
</ol>



These examples show how laziness can work in nested structures:


> 1. > Blockquote
continued here.
.
<blockquote>
<ol>
<li>
<blockquote>
<p>Blockquote
continued here.</p>
</blockquote>
</li>
</ol>
</blockquote>



> 1. > Blockquote
> continued here.
.
<blockquote>
<ol>
<li>
<blockquote>
<p>Blockquote
continued here.</p>
</blockquote>
</li>
</ol>
</blockquote>



    

  1. That's all. Nothing that is not counted as a list item by rules
#1--5 counts as a list item.
    2. 



The rules for sublists follow from the general rules
[above][List items].  A sublist must be indented the same number
of spaces of indentation a paragraph would need to be in order to be included
in the list item.


So, in this case we need two spaces indent:


- foo
  - bar
    - baz
      - boo
.
<ul>
<li>foo
<ul>
<li>bar
<ul>
<li>baz
<ul>
<li>boo</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>



One is not enough:


- foo
 - bar
  - baz
   - boo
.
<ul>
<li>foo</li>
<li>bar</li>
<li>baz</li>
<li>boo</li>
</ul>



Here we need four, because the list marker is wider:


10) foo
    - bar
.
<ol start="10">
<li>foo
<ul>
<li>bar</li>
</ul>
</li>
</ol>



Three is not enough:


10) foo
   - bar
.
<ol start="10">
<li>foo</li>
</ol>
<ul>
<li>bar</li>
</ul>



A list may be the first block in a list item:


- - foo
.
<ul>
<li>
<ul>
<li>foo</li>
</ul>
</li>
</ul>



1. - 2. foo
.
<ol>
<li>
<ul>
<li>
<ol start="2">
<li>foo</li>
</ol>
</li>
</ul>
</li>
</ol>



A list item can contain a heading:


- # Foo
- Bar
  ---
  baz
.
<ul>
<li>
<h1>Foo</h1>
</li>
<li>
<h2>Bar</h2>
baz</li>
</ul>



Motivation


John Gruber's Markdown spec says the following about list items:


    

  1. 

    "List markers typically start at the left margin, but may be indented
by up to three spaces. List markers must be followed by one or more
spaces or a tab."
    

    2. 

  2. 

    "To make lists look nice, you can wrap items with hanging indents....
But if you don't want to, you don't have to."
    

    3. 

  3. 

    "List items may consist of multiple paragraphs. Each subsequent
paragraph in a list item must be indented by either 4 spaces or one
tab."
    

    4. 

  4. 

    "It looks nice if you indent every line of the subsequent paragraphs,
but here again, Markdown will allow you to be lazy."
    

    5. 

  5. 

    "To put a blockquote within a list item, the blockquote's >
delimiters need to be indented."
    

    6. 

  6. 

    "To put a code block within a list item, the code block needs to be
indented twice — 8 spaces or two tabs."
    

    7. 



These rules specify that a paragraph under a list item must be indented
four spaces (presumably, from the left margin, rather than the start of
the list marker, but this is not said), and that code under a list item
must be indented eight spaces instead of the usual four.  They also say
that a block quote must be indented, but not by how much; however, the
example given has four spaces indentation.  Although nothing is said
about other kinds of block-level content, it is certainly reasonable to
infer that all block elements under a list item, including other
lists, must be indented four spaces.  This principle has been called the
four-space rule.


The four-space rule is clear and principled, and if the reference
implementation Markdown.pl had followed it, it probably would have
become the standard.  However, Markdown.pl allowed paragraphs and
sublists to start with only two spaces indentation, at least on the
outer level.  Worse, its behavior was inconsistent: a sublist of an
outer-level list needed two spaces indentation, but a sublist of this
sublist needed three spaces.  It is not surprising, then, that different
implementations of Markdown have developed very different rules for
determining what comes under a list item.  (Pandoc and python-Markdown,
for example, stuck with Gruber's syntax description and the four-space
rule, while discount, redcarpet, marked, PHP Markdown, and others
followed Markdown.pl's behavior more closely.)


Unfortunately, given the divergences between implementations, there
is no way to give a spec for list items that will be guaranteed not
to break any existing documents.  However, the spec given here should
correctly handle lists formatted with either the four-space rule or
the more forgiving Markdown.pl behavior, provided they are laid out
in a way that is natural for a human to read.


The strategy here is to let the width and indentation of the list marker
determine the indentation necessary for blocks to fall under the list
item, rather than having a fixed and arbitrary number.  The writer can
think of the body of the list item as a unit which gets indented to the
right enough to fit the list marker (and any indentation on the list
marker).  (The laziness rule, #5, then allows continuation lines to be
unindented if needed.)


This rule is superior, we claim, to any rule requiring a fixed level of
indentation from the margin.  The four-space rule is clear but
unnatural. It is quite unintuitive that


- foo

  bar

  - baz



should be parsed as two lists with an intervening paragraph,


<ul>
<li>foo</li>
</ul>
<p>bar</p>
<ul>
<li>baz</li>
</ul>



as the four-space rule demands, rather than a single list,


<ul>
<li>
<p>foo</p>
<p>bar</p>
<ul>
<li>baz</li>
</ul>
</li>
</ul>



The choice of four spaces is arbitrary.  It can be learned, but it is
not likely to be guessed, and it trips up beginners regularly.


Would it help to adopt a two-space rule?  The problem is that such
a rule, together with the rule allowing up to three spaces of indentation for
the initial list marker, allows text that is indented less than the
original list marker to be included in the list item. For example,
Markdown.pl parses


   - one

  two



as a single list item, with two a continuation paragraph:


<ul>
<li>
<p>one</p>
<p>two</p>
</li>
</ul>



and similarly


>   - one
>
>  two



as


<blockquote>
<ul>
<li>
<p>one</p>
<p>two</p>
</li>
</ul>
</blockquote>



This is extremely unintuitive.


Rather than requiring a fixed indent from the margin, we could require
a fixed indent (say, two spaces, or even one space) from the list marker (which
may itself be indented).  This proposal would remove the last anomaly
discussed.  Unlike the spec presented above, it would count the following
as a list item with a subparagraph, even though the paragraph bar
is not indented as far as the first paragraph foo:


 10. foo

   bar  



Arguably this text does read like a list item with bar as a subparagraph,
which may count in favor of the proposal.  However, on this proposal indented
code would have to be indented six spaces after the list marker.  And this
would break a lot of existing Markdown, which has the pattern:


1.  foo

        indented code



where the code is indented eight spaces.  The spec above, by contrast, will
parse this text as expected, since the code block's indentation is measured
from the beginning of foo.


The one case that needs special treatment is a list item that starts
with indented code.  How much indentation is required in that case, since
we don't have a "first paragraph" to measure from?  Rule #2 simply stipulates
that in such cases, we require one space indentation from the list marker
(and then the normal four spaces for the indented code).  This will match the
four-space rule in cases where the list marker plus its initial indentation
takes four spaces (a common case), but diverge in other cases.


Lists


A list is a sequence of one or more
list items [of the same type].  The list items
may be separated by any number of blank lines.


Two list items are of the same type
if they begin with a [list marker] of the same type.
Two list markers are of the
same type if (a) they are bullet list markers using the same character
(-, +, or *) or (b) they are ordered list numbers with the same
delimiter (either . or )).


A list is an ordered list
if its constituent list items begin with
[ordered list markers], and a
bullet list if its constituent list
items begin with [bullet list markers].


The start number
of an [ordered list] is determined by the list number of
its initial list item.  The numbers of subsequent list items are
disregarded.


A list is loose if any of its constituent
list items are separated by blank lines, or if any of its constituent
list items directly contain two block-level elements with a blank line
between them.  Otherwise a list is tight.
(The difference in HTML output is that paragraphs in a loose list are
wrapped in <p> tags, while paragraphs in a tight list are not.)


Changing the bullet or ordered list delimiter starts a new list:


- foo
- bar
+ baz
.
<ul>
<li>foo</li>
<li>bar</li>
</ul>
<ul>
<li>baz</li>
</ul>



1. foo
2. bar
3) baz
.
<ol>
<li>foo</li>
<li>bar</li>
</ol>
<ol start="3">
<li>baz</li>
</ol>



In CommonMark, a list can interrupt a paragraph. That is,
no blank line is needed to separate a paragraph from a following
list:


Foo
- bar
- baz
.
<p>Foo</p>
<ul>
<li>bar</li>
<li>baz</li>
</ul>



Markdown.pl does not allow this, through fear of triggering a list
via a numeral in a hard-wrapped line:


The number of windows in my house is
14.  The number of doors is 6.



Oddly, though, Markdown.pl does allow a blockquote to
interrupt a paragraph, even though the same considerations might
apply.


In CommonMark, we do allow lists to interrupt paragraphs, for
two reasons.  First, it is natural and not uncommon for people
to start lists without blank lines:


I need to buy
- new shoes
- a coat
- a plane ticket



Second, we are attracted to a




principle of uniformity:
if a chunk of text has a certain
meaning, it will continue to have the same meaning when put into a
container block (such as a list item or blockquote).




(Indeed, the spec for [list items] and [block quotes] presupposes
this principle.) This principle implies that if


  * I need to buy
    - new shoes
    - a coat
    - a plane ticket



is a list item containing a paragraph followed by a nested sublist,
as all Markdown implementations agree it is (though the paragraph
may be rendered without <p> tags, since the list is "tight"),
then


I need to buy
- new shoes
- a coat
- a plane ticket



by itself should be a paragraph followed by a nested sublist.


Since it is well established Markdown practice to allow lists to
interrupt paragraphs inside list items, the [principle of
uniformity] requires us to allow this outside list items as
well.  (reStructuredText
takes a different approach, requiring blank lines before lists
even inside other list items.)


In order to solve the problem of unwanted lists in paragraphs with
hard-wrapped numerals, we allow only lists starting with 1 to
interrupt paragraphs.  Thus,


The number of windows in my house is
14.  The number of doors is 6.
.
<p>The number of windows in my house is
14.  The number of doors is 6.</p>



We may still get an unintended result in cases like


The number of windows in my house is
1.  The number of doors is 6.
.
<p>The number of windows in my house is</p>
<ol>
<li>The number of doors is 6.</li>
</ol>



but this rule should prevent most spurious list captures.


There can be any number of blank lines between items:


- foo

- bar


- baz
.
<ul>
<li>
<p>foo</p>
</li>
<li>
<p>bar</p>
</li>
<li>
<p>baz</p>
</li>
</ul>



- foo
  - bar
    - baz


      bim
.
<ul>
<li>foo
<ul>
<li>bar
<ul>
<li>
<p>baz</p>
<p>bim</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>



To separate consecutive lists of the same type, or to separate a
list from an indented code block that would otherwise be parsed
as a subparagraph of the final list item, you can insert a blank HTML
comment:


- foo
- bar

<!-- -->

- baz
- bim
.
<ul>
<li>foo</li>
<li>bar</li>
</ul>
<!-- -->
<ul>
<li>baz</li>
<li>bim</li>
</ul>



-   foo

    notcode

-   foo

<!-- -->

    code
.
<ul>
<li>
<p>foo</p>
<p>notcode</p>
</li>
<li>
<p>foo</p>
</li>
</ul>
<!-- -->
<pre><code>code
</code></pre>



List items need not be indented to the same level.  The following
list items will be treated as items at the same list level,
since none is indented enough to belong to the previous list
item:


- a
 - b
  - c
   - d
  - e
 - f
- g
.
<ul>
<li>a</li>
<li>b</li>
<li>c</li>
<li>d</li>
<li>e</li>
<li>f</li>
<li>g</li>
</ul>



1. a

  2. b

   3. c
.
<ol>
<li>
<p>a</p>
</li>
<li>
<p>b</p>
</li>
<li>
<p>c</p>
</li>
</ol>



Note, however, that list items may not be preceded by more than
three spaces of indentation.  Here - e is treated as a paragraph continuation
line, because it is indented more than three spaces:


- a
 - b
  - c
   - d
    - e
.
<ul>
<li>a</li>
<li>b</li>
<li>c</li>
<li>d
- e</li>
</ul>



And here, 3. c is treated as in indented code block,
because it is indented four spaces and preceded by a
blank line.


1. a

  2. b

    3. c
.
<ol>
<li>
<p>a</p>
</li>
<li>
<p>b</p>
</li>
</ol>
<pre><code>3. c
</code></pre>



This is a loose list, because there is a blank line between
two of the list items:


- a
- b

- c
.
<ul>
<li>
<p>a</p>
</li>
<li>
<p>b</p>
</li>
<li>
<p>c</p>
</li>
</ul>



So is this, with a empty second item:


* a
*

* c
.
<ul>
<li>
<p>a</p>
</li>
<li></li>
<li>
<p>c</p>
</li>
</ul>



These are loose lists, even though there are no blank lines between the items,
because one of the items directly contains two block-level elements
with a blank line between them:


- a
- b

  c
- d
.
<ul>
<li>
<p>a</p>
</li>
<li>
<p>b</p>
<p>c</p>
</li>
<li>
<p>d</p>
</li>
</ul>



- a
- b

  [ref]: /url
- d
.
<ul>
<li>
<p>a</p>
</li>
<li>
<p>b</p>
</li>
<li>
<p>d</p>
</li>
</ul>



This is a tight list, because the blank lines are in a code block:


- a
- ```
  b


  ```
- c
.
<ul>
<li>a</li>
<li>
<pre><code>b


</code></pre>
</li>
<li>c</li>
</ul>



This is a tight list, because the blank line is between two
paragraphs of a sublist.  So the sublist is loose while
the outer list is tight:


- a
  - b

    c
- d
.
<ul>
<li>a
<ul>
<li>
<p>b</p>
<p>c</p>
</li>
</ul>
</li>
<li>d</li>
</ul>



This is a tight list, because the blank line is inside the
block quote:


* a
  > b
  >
* c
.
<ul>
<li>a
<blockquote>
<p>b</p>
</blockquote>
</li>
<li>c</li>
</ul>



This list is tight, because the consecutive block elements
are not separated by blank lines:


- a
  > b
  ```
  c
  ```
- d
.
<ul>
<li>a
<blockquote>
<p>b</p>
</blockquote>
<pre><code>c
</code></pre>
</li>
<li>d</li>
</ul>



A single-paragraph list is tight:


- a
.
<ul>
<li>a</li>
</ul>



- a
  - b
.
<ul>
<li>a
<ul>
<li>b</li>
</ul>
</li>
</ul>



This list is loose, because of the blank line between the
two block elements in the list item:


1. ```
   foo
   ```

   bar
.
<ol>
<li>
<pre><code>foo
</code></pre>
<p>bar</p>
</li>
</ol>



Here the outer list is loose, the inner list tight:


* foo
  * bar

  baz
.
<ul>
<li>
<p>foo</p>
<ul>
<li>bar</li>
</ul>
<p>baz</p>
</li>
</ul>



- a
  - b
  - c

- d
  - e
  - f
.
<ul>
<li>
<p>a</p>
<ul>
<li>b</li>
<li>c</li>
</ul>
</li>
<li>
<p>d</p>
<ul>
<li>e</li>
<li>f</li>
</ul>
</li>
</ul>



Inlines


Inlines are parsed sequentially from the beginning of the character
stream to the end (left to right, in left-to-right languages).
Thus, for example, in


`hi`lo`
.
<p><code>hi</code>lo`</p>



hi is parsed as code, leaving the backtick at the end as a literal
backtick.


Code spans


A backtick string
is a string of one or more backtick characters (`) that is neither
preceded nor followed by a backtick.


A code span begins with a backtick string and ends with
a backtick string of equal length.  The contents of the code span are
the characters between these two backtick strings, normalized in the
following ways:


    

  • First, [line endings] are converted to [spaces].
    • 

  • If the resulting string both begins and ends with a [space]
character, but does not consist entirely of [space]
characters, a single [space] character is removed from the
front and back.  This allows you to include code that begins
or ends with backtick characters, which must be separated by
whitespace from the opening or closing backtick strings.
    • 



This is a simple code span:


`foo`
.
<p><code>foo</code></p>



Here two backticks are used, because the code contains a backtick.
This example also illustrates stripping of a single leading and
trailing space:


`` foo ` bar ``
.
<p><code>foo ` bar</code></p>



This example shows the motivation for stripping leading and trailing
spaces:


` `` `
.
<p><code>``</code></p>



Note that only one space is stripped:


`  ``  `
.
<p><code> `` </code></p>



The stripping only happens if the space is on both
sides of the string:


` a`
.
<p><code> a</code></p>



Only [spaces], and not [unicode whitespace] in general, are
stripped in this way:


` b `
.
<p><code> b </code></p>



No stripping occurs if the code span contains only spaces:


` `
`  `
.
<p><code> </code>
<code>  </code></p>



[Line endings] are treated like spaces:


``
foo
bar  
baz
``
.
<p><code>foo bar   baz</code></p>



``
foo 
``
.
<p><code>foo </code></p>



Interior spaces are not collapsed:


`foo   bar 
baz`
.
<p><code>foo   bar  baz</code></p>



Note that browsers will typically collapse consecutive spaces
when rendering <code> elements, so it is recommended that
the following CSS be used:


code{white-space: pre-wrap;}



Note that backslash escapes do not work in code spans. All backslashes
are treated literally:


`foo\`bar`
.
<p><code>foo\</code>bar`</p>



Backslash escapes are never needed, because one can always choose a
string of n backtick characters as delimiters, where the code does
not contain any strings of exactly n backtick characters.


``foo`bar``
.
<p><code>foo`bar</code></p>



` foo `` bar `
.
<p><code>foo `` bar</code></p>



Code span backticks have higher precedence than any other inline
constructs except HTML tags and autolinks.  Thus, for example, this is
not parsed as emphasized text, since the second * is part of a code
span:


*foo`*`
.
<p>*foo<code>*</code></p>



And this is not parsed as a link:


[not a `link](/foo`)
.
<p>[not a <code>link](/foo</code>)</p>



Code spans, HTML tags, and autolinks have the same precedence.
Thus, this is code:


`<a href="`">`
.
<p><code>&lt;a href=&quot;</code>&quot;&gt;`</p>



But this is an HTML tag:


<a href="`">`
.
<p><a href="`">`</p>



And this is code:


`<https://foo.bar.`baz>`
.
<p><code>&lt;https://foo.bar.</code>baz&gt;`</p>



But this is an autolink:


<https://foo.bar.`baz>`
.
<p><a href="https://foo.bar.%60baz">https://foo.bar.`baz</a>`</p>



When a backtick string is not closed by a matching backtick string,
we just have literal backticks:


```foo``
.
<p>```foo``</p>



`foo
.
<p>`foo</p>



The following case also illustrates the need for opening and
closing backtick strings to be equal in length:


`foo``bar``
.
<p>`foo<code>bar</code></p>



Emphasis and strong emphasis


John Gruber's original Markdown syntax
description says:




Markdown treats asterisks (*) and underscores (_) as indicators of
emphasis. Text wrapped with one * or _ will be wrapped with an HTML
<em> tag; double *'s or _'s will be wrapped with an HTML <strong>
tag.




This is enough for most users, but these rules leave much undecided,
especially when it comes to nested emphasis.  The original
Markdown.pl test suite makes it clear that triple *** and
___ delimiters can be used for strong emphasis, and most
implementations have also allowed the following patterns:


***strong emph***
***strong** in emph*
***emph* in strong**
**in strong *emph***
*in emph **strong***



The following patterns are less widely supported, but the intent
is clear and they are useful (especially in contexts like bibliography
entries):


*emph *with emph* in it*
**strong **with strong** in it**



Many implementations have also restricted intraword emphasis to
the * forms, to avoid unwanted emphasis in words containing
internal underscores.  (It is best practice to put these in code
spans, but users often do not.)


internal emphasis: foo*bar*baz
no emphasis: foo_bar_baz



The rules given below capture all of these patterns, while allowing
for efficient parsing strategies that do not backtrack.


First, some definitions.  A delimiter run is either
a sequence of one or more * characters that is not preceded or
followed by a non-backslash-escaped * character, or a sequence
of one or more _ characters that is not preceded or followed by
a non-backslash-escaped _ character.


A left-flanking delimiter run is
a [delimiter run] that is (1) not followed by [Unicode whitespace],
and either (2a) not followed by a [Unicode punctuation character], or
(2b) followed by a [Unicode punctuation character] and
preceded by [Unicode whitespace] or a [Unicode punctuation character].
For purposes of this definition, the beginning and the end of
the line count as Unicode whitespace.


A right-flanking delimiter run is
a [delimiter run] that is (1) not preceded by [Unicode whitespace],
and either (2a) not preceded by a [Unicode punctuation character], or
(2b) preceded by a [Unicode punctuation character] and
followed by [Unicode whitespace] or a [Unicode punctuation character].
For purposes of this definition, the beginning and the end of
the line count as Unicode whitespace.


Here are some examples of delimiter runs.


    

  • 

    left-flanking but not right-flanking:
    

    ***abc
  _abc
**"abc"
 _"abc"

    

    • 

  • 

    right-flanking but not left-flanking:
    

     abc***
 abc_
"abc"**
"abc"_

    

    • 

  • 

    Both left and right-flanking:
    

     abc***def
"abc"_"def"

    

    • 

  • 

    Neither left nor right-flanking:
    

    abc *** def
a _ b

    

    • 



(The idea of distinguishing left-flanking and right-flanking
delimiter runs based on the character before and the character
after comes from Roopesh Chander's
vfmd.
vfmd uses the terminology "emphasis indicator string" instead of "delimiter
run," and its rules for distinguishing left- and right-flanking runs
are a bit more complex than the ones given here.)


The following rules define emphasis and strong emphasis:


    

  1. 

    A single * character can open emphasis
iff (if and only if) it is part of a [left-flanking delimiter run].
    

    2. 

  2. 

    A single _ character [can open emphasis] iff
it is part of a [left-flanking delimiter run]
and either (a) not part of a [right-flanking delimiter run]
or (b) part of a [right-flanking delimiter run]
preceded by a [Unicode punctuation character].
    

    3. 

  3. 

    A single * character can close emphasis
iff it is part of a [right-flanking delimiter run].
    

    4. 

  4. 

    A single _ character [can close emphasis] iff
it is part of a [right-flanking delimiter run]
and either (a) not part of a [left-flanking delimiter run]
or (b) part of a [left-flanking delimiter run]
followed by a [Unicode punctuation character].
    

    5. 

  5. 

    A double ** can open strong emphasis
iff it is part of a [left-flanking delimiter run].
    

    6. 

  6. 

    A double __ [can open strong emphasis] iff
it is part of a [left-flanking delimiter run]
and either (a) not part of a [right-flanking delimiter run]
or (b) part of a [right-flanking delimiter run]
preceded by a [Unicode punctuation character].
    

    7. 

  7. 

    A double ** can close strong emphasis
iff it is part of a [right-flanking delimiter run].
    

    8. 

  8. 

    A double __ [can close strong emphasis] iff
it is part of a [right-flanking delimiter run]
and either (a) not part of a [left-flanking delimiter run]
or (b) part of a [left-flanking delimiter run]
followed by a [Unicode punctuation character].
    

    9. 

  9. 

    Emphasis begins with a delimiter that [can open emphasis] and ends
with a delimiter that [can close emphasis], and that uses the same
character (_ or *) as the opening delimiter.  The
opening and closing delimiters must belong to separate
[delimiter runs].  If one of the delimiters can both
open and close emphasis, then the sum of the lengths of the
delimiter runs containing the opening and closing delimiters
must not be a multiple of 3 unless both lengths are
multiples of 3.
    

    10. 

  10. 

    Strong emphasis begins with a delimiter that
[can open strong emphasis] and ends with a delimiter that
[can close strong emphasis], and that uses the same character
(_ or *) as the opening delimiter.  The
opening and closing delimiters must belong to separate
[delimiter runs].  If one of the delimiters can both open
and close strong emphasis, then the sum of the lengths of
the delimiter runs containing the opening and closing
delimiters must not be a multiple of 3 unless both lengths
are multiples of 3.
    

    11. 

  11. 

    A literal * character cannot occur at the beginning or end of
*-delimited emphasis or **-delimited strong emphasis, unless it
is backslash-escaped.
    

    12. 

  12. 

    A literal _ character cannot occur at the beginning or end of
_-delimited emphasis or __-delimited strong emphasis, unless it
is backslash-escaped.
    

    13. 



Where rules 1--12 above are compatible with multiple parsings,
the following principles resolve ambiguity:


    

  1. 

    The number of nestings should be minimized. Thus, for example,
an interpretation <strong>...</strong> is always preferred to
<em><em>...</em></em>.
    

    2. 

  2. 

    An interpretation <em><strong>...</strong></em> is always
preferred to <strong><em>...</em></strong>.
    

    3. 

  3. 

    When two potential emphasis or strong emphasis spans overlap,
so that the second begins before the first ends and ends after
the first ends, the first takes precedence. Thus, for example,
*foo _bar* baz_ is parsed as <em>foo _bar</em> baz_ rather
than *foo <em>bar* baz</em>.
    

    4. 

  4. 

    When there are two potential emphasis or strong emphasis spans
with the same closing delimiter, the shorter one (the one that
opens later) takes precedence. Thus, for example,
**foo **bar baz** is parsed as **foo <strong>bar baz</strong>
rather than <strong>foo **bar baz</strong>.
    

    5. 

  5. 

    Inline code spans, links, images, and HTML tags group more tightly
than emphasis.  So, when there is a choice between an interpretation
that contains one of these elements and one that does not, the
former always wins.  Thus, for example, *[foo*](bar) is
parsed as *<a href="bar">foo*</a> rather than as
<em>[foo</em>](bar).
    

    6. 



These rules can be illustrated through a series of examples.


Rule 1:


*foo bar*
.
<p><em>foo bar</em></p>



This is not emphasis, because the opening * is followed by
whitespace, and hence not part of a [left-flanking delimiter run]:


a * foo bar*
.
<p>a * foo bar*</p>



This is not emphasis, because the opening * is preceded
by an alphanumeric and followed by punctuation, and hence
not part of a [left-flanking delimiter run]:


a*"foo"*
.
<p>a*&quot;foo&quot;*</p>



Unicode nonbreaking spaces count as whitespace, too:


* a *
.
<p>* a *</p>



Unicode symbols count as punctuation, too:


*$*alpha.

*£*bravo.

*€*charlie.
.
<p>*$*alpha.</p>
<p>*£*bravo.</p>
<p>*€*charlie.</p>



Intraword emphasis with * is permitted:


foo*bar*
.
<p>foo<em>bar</em></p>



5*6*78
.
<p>5<em>6</em>78</p>



Rule 2:


_foo bar_
.
<p><em>foo bar</em></p>



This is not emphasis, because the opening _ is followed by
whitespace:


_ foo bar_
.
<p>_ foo bar_</p>



This is not emphasis, because the opening _ is preceded
by an alphanumeric and followed by punctuation:


a_"foo"_
.
<p>a_&quot;foo&quot;_</p>



Emphasis with _ is not allowed inside words:


foo_bar_
.
<p>foo_bar_</p>



5_6_78
.
<p>5_6_78</p>



пристаням_стремятся_
.
<p>пристаням_стремятся_</p>



Here _ does not generate emphasis, because the first delimiter run
is right-flanking and the second left-flanking:


aa_"bb"_cc
.
<p>aa_&quot;bb&quot;_cc</p>



This is emphasis, even though the opening delimiter is
both left- and right-flanking, because it is preceded by
punctuation:


foo-_(bar)_
.
<p>foo-<em>(bar)</em></p>



Rule 3:


This is not emphasis, because the closing delimiter does
not match the opening delimiter:


_foo*
.
<p>_foo*</p>



This is not emphasis, because the closing * is preceded by
whitespace:


*foo bar *
.
<p>*foo bar *</p>



A line ending also counts as whitespace:


*foo bar
*
.
<p>*foo bar
*</p>



This is not emphasis, because the second * is
preceded by punctuation and followed by an alphanumeric
(hence it is not part of a [right-flanking delimiter run]:


*(*foo)
.
<p>*(*foo)</p>



The point of this restriction is more easily appreciated
with this example:


*(*foo*)*
.
<p><em>(<em>foo</em>)</em></p>



Intraword emphasis with * is allowed:


*foo*bar
.
<p><em>foo</em>bar</p>



Rule 4:


This is not emphasis, because the closing _ is preceded by
whitespace:


_foo bar _
.
<p>_foo bar _</p>



This is not emphasis, because the second _ is
preceded by punctuation and followed by an alphanumeric:


_(_foo)
.
<p>_(_foo)</p>



This is emphasis within emphasis:


_(_foo_)_
.
<p><em>(<em>foo</em>)</em></p>



Intraword emphasis is disallowed for _:


_foo_bar
.
<p>_foo_bar</p>



_пристаням_стремятся
.
<p>_пристаням_стремятся</p>



_foo_bar_baz_
.
<p><em>foo_bar_baz</em></p>



This is emphasis, even though the closing delimiter is
both left- and right-flanking, because it is followed by
punctuation:


_(bar)_.
.
<p><em>(bar)</em>.</p>



Rule 5:


**foo bar**
.
<p><strong>foo bar</strong></p>



This is not strong emphasis, because the opening delimiter is
followed by whitespace:


** foo bar**
.
<p>** foo bar**</p>



This is not strong emphasis, because the opening ** is preceded
by an alphanumeric and followed by punctuation, and hence
not part of a [left-flanking delimiter run]:


a**"foo"**
.
<p>a**&quot;foo&quot;**</p>



Intraword strong emphasis with ** is permitted:


foo**bar**
.
<p>foo<strong>bar</strong></p>



Rule 6:


__foo bar__
.
<p><strong>foo bar</strong></p>



This is not strong emphasis, because the opening delimiter is
followed by whitespace:


__ foo bar__
.
<p>__ foo bar__</p>



A line ending counts as whitespace:


__
foo bar__
.
<p>__
foo bar__</p>



This is not strong emphasis, because the opening __ is preceded
by an alphanumeric and followed by punctuation:


a__"foo"__
.
<p>a__&quot;foo&quot;__</p>



Intraword strong emphasis is forbidden with __:


foo__bar__
.
<p>foo__bar__</p>



5__6__78
.
<p>5__6__78</p>



пристаням__стремятся__
.
<p>пристаням__стремятся__</p>



__foo, __bar__, baz__
.
<p><strong>foo, <strong>bar</strong>, baz</strong></p>



This is strong emphasis, even though the opening delimiter is
both left- and right-flanking, because it is preceded by
punctuation:


foo-__(bar)__
.
<p>foo-<strong>(bar)</strong></p>



Rule 7:


This is not strong emphasis, because the closing delimiter is preceded
by whitespace:


**foo bar **
.
<p>**foo bar **</p>



(Nor can it be interpreted as an emphasized *foo bar *, because of
Rule 11.)


This is not strong emphasis, because the second ** is
preceded by punctuation and followed by an alphanumeric:


**(**foo)
.
<p>**(**foo)</p>



The point of this restriction is more easily appreciated
with these examples:


*(**foo**)*
.
<p><em>(<strong>foo</strong>)</em></p>



**Gomphocarpus (*Gomphocarpus physocarpus*, syn.
*Asclepias physocarpa*)**
.
<p><strong>Gomphocarpus (<em>Gomphocarpus physocarpus</em>, syn.
<em>Asclepias physocarpa</em>)</strong></p>



**foo "*bar*" foo**
.
<p><strong>foo &quot;<em>bar</em>&quot; foo</strong></p>



Intraword emphasis:


**foo**bar
.
<p><strong>foo</strong>bar</p>



Rule 8:


This is not strong emphasis, because the closing delimiter is
preceded by whitespace:


__foo bar __
.
<p>__foo bar __</p>



This is not strong emphasis, because the second __ is
preceded by punctuation and followed by an alphanumeric:


__(__foo)
.
<p>__(__foo)</p>



The point of this restriction is more easily appreciated
with this example:


_(__foo__)_
.
<p><em>(<strong>foo</strong>)</em></p>



Intraword strong emphasis is forbidden with __:


__foo__bar
.
<p>__foo__bar</p>



__пристаням__стремятся
.
<p>__пристаням__стремятся</p>



__foo__bar__baz__
.
<p><strong>foo__bar__baz</strong></p>



This is strong emphasis, even though the closing delimiter is
both left- and right-flanking, because it is followed by
punctuation:


__(bar)__.
.
<p><strong>(bar)</strong>.</p>



Rule 9:


Any nonempty sequence of inline elements can be the contents of an
emphasized span.


*foo [bar](/url)*
.
<p><em>foo <a href="/url">bar</a></em></p>



*foo
bar*
.
<p><em>foo
bar</em></p>



In particular, emphasis and strong emphasis can be nested
inside emphasis:


_foo __bar__ baz_
.
<p><em>foo <strong>bar</strong> baz</em></p>



_foo _bar_ baz_
.
<p><em>foo <em>bar</em> baz</em></p>



__foo_ bar_
.
<p><em><em>foo</em> bar</em></p>



*foo *bar**
.
<p><em>foo <em>bar</em></em></p>



*foo **bar** baz*
.
<p><em>foo <strong>bar</strong> baz</em></p>



*foo**bar**baz*
.
<p><em>foo<strong>bar</strong>baz</em></p>



Note that in the preceding case, the interpretation


<p><em>foo</em><em>bar<em></em>baz</em></p>



is precluded by the condition that a delimiter that
can both open and close (like the * after foo)
cannot form emphasis if the sum of the lengths of
the delimiter runs containing the opening and
closing delimiters is a multiple of 3 unless
both lengths are multiples of 3.


For the same reason, we don't get two consecutive
emphasis sections in this example:


*foo**bar*
.
<p><em>foo**bar</em></p>



The same condition ensures that the following
cases are all strong emphasis nested inside
emphasis, even when the interior whitespace is
omitted:


***foo** bar*
.
<p><em><strong>foo</strong> bar</em></p>



*foo **bar***
.
<p><em>foo <strong>bar</strong></em></p>



*foo**bar***
.
<p><em>foo<strong>bar</strong></em></p>



When the lengths of the interior closing and opening
delimiter runs are both multiples of 3, though,
they can match to create emphasis:


foo***bar***baz
.
<p>foo<em><strong>bar</strong></em>baz</p>



foo******bar*********baz
.
<p>foo<strong><strong><strong>bar</strong></strong></strong>***baz</p>



Indefinite levels of nesting are possible:


*foo **bar *baz* bim** bop*
.
<p><em>foo <strong>bar <em>baz</em> bim</strong> bop</em></p>



*foo [*bar*](/url)*
.
<p><em>foo <a href="/url"><em>bar</em></a></em></p>



There can be no empty emphasis or strong emphasis:


** is not an empty emphasis
.
<p>** is not an empty emphasis</p>



**** is not an empty strong emphasis
.
<p>**** is not an empty strong emphasis</p>



Rule 10:


Any nonempty sequence of inline elements can be the contents of an
strongly emphasized span.


**foo [bar](/url)**
.
<p><strong>foo <a href="/url">bar</a></strong></p>



**foo
bar**
.
<p><strong>foo
bar</strong></p>



In particular, emphasis and strong emphasis can be nested
inside strong emphasis:


__foo _bar_ baz__
.
<p><strong>foo <em>bar</em> baz</strong></p>



__foo __bar__ baz__
.
<p><strong>foo <strong>bar</strong> baz</strong></p>



____foo__ bar__
.
<p><strong><strong>foo</strong> bar</strong></p>



**foo **bar****
.
<p><strong>foo <strong>bar</strong></strong></p>



**foo *bar* baz**
.
<p><strong>foo <em>bar</em> baz</strong></p>



**foo*bar*baz**
.
<p><strong>foo<em>bar</em>baz</strong></p>



***foo* bar**
.
<p><strong><em>foo</em> bar</strong></p>



**foo *bar***
.
<p><strong>foo <em>bar</em></strong></p>



Indefinite levels of nesting are possible:


**foo *bar **baz**
bim* bop**
.
<p><strong>foo <em>bar <strong>baz</strong>
bim</em> bop</strong></p>



**foo [*bar*](/url)**
.
<p><strong>foo <a href="/url"><em>bar</em></a></strong></p>



There can be no empty emphasis or strong emphasis:


__ is not an empty emphasis
.
<p>__ is not an empty emphasis</p>



____ is not an empty strong emphasis
.
<p>____ is not an empty strong emphasis</p>



Rule 11:


foo ***
.
<p>foo ***</p>



foo *\**
.
<p>foo <em>*</em></p>



foo *_*
.
<p>foo <em>_</em></p>



foo *****
.
<p>foo *****</p>



foo **\***
.
<p>foo <strong>*</strong></p>



foo **_**
.
<p>foo <strong>_</strong></p>



Note that when delimiters do not match evenly, Rule 11 determines
that the excess literal * characters will appear outside of the
emphasis, rather than inside it:


**foo*
.
<p>*<em>foo</em></p>



*foo**
.
<p><em>foo</em>*</p>



***foo**
.
<p>*<strong>foo</strong></p>



****foo*
.
<p>***<em>foo</em></p>



**foo***
.
<p><strong>foo</strong>*</p>



*foo****
.
<p><em>foo</em>***</p>



Rule 12:


foo ___
.
<p>foo ___</p>



foo _\__
.
<p>foo <em>_</em></p>



foo _*_
.
<p>foo <em>*</em></p>



foo _____
.
<p>foo _____</p>



foo __\___
.
<p>foo <strong>_</strong></p>



foo __*__
.
<p>foo <strong>*</strong></p>



__foo_
.
<p>_<em>foo</em></p>



Note that when delimiters do not match evenly, Rule 12 determines
that the excess literal _ characters will appear outside of the
emphasis, rather than inside it:


_foo__
.
<p><em>foo</em>_</p>



___foo__
.
<p>_<strong>foo</strong></p>



____foo_
.
<p>___<em>foo</em></p>



__foo___
.
<p><strong>foo</strong>_</p>



_foo____
.
<p><em>foo</em>___</p>



Rule 13 implies that if you want emphasis nested directly inside
emphasis, you must use different delimiters:


**foo**
.
<p><strong>foo</strong></p>



*_foo_*
.
<p><em><em>foo</em></em></p>



__foo__
.
<p><strong>foo</strong></p>



_*foo*_
.
<p><em><em>foo</em></em></p>



However, strong emphasis within strong emphasis is possible without
switching delimiters:


****foo****
.
<p><strong><strong>foo</strong></strong></p>



____foo____
.
<p><strong><strong>foo</strong></strong></p>



Rule 13 can be applied to arbitrarily long sequences of
delimiters:


******foo******
.
<p><strong><strong><strong>foo</strong></strong></strong></p>



Rule 14:


***foo***
.
<p><em><strong>foo</strong></em></p>



_____foo_____
.
<p><em><strong><strong>foo</strong></strong></em></p>



Rule 15:


*foo _bar* baz_
.
<p><em>foo _bar</em> baz_</p>



*foo __bar *baz bim__ bam*
.
<p><em>foo <strong>bar *baz bim</strong> bam</em></p>



Rule 16:


**foo **bar baz**
.
<p>**foo <strong>bar baz</strong></p>



*foo *bar baz*
.
<p>*foo <em>bar baz</em></p>



Rule 17:


*[bar*](/url)
.
<p>*<a href="/url">bar*</a></p>



_foo [bar_](/url)
.
<p>_foo <a href="/url">bar_</a></p>



*<img src="foo" title="*"/>
.
<p>*<img src="foo" title="*"/></p>



**<a href="**">
.
<p>**<a href="**"></p>



__<a href="__">
.
<p>__<a href="__"></p>



*a `*`*
.
<p><em>a <code>*</code></em></p>



_a `_`_
.
<p><em>a <code>_</code></em></p>



**a<https://foo.bar/?q=**>
.
<p>**a<a href="https://foo.bar/?q=**">https://foo.bar/?q=**</a></p>



__a<https://foo.bar/?q=__>
.
<p>__a<a href="https://foo.bar/?q=__">https://foo.bar/?q=__</a></p>



Links


A link contains [link text] (the visible text), a [link destination]
(the URI that is the link destination), and optionally a [link title].
There are two basic kinds of links in Markdown.  In [inline links] the
destination and title are given immediately after the link text.  In
[reference links] the destination and title are defined elsewhere in
the document.


A link text consists of a sequence of zero or more
inline elements enclosed by square brackets ([ and ]).  The
following rules apply:


    

  • 

    Links may not contain other links, at any level of nesting. If
multiple otherwise valid link definitions appear nested inside each
other, the inner-most definition is used.
    

    • 

  • 

    Brackets are allowed in the [link text] only if (a) they
are backslash-escaped or (b) they appear as a matched pair of brackets,
with an open bracket [, a sequence of zero or more inlines, and
a close bracket ].
    

    • 

  • 

    Backtick [code spans], [autolinks], and raw [HTML tags] bind more tightly
than the brackets in link text.  Thus, for example,
[foo`]` could not be a link text, since the second ]
is part of a code span.
    

    • 

  • 

    The brackets in link text bind more tightly than markers for
[emphasis and strong emphasis]. Thus, for example, *[foo*](url) is a link.
    

    • 



A link destination consists of either


    

  • 

    a sequence of zero or more characters between an opening < and a
closing > that contains no line endings or unescaped
< or > characters, or
    

    • 

  • 

    a nonempty sequence of characters that does not start with <,
does not include [ASCII control characters][ASCII control character]
or [space] character, and includes parentheses only if (a) they are
backslash-escaped or (b) they are part of a balanced pair of
unescaped parentheses.
(Implementations may impose limits on parentheses nesting to
avoid performance issues, but at least three levels of nesting
should be supported.)
    

    • 



A link title  consists of either


    

  • 

    a sequence of zero or more characters between straight double-quote
characters ("), including a " character only if it is
backslash-escaped, or
    

    • 

  • 

    a sequence of zero or more characters between straight single-quote
characters ('), including a ' character only if it is
backslash-escaped, or
    

    • 

  • 

    a sequence of zero or more characters between matching parentheses
((...)), including a ( or ) character only if it is
backslash-escaped.
    

    • 



Although [link titles] may span multiple lines, they may not contain
a [blank line].


An inline link consists of a [link text] followed immediately
by a left parenthesis (, an optional [link destination], an optional
[link title], and a right parenthesis ).
These four components may be separated by spaces, tabs, and up to one line
ending.
If both [link destination] and [link title] are present, they must be
separated by spaces, tabs, and up to one line ending.


The link's text consists of the inlines contained
in the [link text] (excluding the enclosing square brackets).
The link's URI consists of the link destination, excluding enclosing
<...> if present, with backslash-escapes in effect as described
above.  The link's title consists of the link title, excluding its
enclosing delimiters, with backslash-escapes in effect as described
above.


Here is a simple inline link:


[link](/uri "title")
.
<p><a href="/uri" title="title">link</a></p>



The title, the link text and even
the destination may be omitted:


[link](/uri)
.
<p><a href="/uri">link</a></p>



[](./target.md)
.
<p><a href="./target.md"></a></p>



[link]()
.
<p><a href="">link</a></p>



[link](<>)
.
<p><a href="">link</a></p>



[]()
.
<p><a href=""></a></p>



The destination can only contain spaces if it is
enclosed in pointy brackets:


[link](/my uri)
.
<p>[link](/my uri)</p>



[link](</my uri>)
.
<p><a href="/my%20uri">link</a></p>



The destination cannot contain line endings,
even if enclosed in pointy brackets:


[link](foo
bar)
.
<p>[link](foo
bar)</p>



[link](<foo
bar>)
.
<p>[link](<foo
bar>)</p>



The destination can contain ) if it is enclosed
in pointy brackets:


[a](<b)c>)
.
<p><a href="b)c">a</a></p>



Pointy brackets that enclose links must be unescaped:


[link](<foo\>)
.
<p>[link](&lt;foo&gt;)</p>



These are not links, because the opening pointy bracket
is not matched properly:


[a](<b)c
[a](<b)c>
[a](<b>c)
.
<p>[a](&lt;b)c
[a](&lt;b)c&gt;
[a](<b>c)</p>



Parentheses inside the link destination may be escaped:


[link](\(foo\))
.
<p><a href="(foo)">link</a></p>



Any number of parentheses are allowed without escaping, as long as they are
balanced:


[link](foo(and(bar)))
.
<p><a href="foo(and(bar))">link</a></p>



However, if you have unbalanced parentheses, you need to escape or use the
<...> form:


[link](foo(and(bar))
.
<p>[link](foo(and(bar))</p>



[link](foo\(and\(bar\))
.
<p><a href="foo(and(bar)">link</a></p>



[link](<foo(and(bar)>)
.
<p><a href="foo(and(bar)">link</a></p>



Parentheses and other symbols can also be escaped, as usual
in Markdown:


[link](foo\)\:)
.
<p><a href="foo):">link</a></p>



A link can contain fragment identifiers and queries:


[link](#fragment)

[link](https://example.com#fragment)

[link](https://example.com?foo=3#frag)
.
<p><a href="#fragment">link</a></p>
<p><a href="https://example.com#fragment">link</a></p>
<p><a href="https://example.com?foo=3#frag">link</a></p>



Note that a backslash before a non-escapable character is
just a backslash:


[link](foo\bar)
.
<p><a href="foo%5Cbar">link</a></p>



URL-escaping should be left alone inside the destination, as all
URL-escaped characters are also valid URL characters. Entity and
numerical character references in the destination will be parsed
into the corresponding Unicode code points, as usual.  These may
be optionally URL-escaped when written as HTML, but this spec
does not enforce any particular policy for rendering URLs in
HTML or other formats.  Renderers may make different decisions
about how to escape or normalize URLs in the output.


[link](foo%20b&auml;)
.
<p><a href="foo%20b%C3%A4">link</a></p>



Note that, because titles can often be parsed as destinations,
if you try to omit the destination and keep the title, you'll
get unexpected results:


[link]("title")
.
<p><a href="%22title%22">link</a></p>



Titles may be in single quotes, double quotes, or parentheses:


[link](/url "title")
[link](/url 'title')
[link](/url (title))
.
<p><a href="/url" title="title">link</a>
<a href="/url" title="title">link</a>
<a href="/url" title="title">link</a></p>



Backslash escapes and entity and numeric character references
may be used in titles:


[link](/url "title \"&quot;")
.
<p><a href="/url" title="title &quot;&quot;">link</a></p>



Titles must be separated from the link using spaces, tabs, and up to one line
ending.
Other [Unicode whitespace] like non-breaking space doesn't work.


[link](/url "title")
.
<p><a href="/url%C2%A0%22title%22">link</a></p>



Nested balanced quotes are not allowed without escaping:


[link](/url "title "and" title")
.
<p>[link](/url &quot;title &quot;and&quot; title&quot;)</p>



But it is easy to work around this by using a different quote type:


[link](/url 'title "and" title')
.
<p><a href="/url" title="title &quot;and&quot; title">link</a></p>



(Note:  Markdown.pl did allow double quotes inside a double-quoted
title, and its test suite included a test demonstrating this.
But it is hard to see a good rationale for the extra complexity this
brings, since there are already many ways---backslash escaping,
entity and numeric character references, or using a different
quote type for the enclosing title---to write titles containing
double quotes.  Markdown.pl's handling of titles has a number
of other strange features.  For example, it allows single-quoted
titles in inline links, but not reference links.  And, in
reference links but not inline links, it allows a title to begin
with " and end with ).  Markdown.pl 1.0.1 even allows
titles with no closing quotation mark, though 1.0.2b8 does not.
It seems preferable to adopt a simple, rational rule that works
the same way in inline links and link reference definitions.)


Spaces, tabs, and up to one line ending is allowed around the destination and
title:


[link](   /uri
  "title"  )
.
<p><a href="/uri" title="title">link</a></p>



But it is not allowed between the link text and the
following parenthesis:


[link] (/uri)
.
<p>[link] (/uri)</p>



The link text may contain balanced brackets, but not unbalanced ones,
unless they are escaped:


[link [foo [bar]]](/uri)
.
<p><a href="/uri">link [foo [bar]]</a></p>



[link] bar](/uri)
.
<p>[link] bar](/uri)</p>



[link [bar](/uri)
.
<p>[link <a href="/uri">bar</a></p>



[link \[bar](/uri)
.
<p><a href="/uri">link [bar</a></p>



The link text may contain inline content:


[link *foo **bar** `#`*](/uri)
.
<p><a href="/uri">link <em>foo <strong>bar</strong> <code>#</code></em></a></p>



[![moon](moon.jpg)](/uri)
.
<p><a href="/uri"><img src="moon.jpg" alt="moon" /></a></p>



However, links may not contain other links, at any level of nesting.


[foo [bar](/uri)](/uri)
.
<p>[foo <a href="/uri">bar</a>](/uri)</p>



[foo *[bar [baz](/uri)](/uri)*](/uri)
.
<p>[foo <em>[bar <a href="/uri">baz</a>](/uri)</em>](/uri)</p>



![[[foo](uri1)](uri2)](uri3)
.
<p><img src="uri3" alt="[foo](uri2)" /></p>



These cases illustrate the precedence of link text grouping over
emphasis grouping:


*[foo*](/uri)
.
<p>*<a href="/uri">foo*</a></p>



[foo *bar](baz*)
.
<p><a href="baz*">foo *bar</a></p>



Note that brackets that aren't part of links do not take
precedence:


*foo [bar* baz]
.
<p><em>foo [bar</em> baz]</p>



These cases illustrate the precedence of HTML tags, code spans,
and autolinks over link grouping:


[foo <bar attr="](baz)">
.
<p>[foo <bar attr="](baz)"></p>



[foo`](/uri)`
.
<p>[foo<code>](/uri)</code></p>



[foo<https://example.com/?search=](uri)>
.
<p>[foo<a href="https://example.com/?search=%5D(uri)">https://example.com/?search=](uri)</a></p>



There are three kinds of reference links:
full, collapsed,
and shortcut.


A full reference link
consists of a [link text] immediately followed by a [link label]
that [matches] a [link reference definition] elsewhere in the document.


A link label  begins with a left bracket ([) and ends
with the first right bracket (]) that is not backslash-escaped.
Between these brackets there must be at least one character that is not a space,
tab, or line ending.
Unescaped square bracket characters are not allowed inside the
opening and closing square brackets of [link labels].  A link
label can have at most 999 characters inside the square
brackets.


One label matches
another just in case their normalized forms are equal.  To normalize a
label, strip off the opening and closing brackets,
perform the Unicode case fold, strip leading and trailing
spaces, tabs, and line endings, and collapse consecutive internal
spaces, tabs, and line endings to a single space.  If there are multiple
matching reference link definitions, the one that comes first in the
document is used.  (It is desirable in such cases to emit a warning.)


The link's URI and title are provided by the matching [link
reference definition].


Here is a simple example:


[foo][bar]

[bar]: /url "title"
.
<p><a href="/url" title="title">foo</a></p>



The rules for the [link text] are the same as with
[inline links].  Thus:


The link text may contain balanced brackets, but not unbalanced ones,
unless they are escaped:


[link [foo [bar]]][ref]

[ref]: /uri
.
<p><a href="/uri">link [foo [bar]]</a></p>



[link \[bar][ref]

[ref]: /uri
.
<p><a href="/uri">link [bar</a></p>



The link text may contain inline content:


[link *foo **bar** `#`*][ref]

[ref]: /uri
.
<p><a href="/uri">link <em>foo <strong>bar</strong> <code>#</code></em></a></p>



[![moon](moon.jpg)][ref]

[ref]: /uri
.
<p><a href="/uri"><img src="moon.jpg" alt="moon" /></a></p>



However, links may not contain other links, at any level of nesting.


[foo [bar](/uri)][ref]

[ref]: /uri
.
<p>[foo <a href="/uri">bar</a>]<a href="/uri">ref</a></p>



[foo *bar [baz][ref]*][ref]

[ref]: /uri
.
<p>[foo <em>bar <a href="/uri">baz</a></em>]<a href="/uri">ref</a></p>



(In the examples above, we have two [shortcut reference links]
instead of one [full reference link].)


The following cases illustrate the precedence of link text grouping over
emphasis grouping:


*[foo*][ref]

[ref]: /uri
.
<p>*<a href="/uri">foo*</a></p>



[foo *bar][ref]*

[ref]: /uri
.
<p><a href="/uri">foo *bar</a>*</p>



These cases illustrate the precedence of HTML tags, code spans,
and autolinks over link grouping:


[foo <bar attr="][ref]">

[ref]: /uri
.
<p>[foo <bar attr="][ref]"></p>



[foo`][ref]`

[ref]: /uri
.
<p>[foo<code>][ref]</code></p>



[foo<https://example.com/?search=][ref]>

[ref]: /uri
.
<p>[foo<a href="https://example.com/?search=%5D%5Bref%5D">https://example.com/?search=][ref]</a></p>



Matching is case-insensitive:


[foo][BaR]

[bar]: /url "title"
.
<p><a href="/url" title="title">foo</a></p>



Unicode case fold is used:


[ẞ]

[SS]: /url
.
<p><a href="/url">ẞ</a></p>



Consecutive internal spaces, tabs, and line endings are treated as one space for
purposes of determining matching:


[Foo
  bar]: /url

[Baz][Foo bar]
.
<p><a href="/url">Baz</a></p>



No spaces, tabs, or line endings are allowed between the [link text] and the
[link label]:


[foo] [bar]

[bar]: /url "title"
.
<p>[foo] <a href="/url" title="title">bar</a></p>



[foo]
[bar]

[bar]: /url "title"
.
<p>[foo]
<a href="/url" title="title">bar</a></p>



This is a departure from John Gruber's original Markdown syntax
description, which explicitly allows whitespace between the link
text and the link label.  It brings reference links in line with
[inline links], which (according to both original Markdown and
this spec) cannot have whitespace after the link text.  More
importantly, it prevents inadvertent capture of consecutive
[shortcut reference links]. If whitespace is allowed between the
link text and the link label, then in the following we will have
a single reference link, not two shortcut reference links, as
intended:


[foo]
[bar]

[foo]: /url1
[bar]: /url2



(Note that [shortcut reference links] were introduced by Gruber
himself in a beta version of Markdown.pl, but never included
in the official syntax description.  Without shortcut reference
links, it is harmless to allow space between the link text and
link label; but once shortcut references are introduced, it is
too dangerous to allow this, as it frequently leads to
unintended results.)


When there are multiple matching [link reference definitions],
the first is used:


[foo]: /url1

[foo]: /url2

[bar][foo]
.
<p><a href="/url1">bar</a></p>



Note that matching is performed on normalized strings, not parsed
inline content.  So the following does not match, even though the
labels define equivalent inline content:


[bar][foo\!]

[foo!]: /url
.
<p>[bar][foo!]</p>



[Link labels] cannot contain brackets, unless they are
backslash-escaped:


[foo][ref[]

[ref[]: /uri
.
<p>[foo][ref[]</p>
<p>[ref[]: /uri</p>



[foo][ref[bar]]

[ref[bar]]: /uri
.
<p>[foo][ref[bar]]</p>
<p>[ref[bar]]: /uri</p>



[[[foo]]]

[[[foo]]]: /url
.
<p>[[[foo]]]</p>
<p>[[[foo]]]: /url</p>



[foo][ref\[]

[ref\[]: /uri
.
<p><a href="/uri">foo</a></p>



Note that in this example ] is not backslash-escaped:


[bar\\]: /uri

[bar\\]
.
<p><a href="/uri">bar\</a></p>



A [link label] must contain at least one character that is not a space, tab, or
line ending:


[]

[]: /uri
.
<p>[]</p>
<p>[]: /uri</p>



[
 ]

[
 ]: /uri
.
<p>[
]</p>
<p>[
]: /uri</p>



A collapsed reference link
consists of a [link label] that [matches] a
[link reference definition] elsewhere in the
document, followed by the string [].
The contents of the link label are parsed as inlines,
which are used as the link's text.  The link's URI and title are
provided by the matching reference link definition.  Thus,
[foo][] is equivalent to [foo][foo].


[foo][]

[foo]: /url "title"
.
<p><a href="/url" title="title">foo</a></p>



[*foo* bar][]

[*foo* bar]: /url "title"
.
<p><a href="/url" title="title"><em>foo</em> bar</a></p>



The link labels are case-insensitive:


[Foo][]

[foo]: /url "title"
.
<p><a href="/url" title="title">Foo</a></p>



As with full reference links, spaces, tabs, or line endings are not
allowed between the two sets of brackets:


[foo] 
[]

[foo]: /url "title"
.
<p><a href="/url" title="title">foo</a>
[]</p>



A shortcut reference link
consists of a [link label] that [matches] a
[link reference definition] elsewhere in the
document and is not followed by [] or a link label.
The contents of the link label are parsed as inlines,
which are used as the link's text.  The link's URI and title
are provided by the matching link reference definition.
Thus, [foo] is equivalent to [foo][].


[foo]

[foo]: /url "title"
.
<p><a href="/url" title="title">foo</a></p>



[*foo* bar]

[*foo* bar]: /url "title"
.
<p><a href="/url" title="title"><em>foo</em> bar</a></p>



[[*foo* bar]]

[*foo* bar]: /url "title"
.
<p>[<a href="/url" title="title"><em>foo</em> bar</a>]</p>



[[bar [foo]

[foo]: /url
.
<p>[[bar <a href="/url">foo</a></p>



The link labels are case-insensitive:


[Foo]

[foo]: /url "title"
.
<p><a href="/url" title="title">Foo</a></p>



A space after the link text should be preserved:


[foo] bar

[foo]: /url
.
<p><a href="/url">foo</a> bar</p>



If you just want bracketed text, you can backslash-escape the
opening bracket to avoid links:


\[foo]

[foo]: /url "title"
.
<p>[foo]</p>



Note that this is a link, because a link label ends with the first
following closing bracket:


[foo*]: /url

*[foo*]
.
<p>*<a href="/url">foo*</a></p>



Full and collapsed references take precedence over shortcut
references:


[foo][bar]

[foo]: /url1
[bar]: /url2
.
<p><a href="/url2">foo</a></p>



[foo][]

[foo]: /url1
.
<p><a href="/url1">foo</a></p>



Inline links also take precedence:


[foo]()

[foo]: /url1
.
<p><a href="">foo</a></p>



[foo](not a link)

[foo]: /url1
.
<p><a href="/url1">foo</a>(not a link)</p>



In the following case [bar][baz] is parsed as a reference,
[foo] as normal text:


[foo][bar][baz]

[baz]: /url
.
<p>[foo]<a href="/url">bar</a></p>



Here, though, [foo][bar] is parsed as a reference, since
[bar] is defined:


[foo][bar][baz]

[baz]: /url1
[bar]: /url2
.
<p><a href="/url2">foo</a><a href="/url1">baz</a></p>



Here [foo] is not parsed as a shortcut reference, because it
is followed by a link label (even though [bar] is not defined):


[foo][bar][baz]

[baz]: /url1
[foo]: /url2
.
<p>[foo]<a href="/url1">bar</a></p>



Images


Syntax for images is like the syntax for links, with one
difference. Instead of [link text], we have an
image description.  The rules for this are the
same as for [link text], except that (a) an
image description starts with ![ rather than [, and
(b) an image description may contain links.
An image description has inline elements
as its contents.  When an image is rendered to HTML,
this is standardly used as the image's alt attribute.


![foo](/url "title")
.
<p><img src="/url" alt="foo" title="title" /></p>



![foo *bar*]

[foo *bar*]: train.jpg "train & tracks"
.
<p><img src="train.jpg" alt="foo bar" title="train &amp; tracks" /></p>



![foo ![bar](/url)](/url2)
.
<p><img src="/url2" alt="foo bar" /></p>



![foo [bar](/url)](/url2)
.
<p><img src="/url2" alt="foo bar" /></p>



Though this spec is concerned with parsing, not rendering, it is
recommended that in rendering to HTML, only the plain string content
of the [image description] be used.  Note that in
the above example, the alt attribute's value is foo bar, not foo [bar](/url) or foo <a href="/url">bar</a>.  Only the plain string
content is rendered, without formatting.


![foo *bar*][]

[foo *bar*]: train.jpg "train & tracks"
.
<p><img src="train.jpg" alt="foo bar" title="train &amp; tracks" /></p>



![foo *bar*][foobar]

[FOOBAR]: train.jpg "train & tracks"
.
<p><img src="train.jpg" alt="foo bar" title="train &amp; tracks" /></p>



![foo](train.jpg)
.
<p><img src="train.jpg" alt="foo" /></p>



My ![foo bar](/path/to/train.jpg  "title"   )
.
<p>My <img src="/path/to/train.jpg" alt="foo bar" title="title" /></p>



![foo](<url>)
.
<p><img src="url" alt="foo" /></p>



![](/url)
.
<p><img src="/url" alt="" /></p>



Reference-style:


![foo][bar]

[bar]: /url
.
<p><img src="/url" alt="foo" /></p>



![foo][bar]

[BAR]: /url
.
<p><img src="/url" alt="foo" /></p>



Collapsed:


![foo][]

[foo]: /url "title"
.
<p><img src="/url" alt="foo" title="title" /></p>



![*foo* bar][]

[*foo* bar]: /url "title"
.
<p><img src="/url" alt="foo bar" title="title" /></p>



The labels are case-insensitive:


![Foo][]

[foo]: /url "title"
.
<p><img src="/url" alt="Foo" title="title" /></p>



As with reference links, spaces, tabs, and line endings, are not allowed
between the two sets of brackets:


![foo] 
[]

[foo]: /url "title"
.
<p><img src="/url" alt="foo" title="title" />
[]</p>



Shortcut:


![foo]

[foo]: /url "title"
.
<p><img src="/url" alt="foo" title="title" /></p>



![*foo* bar]

[*foo* bar]: /url "title"
.
<p><img src="/url" alt="foo bar" title="title" /></p>



Note that link labels cannot contain unescaped brackets:


![[foo]]

[[foo]]: /url "title"
.
<p>![[foo]]</p>
<p>[[foo]]: /url &quot;title&quot;</p>



The link labels are case-insensitive:


![Foo]

[foo]: /url "title"
.
<p><img src="/url" alt="Foo" title="title" /></p>



If you just want a literal ! followed by bracketed text, you can
backslash-escape the opening [:


!\[foo]

[foo]: /url "title"
.
<p>![foo]</p>



If you want a link after a literal !, backslash-escape the
!:


\![foo]

[foo]: /url "title"
.
<p>!<a href="/url" title="title">foo</a></p>



Autolinks


Autolinks are absolute URIs and email addresses inside
< and >. They are parsed as links, with the URL or email address
as the link label.


A URI autolink consists of <, followed by an
[absolute URI] followed by >.  It is parsed as
a link to the URI, with the URI as the link's label.


An absolute URI,
for these purposes, consists of a [scheme] followed by a colon (:)
followed by zero or more characters other than [ASCII control
characters][ASCII control character], [space], <, and >.
If the URI includes these characters, they must be percent-encoded
(e.g. %20 for a space).


For purposes of this spec, a scheme is any sequence
of 2--32 characters beginning with an ASCII letter and followed
by any combination of ASCII letters, digits, or the symbols plus
("+"), period ("."), or hyphen ("-").


Here are some valid autolinks:


<http://foo.bar.baz>
.
<p><a href="http://foo.bar.baz">http://foo.bar.baz</a></p>



<https://foo.bar.baz/test?q=hello&id=22&boolean>
.
<p><a href="https://foo.bar.baz/test?q=hello&amp;id=22&amp;boolean">https://foo.bar.baz/test?q=hello&amp;id=22&amp;boolean</a></p>



<irc://foo.bar:2233/baz>
.
<p><a href="irc://foo.bar:2233/baz">irc://foo.bar:2233/baz</a></p>



Uppercase is also fine:


<MAILTO:FOO@BAR.BAZ>
.
<p><a href="MAILTO:FOO@BAR.BAZ">MAILTO:FOO@BAR.BAZ</a></p>



Note that many strings that count as [absolute URIs] for
purposes of this spec are not valid URIs, because their
schemes are not registered or because of other problems
with their syntax:


<a+b+c:d>
.
<p><a href="a+b+c:d">a+b+c:d</a></p>



<made-up-scheme://foo,bar>
.
<p><a href="made-up-scheme://foo,bar">made-up-scheme://foo,bar</a></p>



<https://../>
.
<p><a href="https://../">https://../</a></p>



<localhost:5001/foo>
.
<p><a href="localhost:5001/foo">localhost:5001/foo</a></p>



Spaces are not allowed in autolinks:


<https://foo.bar/baz bim>
.
<p>&lt;https://foo.bar/baz bim&gt;</p>



Backslash-escapes do not work inside autolinks:


<https://example.com/\[\>
.
<p><a href="https://example.com/%5C%5B%5C">https://example.com/\[\</a></p>



An email autolink
consists of <, followed by an [email address],
followed by >.  The link's label is the email address,
and the URL is mailto: followed by the email address.


An email address,
for these purposes, is anything that matches
the non-normative regex from the HTML5
spec:


/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?
(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/



Examples of email autolinks:


<foo@bar.example.com>
.
<p><a href="mailto:foo@bar.example.com">foo@bar.example.com</a></p>



<foo+special@Bar.baz-bar0.com>
.
<p><a href="mailto:foo+special@Bar.baz-bar0.com">foo+special@Bar.baz-bar0.com</a></p>



Backslash-escapes do not work inside email autolinks:


<foo\+@bar.example.com>
.
<p>&lt;foo+@bar.example.com&gt;</p>



These are not autolinks:


<>
.
<p>&lt;&gt;</p>



< https://foo.bar >
.
<p>&lt; https://foo.bar &gt;</p>



<m:abc>
.
<p>&lt;m:abc&gt;</p>



<foo.bar.baz>
.
<p>&lt;foo.bar.baz&gt;</p>



https://example.com
.
<p>https://example.com</p>



foo@bar.example.com
.
<p>foo@bar.example.com</p>



Raw HTML


Text between < and > that looks like an HTML tag is parsed as a
raw HTML tag and will be rendered in HTML without escaping.
Tag and attribute names are not limited to current HTML tags,
so custom tags (and even, say, DocBook tags) may be used.


Here is the grammar for tags:


A tag name consists of an ASCII letter
followed by zero or more ASCII letters, digits, or
hyphens (-).


An attribute consists of spaces, tabs, and up to one line ending,
an [attribute name], and an optional
[attribute value specification].


An attribute name
consists of an ASCII letter, _, or :, followed by zero or more ASCII
letters, digits, _, ., :, or -.  (Note:  This is the XML
specification restricted to ASCII.  HTML5 is laxer.)


An attribute value specification
consists of optional spaces, tabs, and up to one line ending,
a = character, optional spaces, tabs, and up to one line ending,
and an [attribute value].


An attribute value
consists of an [unquoted attribute value],
a [single-quoted attribute value], or a [double-quoted attribute value].


An unquoted attribute value
is a nonempty string of characters not
including spaces, tabs, line endings, ", ', =, <, >, or `.


A single-quoted attribute value
consists of ', zero or more
characters not including ', and a final '.


A double-quoted attribute value
consists of ", zero or more
characters not including ", and a final ".


An open tag consists of a < character, a [tag name],
zero or more [attributes], optional spaces, tabs, and up to one line ending,
an optional / character, and a > character.


A closing tag consists of the string </, a
[tag name], optional spaces, tabs, and up to one line ending, and the character
>.


An HTML comment consists of <!-->, <!--->, or  <!--, a string of
characters not including the string -->, and --> (see the
HTML spec).


A processing instruction
consists of the string <?, a string
of characters not including the string ?>, and the string
?>.


A declaration consists of the string <!, an ASCII letter, zero or more
characters not including the character >, and the character >.


A CDATA section consists of
the string <![CDATA[, a string of characters not including the string
]]>, and the string ]]>.


An HTML tag consists of an [open tag], a [closing tag],
an [HTML comment], a [processing instruction], a [declaration],
or a [CDATA section].


Here are some simple open tags:


<a><bab><c2c>
.
<p><a><bab><c2c></p>



Empty elements:


<a/><b2/>
.
<p><a/><b2/></p>



Whitespace is allowed:


<a  /><b2
data="foo" >
.
<p><a  /><b2
data="foo" ></p>



With attributes:


<a foo="bar" bam = 'baz <em>"</em>'
_boolean zoop:33=zoop:33 />
.
<p><a foo="bar" bam = 'baz <em>"</em>'
_boolean zoop:33=zoop:33 /></p>



Custom tag names can be used:


Foo <responsive-image src="foo.jpg" />
.
<p>Foo <responsive-image src="foo.jpg" /></p>



Illegal tag names, not parsed as HTML:


<33> <__>
.
<p>&lt;33&gt; &lt;__&gt;</p>



Illegal attribute names:


<a h*#ref="hi">
.
<p>&lt;a h*#ref=&quot;hi&quot;&gt;</p>



Illegal attribute values:


<a href="hi'> <a href=hi'>
.
<p>&lt;a href=&quot;hi'&gt; &lt;a href=hi'&gt;</p>



Illegal whitespace:


< a><
foo><bar/ >
<foo bar=baz
bim!bop />
.
<p>&lt; a&gt;&lt;
foo&gt;&lt;bar/ &gt;
&lt;foo bar=baz
bim!bop /&gt;</p>



Missing whitespace:


<a href='bar'title=title>
.
<p>&lt;a href='bar'title=title&gt;</p>



Closing tags:


</a></foo >
.
<p></a></foo ></p>



Illegal attributes in closing tag:


</a href="foo">
.
<p>&lt;/a href=&quot;foo&quot;&gt;</p>



Comments:


foo <!-- this is a --
comment - with hyphens -->
.
<p>foo <!-- this is a --
comment - with hyphens --></p>



foo <!--> foo -->

foo <!---> foo -->
.
<p>foo <!--> foo --&gt;</p>
<p>foo <!---> foo --&gt;</p>



Processing instructions:


foo <?php echo $a; ?>
.
<p>foo <?php echo $a; ?></p>



Declarations:


foo <!ELEMENT br EMPTY>
.
<p>foo <!ELEMENT br EMPTY></p>



CDATA sections:


foo <![CDATA[>&<]]>
.
<p>foo <![CDATA[>&<]]></p>



Entity and numeric character references are preserved in HTML
attributes:


foo <a href="&ouml;">
.
<p>foo <a href="&ouml;"></p>



Backslash escapes do not work in HTML attributes:


foo <a href="\*">
.
<p>foo <a href="\*"></p>



<a href="\"">
.
<p>&lt;a href=&quot;&quot;&quot;&gt;</p>



Hard line breaks


A line ending (not in a code span or HTML tag) that is preceded
by two or more spaces and does not occur at the end of a block
is parsed as a hard line break (rendered
in HTML as a <br /> tag):


foo  
baz
.
<p>foo<br />
baz</p>



For a more visible alternative, a backslash before the
[line ending] may be used instead of two or more spaces:


foo\
baz
.
<p>foo<br />
baz</p>



More than two spaces can be used:


foo       
baz
.
<p>foo<br />
baz</p>



Leading spaces at the beginning of the next line are ignored:


foo  
     bar
.
<p>foo<br />
bar</p>



foo\
     bar
.
<p>foo<br />
bar</p>



Hard line breaks can occur inside emphasis, links, and other constructs
that allow inline content:


*foo  
bar*
.
<p><em>foo<br />
bar</em></p>



*foo\
bar*
.
<p><em>foo<br />
bar</em></p>



Hard line breaks do not occur inside code spans


`code  
span`
.
<p><code>code   span</code></p>



`code\
span`
.
<p><code>code\ span</code></p>



or HTML tags:


<a href="foo  
bar">
.
<p><a href="foo  
bar"></p>



<a href="foo\
bar">
.
<p><a href="foo\
bar"></p>



Hard line breaks are for separating inline content within a block.
Neither syntax for hard line breaks works at the end of a paragraph or
other block element:


foo\
.
<p>foo\</p>



foo  
.
<p>foo</p>



### foo\
.
<h3>foo\</h3>



### foo  
.
<h3>foo</h3>



Soft line breaks


A regular line ending (not in a code span or HTML tag) that is not
preceded by two or more spaces or a backslash is parsed as a
softbreak.  (A soft line break may be rendered in HTML either as a
[line ending] or as a space. The result will be the same in
browsers. In the examples here, a [line ending] will be used.)


foo
baz
.
<p>foo
baz</p>



Spaces at the end of the line and beginning of the next line are
removed:


foo 
 baz
.
<p>foo
baz</p>



A conforming parser may render a soft line break in HTML either as a
line ending or as a space.


A renderer may also provide an option to render soft line breaks
as hard line breaks.


Textual content


Any characters not given an interpretation by the above rules will
be parsed as plain textual content.


hello $.;'there
.
<p>hello $.;'there</p>



Foo χρῆν
.
<p>Foo χρῆν</p>



Internal spaces are preserved verbatim:


Multiple     spaces
.
<p>Multiple     spaces</p>




Appendix: A parsing strategy


In this appendix we describe some features of the parsing strategy
used in the CommonMark reference implementations.


Overview


Parsing has two phases:


    

  1. 

    In the first phase, lines of input are consumed and the block
structure of the document---its division into paragraphs, block quotes,
list items, and so on---is constructed.  Text is assigned to these
blocks but not parsed. Link reference definitions are parsed and a
map of links is constructed.
    

    2. 

  2. 

    In the second phase, the raw text contents of paragraphs and headings
are parsed into sequences of Markdown inline elements (strings,
code spans, links, emphasis, and so on), using the map of link
references constructed in phase 1.
    

    3. 



At each point in processing, the document is represented as a tree of
blocks.  The root of the tree is a document block.  The document
may have any number of other blocks as children.  These children
may, in turn, have other blocks as children.  The last child of a block
is normally considered open, meaning that subsequent lines of input
can alter its contents.  (Blocks that are not open are closed.)
Here, for example, is a possible document tree, with the open blocks
marked by arrows:


-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
         list_item
           paragraph
             "Qui *quodsi iracundia*"
      -> list_item
        -> paragraph
             "aliquando id"



Phase 1: block structure


Each line that is processed has an effect on this tree.  The line is
analyzed and, depending on its contents, the document may be altered
in one or more of the following ways:


    

  1. One or more open blocks may be closed.
    2. 

  2. One or more new blocks may be created as children of the
last open block.
    3. 

  3. Text may be added to the last (deepest) open block remaining
on the tree.
    4. 



Once a line has been incorporated into the tree in this way,
it can be discarded, so input can be read in a stream.


For each line, we follow this procedure:


    

  1. 

    First we iterate through the open blocks, starting with the
root document, and descending through last children down to the last
open block.  Each block imposes a condition that the line must satisfy
if the block is to remain open.  For example, a block quote requires a
> character.  A paragraph requires a non-blank line.
In this phase we may match all or just some of the open
blocks.  But we cannot close unmatched blocks yet, because we may have a
[lazy continuation line].
    

    2. 

  2. 

    Next, after consuming the continuation markers for existing
blocks, we look for new block starts (e.g. > for a block quote).
If we encounter a new block start, we close any blocks unmatched
in step 1 before creating the new block as a child of the last
matched container block.
    

    3. 

  3. 

    Finally, we look at the remainder of the line (after block
markers like >, list markers, and indentation have been consumed).
This is text that can be incorporated into the last open
block (a paragraph, code block, heading, or raw HTML).
    

    4. 



Setext headings are formed when we see a line of a paragraph
that is a [setext heading underline].


Reference link definitions are detected when a paragraph is closed;
the accumulated text lines are parsed to see if they begin with
one or more reference link definitions.  Any remainder becomes a
normal paragraph.


We can see how this works by considering how the tree above is
generated by four lines of Markdown:


> Lorem ipsum dolor
sit amet.
> - Qui *quodsi iracundia*
> - aliquando id



At the outset, our document model is just


-> document



The first line of our text,


> Lorem ipsum dolor



causes a block_quote block to be created as a child of our
open document block, and a paragraph block as a child of
the block_quote.  Then the text is added to the last open
block, the paragraph:


-> document
  -> block_quote
    -> paragraph
         "Lorem ipsum dolor"



The next line,


sit amet.



is a "lazy continuation" of the open paragraph, so it gets added
to the paragraph's text:


-> document
  -> block_quote
    -> paragraph
         "Lorem ipsum dolor\nsit amet."



The third line,


> - Qui *quodsi iracundia*



causes the paragraph block to be closed, and a new list block
opened as a child of the block_quote.  A list_item is also
added as a child of the list, and a paragraph as a child of
the list_item.  The text is then added to the new paragraph:


-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
      -> list_item
        -> paragraph
             "Qui *quodsi iracundia*"



The fourth line,


> - aliquando id



causes the list_item (and its child the paragraph) to be closed,
and a new list_item opened up as child of the list.  A paragraph
is added as a child of the new list_item, to contain the text.
We thus obtain the final tree:


-> document
  -> block_quote
       paragraph
         "Lorem ipsum dolor\nsit amet."
    -> list (type=bullet tight=true bullet_char=-)
         list_item
           paragraph
             "Qui *quodsi iracundia*"
      -> list_item
        -> paragraph
             "aliquando id"



Phase 2: inline structure


Once all of the input has been parsed, all open blocks are closed.


We then "walk the tree," visiting every node, and parse raw
string contents of paragraphs and headings as inlines.  At this
point we have seen all the link reference definitions, so we can
resolve reference links as we go.


document
  block_quote
    paragraph
      str "Lorem ipsum dolor"
      softbreak
      str "sit amet."
    list (type=bullet tight=true bullet_char=-)
      list_item
        paragraph
          str "Qui "
          emph
            str "quodsi iracundia"
      list_item
        paragraph
          str "aliquando id"



Notice how the [line ending] in the first paragraph has
been parsed as a softbreak, and the asterisks in the first list item
have become an emph.


An algorithm for parsing nested emphasis and links


By far the trickiest part of inline parsing is handling emphasis,
strong emphasis, links, and images.  This is done using the following
algorithm.


When we're parsing inlines and we hit either


    

  • a run of * or _ characters, or
    • 

  • a [ or ![
    • 



we insert a text node with these symbols as its literal content, and we
add a pointer to this text node to the delimiter stack.


The [delimiter stack] is a doubly linked list.  Each
element contains a pointer to a text node, plus information about


    

  • the type of delimiter ([, ![, *, _)
    • 

  • the number of delimiters,
    • 

  • whether the delimiter is "active" (all are active to start), and
    • 

  • whether the delimiter is a potential opener, a potential closer,
or both (which depends on what sort of characters precede
and follow the delimiters).
    • 



When we hit a ] character, we call the look for link or image
procedure (see below).


When we hit the end of the input, we call the process emphasis
procedure (see below), with stack_bottom = NULL.


look for link or image


Starting at the top of the delimiter stack, we look backwards
through the stack for an opening [ or ![ delimiter.


    

  • 

    If we don't find one, we return a literal text node ].
    

    • 

  • 

    If we do find one, but it's not active, we remove the inactive
delimiter from the stack, and return a literal text node ].
    

    • 

  • 

    If we find one and it's active, then we parse ahead to see if
we have an inline link/image, reference link/image, collapsed reference
link/image, or shortcut reference link/image.
    

      

    • 

      If we don't, then we remove the opening delimiter from the
delimiter stack and return a literal text node ].
      

      • 

    • 

      If we do, then
      

        

      • 

        We return a link or image node whose children are the inlines
after the text node pointed to by the opening delimiter.
        

        • 

      • 

        We run process emphasis on these inlines, with the [ opener
as stack_bottom.
        

        • 

      • 

        We remove the opening delimiter.
        

        • 

      • 

        If we have a link (and not an image), we also set all
[ delimiters before the opening delimiter to inactive.  (This
will prevent us from getting links within links.)
        

        • 

      

      • 

    

    • 



process emphasis


Parameter stack_bottom sets a lower bound to how far we
descend in the [delimiter stack].  If it is NULL, we can
go all the way to the bottom.  Otherwise, we stop before
visiting stack_bottom.


Let current_position point to the element on the [delimiter stack]
just above stack_bottom (or the first element if stack_bottom
is NULL).


We keep track of the openers_bottom for each delimiter
type (*, _), indexed to the length of the closing delimiter run
(modulo 3) and to whether the closing delimiter can also be an
opener.  Initialize this to stack_bottom.


Then we repeat the following until we run out of potential
closers:


    

  • 

    Move current_position forward in the delimiter stack (if needed)
until we find the first potential closer with delimiter * or _.
(This will be the potential closer closest
to the beginning of the input -- the first one in parse order.)
    

    • 

  • 

    Now, look back in the stack (staying above stack_bottom and
the openers_bottom for this delimiter type) for the
first matching potential opener ("matching" means same delimiter).
    

    • 

  • 

    If one is found:
    

      

    • 

      Figure out whether we have emphasis or strong emphasis:
if both closer and opener spans have length >= 2, we have
strong, otherwise regular.
      

      • 

    • 

      Insert an emph or strong emph node accordingly, after
the text node corresponding to the opener.
      

      • 

    • 

      Remove any delimiters between the opener and closer from
the delimiter stack.
      

      • 

    • 

      Remove 1 (for regular emph) or 2 (for strong emph) delimiters
from the opening and closing text nodes.  If they become empty
as a result, remove them and remove the corresponding element
of the delimiter stack.  If the closing node is removed, reset
current_position to the next element in the stack.
      

      • 

    

    • 

  • 

    If none is found:
    

      

    • 

      Set openers_bottom to the element before current_position.
(We know that there are no openers for this kind of closer up to and
including this point, so this puts a lower bound on future searches.)
      

      • 

    • 

      If the closer at current_position is not a potential opener,
remove it from the delimiter stack (since we know it can't
be a closer either).
      

      • 

    • 

      Advance current_position to the next element in the stack.
      

      • 

    

    • 



After we're done, we remove all delimiters above stack_bottom from the
delimiter stack.

markdown-it-py-4.2.0/tests/test_fuzzer.py000066400000000000000000000015131517710005200204750ustar00rootroot00000000000000"""
These tests are in response to reports from:
https://github.com/google/oss-fuzz/tree/master/projects/markdown-it-py

In the future, perhaps atheris could be directly used here,
but it was not directly apparent how to integrate it into pytest.
"""

import pytest

from markdown_it import MarkdownIt

TESTS = {
    55363: (">```\n>", "
\n
\n
\n"),
    55367: (">-\n>\n>", "
\n
    \n
  • \n
\n
\n"),
    55371: ("[](soH0;!", "
[](so&#4H0;!
\n"),
    # 55401: (("?c_" * 100000) + "c_", ""),  TODO this does not fail, just takes a long time
}


@pytest.mark.parametrize("raw_input,expected", TESTS.values(), ids=TESTS.keys())
def test_fuzzing(raw_input, expected):
    md = MarkdownIt()
    md.parse(raw_input)
    assert md.render(raw_input) == expected
markdown-it-py-4.2.0/tests/test_linkify.py000066400000000000000000000012101517710005200206070ustar00rootroot00000000000000from markdown_it import MarkdownIt


def test_token_levels():
    mdit = MarkdownIt(options_update={"linkify": True}).enable("linkify")
    tokens = mdit.parse("www.python.org")
    inline = tokens[1]
    assert inline.type == "inline"
    assert inline.children
    link_open = inline.children[0]
    assert link_open.type == "link_open"
    link_text = inline.children[1]
    assert link_text.type == "text"
    link_close = inline.children[2]
    assert link_close.type == "link_close"

    # Assert that linkify tokens have correct nesting levels
    assert link_open.level == 0
    assert link_text.level == 1
    assert link_close.level == 0
markdown-it-py-4.2.0/tests/test_port/000077500000000000000000000000001517710005200175625ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_port/fixtures/000077500000000000000000000000001517710005200214335ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_port/fixtures/alerts.md000066400000000000000000000052251517710005200232530ustar00rootroot00000000000000Basic note alert
.
> [!NOTE]
> This is a note.
.



Note


This is a note.



.

Basic tip alert
.
> [!TIP]
> This is a tip.
.



Tip


This is a tip.



.

Basic important alert
.
> [!IMPORTANT]
> This is important.
.



Important


This is important.



.

Basic warning alert
.
> [!WARNING]
> This is a warning.
.



Warning


This is a warning.



.

Basic caution alert
.
> [!CAUTION]
> This is a caution.
.



Caution


This is a caution.



.

Case insensitive - lowercase
.
> [!note]
> Lowercase note.
.



Note


Lowercase note.



.

Case insensitive - mixed case
.
> [!Warning]
> Mixed case warning.
.



Warning


Mixed case warning.



.

Multi-paragraph content
.
> [!NOTE]
> First paragraph.
>
> Second paragraph.
.



Note


First paragraph.


Second paragraph.



.

Alert with inline formatting
.
> [!TIP]
> This has **bold** and *italic* text.
.



Tip


This has bold and italic text.



.

Not an alert - unknown type
.
> [!UNKNOWN]
> Not an alert.
.



[!UNKNOWN]
Not an alert.



.

Not an alert - text after marker on same line
.
> [!NOTE] extra text
> Content.
.



[!NOTE] extra text
Content.



.

Not an alert - not on first line
.
> Some text
> [!NOTE]
> More text.
.



Some text
[!NOTE]
More text.



.

Regular blockquote unchanged
.
> This is a regular blockquote.
.



This is a regular blockquote.



.

Empty alert (marker only)
.
> [!NOTE]
.



Note



.

Alert with list
.
> [!IMPORTANT]
> Things to do:
>
> - item one
> - item two
.



Important


Things to do:


    

  • item one
    • 

  • item two
    • 




.
markdown-it-py-4.2.0/tests/test_port/fixtures/commonmark_extras.md000066400000000000000000000210441517710005200255070ustar00rootroot00000000000000Issue commonmark/cmark#383:
.
*****Hello*world****
.

**Helloworld

.

Issue #246.  Double escaping in ALT
.
![&](#)
.

&

.

Strip markdown in ALT tags
.
![*strip* [markdown __in__ alt](#)](#)
.

strip markdown in alt

.

Issue #55:
.
![test]

![test](foo bar)
.

![test]


![test](foo bar)

.


Reference labels: 'i̇θωkå'.toUpperCase() is 'İΘΩKÅ', but these should still be equivalent
.
[İϴΩKÅ]

[i̇θωkå]: /url
.

İϴΩKÅ

.


Reference labels: support ligatures (equivalent according to unicode case folding)
.
[fffifl]

[fffifl]: /url
.

fffifl

.

Reference can be interrupted by other rules
.
[foo]: /url 'title
 - - -
'

[foo]
.

[foo]: /url 'title




'


[foo]

.

Escape character in link reference title doesn't escape newlines
.
[foo]: /url "
hello
\
\
\
world
"

[foo]
.

foo

.

Issue #35. `<` should work as punctuation
.
an **(:**

.

an (:

.


Should unescape only needed things in link destinations/titles:
.
[test](<\f\o\o\>\\>)

[test](foo "\\\"\b\a\r")
.

test


test

.


Not a closing tag
.

.

</ 123>

.



Escaping entities in links:
.
[](<"> "&ö")

[](<\"> "\&\ö")

[](<\\"> "\\"\\ö")
.






.


Checking combination of replaceEntities and unescapeMd:
.
~~~ &&bad;\&\\&
just a funny little fence
~~~
.

just a funny little fence


.

Underscore between punctuation chars should be able to close emphasis.

.
_(hai)_.
.

(hai).

.

Regression test, should not match emphasis markers in different link tags:
.
[*b]() [c*]()
.

*b c*

.

Those are two separate blockquotes:
.
 - > foo
  > bar
.

    

  • 

    

    foo
    

    

    • 





bar



.

Blockquote should terminate itself after paragraph continuation
.
- list
    > blockquote
blockquote continuation
    - next list item
.

    

  • list

    

    blockquote
blockquote continuation
    

    

      

    • next list item
      • 

    

    • 


.

Regression test (code block + regular paragraph)
.
>     foo
> bar
.



foo



bar



.

Regression test (tabs in lists, #830)
.
1. asd
    2. asd

---

1. asd
	2. asd
.

    

  1. asd
2. asd
    2. 





    

  1. asd
2. asd
    2. 


.

Blockquotes inside indented lists should terminate correctly
.
   - a
     > b
     ```
     c
     ```
   - d
.

    

  • a

    

    b
    

    

    c

    

    • 

  • d
    • 


.

Don't output empty class here:
.
``` 
test
```
.

test


.

Setext header text supports lazy continuations:
.
 - foo
bar
   ===
.

    

  • 

    foo
bar
    

    • 


.

But setext header underline doesn't:
.
 - foo
   bar
  ===
.

    

  • foo
bar
===
    • 


.

Tabs should be stripped from the beginning of the line
.
 foo
 bar
	baz
.

foo
bar
baz

.

Tabs should not cause hardbreak, EOL tabs aren't stripped in commonmark 0.27
.
foo1	
foo2    
bar
.

foo1	
foo2

bar

.

List item terminating quote should not be paragraph continuation
.
1. foo
   > quote
2. bar
.

    

  1. foo

    

    quote
    

    

    2. 

  2. bar
    3. 


.

Escaped space is not allowed in link destination, commonmark/CommonMark#493.
.
[link](a\ b)
.

[link](a\ b)

.

Link destination cannot contain '<'
.
[]()

[]()
.

[](<foo)



.

Link title cannot contain '(' when opened with it
.
[](url (xxx())

[](url (xxx\())
.

[](url (xxx())



.

Allow EOL in processing instructions, commonmark/commonmark.js#196.
.
a 
.

a 

.

Allow meta tag in an inline context, commonmark/commonmark-spec#527.
.
City:

  

.

City:




.

Coverage. Directive can terminate paragraph.
.
a
a

*
.

foo@bar.com

.


Coverage. Unpaired nested backtick (silent mode)
.
*`foo*
.

`foo

.


Coverage. Should continue scanning after closing "```" despite cache
.
```aaa``bbb``ccc```ddd``eee``
.

aaa``bbb``cccdddeee

.


Coverage. Entities.
.
*&*

* *

*&*
.

&


 


&

.


Coverage. Escape.
.
*\a*
.

\a

.


Coverage. parseLinkDestination
.
[foo](<
bar>)

[foo]([foo](<
bar>)


[foo](<bar)

.


Coverage. parseLinkTitle
.
[foo](bar "ba)

[foo](bar "ba\
z")
.

[foo](bar "ba)


foo

.


Coverage. Image
.
![test]( x )
.

test

.
.
![test][foo]

[bar]: 123
.

![test][foo]

.
.
![test][[[

[bar]: 123
.

![test][[[

.
.
![test](
.

![test](

.


Coverage. Link
.
[test](
.

[test](

.


Coverage. Reference
.
[
test\
]: 123
foo
bar
.

foo
bar

.
.
[
test
]
.

[
test
]

.
.
> [foo]: bar
[foo]
.



foo

.

Coverage. Tabs in blockquotes.
.
>		test

 >		test

  >		test

> ---
>		test

 > ---
 >		test

  > ---
  >		test

>			test

 >			test

  >			test

> ---
>			test

 > ---
 >			test

  > ---
  >			test
.



  test







 test







test









  test









 test









test







  	test







 	test







	test









  	test









 	test









	test




.

Coverage. Tabs in lists.
.
1. 	foo

	     bar
.

    

  1. 

    foo
    

     bar

    

    2. 


.

Coverage. Various tags not interrupting blockquotes because of indentation:
.
> foo
    - - - -

> foo
    # not a heading
.



foo
- - - -






foo
# not a heading



.

Coverage, entities with code > 10FFFF. Made this way for compatibility with commonmark.js.
.
�

�
.

�


&#x1100000;

.

Issue #696. Blockquotes should remember their level.
.
>>> foo
bar
>>> baz
.







foo
bar
baz







.

Issue #696. Blockquotes should stop when outdented from a list.
.
1. >>> foo
   bar
baz
   >>> foo
  >>> bar
   >>> baz
.

    

  1. 

    

    

    

    foo
bar
baz
foo
    

    

    

    

    2. 









bar
baz







.

Newline in image description
.
There is a newline in this image ![here
it is](https://github.com/executablebooks/)
.

There is a newline in this image here
it is

.

Issue #772. Header rule should not interfere with html tags.
.



==


.


==


.

Issue #205.  Space in link destination generates IndexError
.
[Contact](http:// mail.com)

[Contact](mailto: mail@mail.com)
.

[Contact](http:// mail.com)


[Contact](mailto: mail@mail.com)

.

Issue #204. Combination of blockquotes, list and newlines causes an IndexError
.
> QUOTE
+ UNORDERED LIST ITEM
  > INDENTED QUOTE



.



QUOTE




    

  • UNORDERED LIST ITEM

    

    INDENTED QUOTE
    

    

    • 


.
markdown-it-py-4.2.0/tests/test_port/fixtures/commonmark_spec.md000066400000000000000000002467341517710005200251520ustar00rootroot00000000000000~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 354

.
	foo	baz		bim
.

foo	baz		bim


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 361

.
  	foo	baz		bim
.

foo	baz		bim


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 368

.
    a	a
    ὐ	a
.

a	a
ὐ	a


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 381

.
  - foo

	bar
.

    

  • 

    foo
    

    bar
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 394

.
- foo

		bar
.

    

  • 

    foo
    

      bar

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 417

.
>		foo
.



  foo




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 426

.
-		foo
.

    

  • 

      foo

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 438

.
    foo
	bar
.

foo
bar


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 447

.
 - foo
   - bar
	 - baz
.

    

  • foo

      

    • bar

        

      • baz
        • 

      

      • 

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 465

.
#	Foo
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 471

.
*	*	*	
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 488

.
\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~
.

!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 498

.
\	\A\a\ \3\φ\«
.

\	\A\a\ \3\φ\«

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 508

.
\*not emphasized*
\
 not a tag
\[not a link](/foo)
\`not code`
1\. not a list
\* not a list
\# not a heading
\[foo]: /url "not a reference"
\ö not a character entity
.

*not emphasized*
<br/> not a tag
[not a link](/foo)
`not code`
1. not a list
* not a list
# not a heading
[foo]: /url "not a reference"
&ouml; not a character entity

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 533

.
\\*emphasis*
.

\emphasis

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 542

.
foo\
bar
.

foo

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 554

.
`` \[\` ``
.

\[\`

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 561

.
    \[\]
.

\[\]


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 569

.
~~~
\[\]
~~~
.

\[\]


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 579

.

.

https://example.com?find=\*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 586

.

.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 596

.
[foo](/bar\* "ti\*tle")
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 603

.
[foo]

[foo]: /bar\* "ti\*tle"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 612

.
``` foo\+bar
foo
```
.

foo


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 648

.
  & © Æ Ď
¾ ℋ ⅆ
∲ ≧̸
.

  & © Æ Ď
¾ ℋ ⅆ
∲ ≧̸

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 667

.
# Ӓ Ϡ �
.

# Ӓ Ϡ �

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 680

.
" ആ ಫ
.

" ആ ಫ

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 689

.
  &x; &#; &#x;
�
&#abcdef0;
&ThisIsNotDefined; &hi?;
.

&nbsp &x; &#; &#x;
&#87654321;
&#abcdef0;
&ThisIsNotDefined; &hi?;

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 706

.
©
.

&copy

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 716

.
&MadeUpEntity;
.

&MadeUpEntity;

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 727

.

.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 734

.
[foo](/föö "föö")
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 741

.
[foo]

[foo]: /föö "föö"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 750

.
``` föö
foo
```
.

foo


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 763

.
`föö`
.

f&ouml;&ouml;

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 770

.
    föfö
.

f&ouml;f&ouml;


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 782

.
*foo*
*foo*
.

*foo*
foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 790

.
* foo

* foo
.

* foo


    

  • foo
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 801

.
foo

bar
.

foo

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 809

.
	foo
.

	foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 816

.
[a](url "tit")
.

[a](url "tit")

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 839

.
- `one
- two`
.

    

  • `one
    • 

  • two`
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 878

.
***
---
___
.






.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 891

.
+++
.

+++

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 898

.
===
.

===

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 907

.
--
**
__
.

--
**
__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 920

.
 ***
  ***
   ***
.






.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 933

.
    ***
.

***


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 941

.
Foo
    ***
.

Foo
***

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 952

.
_____________________________________
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 961

.
 - - -
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 968

.
 **  * ** * ** * **
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 975

.
-     -      -      -
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 984

.
- - - -    
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 993

.
_ _ _ _ a

a------

---a---
.

_ _ _ _ a


a------


---a---

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1009

.
 *-*
.

-

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1018

.
- foo
***
- bar
.

    

  • foo
    • 





    

  • bar
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1035

.
Foo
***
bar
.

Foo




bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1052

.
Foo
---
bar
.

Foo


bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1065

.
* Foo
* * *
* Bar
.

    

  • Foo
    • 





    

  • Bar
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1082

.
- Foo
- * * *
.

    

  • Foo
    • 

  • 

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1111

.
# foo
## foo
### foo
#### foo
##### foo
###### foo
.

foo


foo


foo


foo


foo


foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1130

.
####### foo
.

####### foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1145

.
#5 bolt

#hashtag
.

#5 bolt


#hashtag

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1157

.
\## foo
.

## foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1166

.
# foo *bar* \*baz\*
.

foo bar *baz*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1175

.
#                  foo                     
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1184

.
 ### foo
  ## foo
   # foo
.

foo


foo


foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1197

.
    # foo
.

# foo


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1205

.
foo
    # bar
.

foo
# bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1216

.
## foo ##
  ###   bar    ###
.

foo


bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1227

.
# foo ##################################
##### foo ##
.

foo


foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1238

.
### foo ###     
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1249

.
### foo ### b
.

foo ### b

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1258

.
# foo#
.

foo#

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1268

.
### foo \###
## foo #\##
# foo \#
.

foo ###


foo ###


foo #

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1282

.
****
## foo
****
.



foo



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1293

.
Foo bar
# baz
Bar foo
.

Foo bar


baz


Bar foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1306

.
## 
#
### ###
.






.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1346

.
Foo *bar*
=========

Foo *bar*
---------
.

Foo bar


Foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1360

.
Foo *bar
baz*
====
.

Foo bar
baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1374

.
  Foo *bar
baz*	
====
.

Foo bar
baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1386

.
Foo
-------------------------

Foo
=
.

Foo


Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1401

.
   Foo
---

  Foo
-----

  Foo
  ===
.

Foo


Foo


Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1419

.
    Foo
    ---

    Foo
---
.

Foo
---

Foo




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1438

.
Foo
   ----      
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1448

.
Foo
    ---
.

Foo
---

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1459

.
Foo
= =

Foo
--- -
.

Foo
= =


Foo



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1475

.
Foo  
-----
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1485

.
Foo\
----
.

Foo\

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1496

.
`Foo
----
`


.

`Foo


`


<a title="a lot


of dashes"/>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1515

.
> Foo
---
.



Foo





.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1526

.
> foo
bar
===
.



foo
bar
===



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1539

.
- Foo
---
.

    

  • Foo
    • 




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1554

.
Foo
Bar
---
.

Foo
Bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1567

.
---
Foo
---
Bar
---
Baz
.



Foo


Bar


Baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1584

.

====
.

====

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1596

.
---
---
.




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1605

.
- foo
-----
.

    

  • foo
    • 




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1616

.
    foo
---
.

foo




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1626

.
> foo
-----
.



foo





.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1640

.
\> foo
------
.

> foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1671

.
Foo

bar
---
baz
.

Foo


bar


baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1687

.
Foo
bar

---

baz
.

Foo
bar




baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1705

.
Foo
bar
* * *
baz
.

Foo
bar




baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1720

.
Foo
bar
\---
baz
.

Foo
bar
---
baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1748

.
    a simple
      indented code block
.

a simple
  indented code block


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1762

.
  - foo

    bar
.

    

  • 

    foo
    

    bar
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1776

.
1.  foo

    - bar
.

    

  1. 

    foo
    

      

    • bar
      • 

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1796

.
    
    *hi*

    - one
.

<a/>
*hi*

- one


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1812

.
    chunk1

    chunk2
  
 
 
    chunk3
.

chunk1

chunk2



chunk3


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1835

.
    chunk1
      
      chunk2
.

chunk1
  
  chunk2


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1850

.
Foo
    bar

.

Foo
bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1864

.
    foo
bar
.

foo



bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1877

.
# Heading
    foo
Heading
------
    foo
----
.

Heading


foo



Heading


foo




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1897

.
        foo
    bar
.

    foo
bar


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1910

.

    
    foo
    

.

foo


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1924

.
    foo  
.

foo  


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1979

.
```
<
 >
```
.

<
 >


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 1993

.
~~~
<
 >
~~~
.

<
 >


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2006

.
``
foo
``
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2017

.
```
aaa
~~~
```
.

aaa
~~~


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2029

.
~~~
aaa
```
~~~
.

aaa
```


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2043

.
````
aaa
```
``````
.

aaa
```


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2055

.
~~~~
aaa
~~~
~~~~
.

aaa
~~~


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2070

.
```
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2077

.
`````

```
aaa
.


```
aaa


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2090

.
> ```
> aaa

bbb
.



aaa





bbb

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2106

.
```

  
```
.


  


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2120

.
```
```
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2132

.
 ```
 aaa
aaa
```
.

aaa
aaa


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2144

.
  ```
aaa
  aaa
aaa
  ```
.

aaa
aaa
aaa


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2158

.
   ```
   aaa
    aaa
  aaa
   ```
.

aaa
 aaa
aaa


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2174

.
    ```
    aaa
    ```
.

```
aaa
```


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2189

.
```
aaa
  ```
.

aaa


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2199

.
   ```
aaa
  ```
.

aaa


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2211

.
```
aaa
    ```
.

aaa
    ```


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2225

.
``` ```
aaa
.

 
aaa

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2234

.
~~~~~~
aaa
~~~ ~~
.

aaa
~~~ ~~


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2248

.
foo
```
bar
```
baz
.

foo


bar



baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2265

.
foo
---
~~~
bar
~~~
# baz
.

foo


bar



baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2287

.
```ruby
def foo(x)
  return 3
end
```
.

def foo(x)
  return 3
end


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2301

.
~~~~    ruby startline=3 $%@#$
def foo(x)
  return 3
end
~~~~~~~
.

def foo(x)
  return 3
end


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2315

.
````;
````
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2325

.
``` aa ```
foo
.

aa
foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2336

.
~~~ aa ``` ~~~
foo
~~~
.

foo


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2348

.
```
``` aaa
```
.

``` aaa


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2427

.



**Hello**,

_world_.




.



**Hello**,

world.




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2456

.


  

    
           hi
    
  




okay.
.


  

    
           hi
    
  




okay.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2478

.
 
*foo*
.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2502

.



*Markdown*



.



Markdown



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2518

.




.




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2529

.




.




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2541

.


*foo*

*bar*
.


*foo*

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2557

.

.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2597

.


foo


.


foo


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2614

.


``` c
int x = 33;
```
.


``` c
int x = 33;
```
.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2631

.

*bar*

.

*bar*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2644

.

*bar*

.

*bar*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2655

.

*bar*

.

*bar*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2666

.

*bar*
.

*bar*
.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2681

.

*foo*

.

*foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2696

.


*foo*


.


foo


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2714

.
*foo*
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2730

.


import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags


okay
.


import Text.HTML.TagSoup

main :: IO ()
main = print $ parseTags tags



okay

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2751

.

okay
.


okay

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2770

.

.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2790

.

okay
.


okay

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2813

.

*foo*
.


foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2864

.
*bar*
*baz*
.
*bar*

baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2876

.
1. *bar*
.
1. *bar*
.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2889

.

okay
.


okay

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2907

.
';

?>
okay
.
';

?>

okay

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2926

.

.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2935

.

okay
.


okay

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2969

.
  

    
.
  

<!-- foo -->


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2980

.
  


    

.
  


<div>


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 2994

.
Foo


bar


.

Foo



bar


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3011

.


bar


*foo*
.


bar


*foo*
.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3026

.
Foo

baz
.

Foo

baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3067

.



*Emphasized* text.



.



Emphasized text.



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3080

.


*Emphasized* text.


.


*Emphasized* text.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3102

.







Hi







.





Hi





.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3129

.



  


    
      Hi
    

  




.

<td>
  Hi
</td>


  


  



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3178

.
[foo]: /url "title"

[foo]
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3187

.
   [foo]: 
      /url  
           'the title'  

[foo]
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3198

.
[Foo*bar\]]:my_(url) 'title (with parens)'

[Foo*bar\]]
.

Foo*bar]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3207

.
[Foo bar]:

'title'

[Foo bar]
.

Foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3220

.
[foo]: /url '
title
line1
line2
'

[foo]
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3239

.
[foo]: /url 'title

with blank line'

[foo]
.

[foo]: /url 'title


with blank line'


[foo]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3254

.
[foo]:
/url

[foo]
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3266

.
[foo]:

[foo]
.

[foo]:


[foo]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3278

.
[foo]: <>

[foo]
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3289

.
[foo]: (baz)

[foo]
.

[foo]: (baz)


[foo]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3302

.
[foo]: /url\bar\*baz "foo\"bar\baz"

[foo]
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3313

.
[foo]

[foo]: url
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3325

.
[foo]

[foo]: first
[foo]: second
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3338

.
[FOO]: /url

[Foo]
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3347

.
[ΑΓΩ]: /φου

[αγω]
.

αγω

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3362

.
[foo]: /url
.
.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3370

.
[
foo
]: /url
bar
.

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3383

.
[foo]: /url "title" ok
.

[foo]: /url "title" ok

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3392

.
[foo]: /url
"title" ok
.

"title" ok

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3403

.
    [foo]: /url "title"

[foo]
.

[foo]: /url "title"



[foo]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3417

.
```
[foo]: /url
```

[foo]
.

[foo]: /url



[foo]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3432

.
Foo
[bar]: /baz

[bar]
.

Foo
[bar]: /baz


[bar]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3447

.
# [Foo]
[foo]: /url
> bar
.

Foo




bar



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3458

.
[foo]: /url
bar
===
[foo]
.

bar


foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3468

.
[foo]: /url
===
[foo]
.

===
foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3481

.
[foo]: /foo-url "foo"
[bar]: /bar-url
  "bar"
[baz]: /baz-url

[foo],
[bar],
[baz]
.

foo,
bar,
baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3502

.
[foo]

> [foo]: /url
.

foo





.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3524

.
aaa

bbb
.

aaa


bbb

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3536

.
aaa
bbb

ccc
ddd
.

aaa
bbb


ccc
ddd

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3552

.
aaa


bbb
.

aaa


bbb

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3565

.
  aaa
 bbb
.

aaa
bbb

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3577

.
aaa
             bbb
                                       ccc
.

aaa
bbb
ccc

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3591

.
   aaa
bbb
.

aaa
bbb

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3600

.
    aaa
bbb
.

aaa



bbb

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3614

.
aaa     
bbb     
.

aaa

bbb

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3631

.
  

aaa
  

# aaa

  
.

aaa


aaa

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3699

.
> # Foo
> bar
> baz
.



Foo


bar
baz



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3714

.
># Foo
>bar
> baz
.



Foo


bar
baz



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3729

.
   > # Foo
   > bar
 > baz
.



Foo


bar
baz



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3744

.
    > # Foo
    > bar
    > baz
.

> # Foo
> bar
> baz


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3759

.
> # Foo
> bar
baz
.



Foo


bar
baz



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3775

.
> bar
baz
> foo
.



bar
baz
foo



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3799

.
> foo
---
.



foo





.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3819

.
> - foo
- bar
.



    

  • foo
    • 





    

  • bar
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3837

.
>     foo
    bar
.



foo





bar


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3850

.
> ```
foo
```
.







foo



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3866

.
> foo
    - bar
.



foo
- bar



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3890

.
>
.




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3898

.
>
>  
> 
.




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3910

.
>
> foo
>  
.



foo



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3923

.
> foo

> bar
.



foo






bar



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3945

.
> foo
> bar
.



foo
bar



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3958

.
> foo
>
> bar
.



foo


bar



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3972

.
foo
> bar
.

foo




bar



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 3986

.
> aaa
***
> bbb
.



aaa








bbb



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4004

.
> bar
baz
.



bar
baz



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4015

.
> bar

baz
.



bar




baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4027

.
> bar
>
baz
.



bar




baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4043

.
> > > foo
bar
.







foo
bar







.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4058

.
>>> foo
> bar
>>baz
.







foo
bar
baz







.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4080

.
>     code

>    not code
.



code







not code



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4134

.
A paragraph
with two lines.

    indented code

> A block quote.
.

A paragraph
with two lines.


indented code





A block quote.



.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4156

.
1.  A paragraph
    with two lines.

        indented code

    > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4189

.
- one

 two
.

    

  • one
    • 



two

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4201

.
- one

  two
.

    

  • 

    one
    

    two
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4215

.
 -    one

     two
.

    

  • one
    • 



 two


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4228

.
 -    one

      two
.

    

  • 

    one
    

    two
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4250

.
   > > 1.  one
>>
>>     two
.





    

  1. 

    one
    

    two
    

    2. 






.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4277

.
>>- one
>>
  >  > two
.





    

  • one
    • 



two





.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4296

.
-one

2.two
.

-one


2.two

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4309

.
- foo


  bar
.

    

  • 

    foo
    

    bar
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4326

.
1.  foo

    ```
    bar
    ```

    baz

    > bam
.

    

  1. 

    foo
    

    bar

    

    baz
    

    

    bam
    

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4354

.
- Foo

      bar


      baz
.

    

  • 

    Foo
    

    bar


baz

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4376

.
123456789. ok
.

    

  1. ok
    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4385

.
1234567890. not ok
.

1234567890. not ok

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4394

.
0. ok
.

    

  1. ok
    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4403

.
003. ok
.

    

  1. ok
    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4414

.
-1. not ok
.

-1. not ok

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4437

.
- foo

      bar
.

    

  • 

    foo
    

    bar

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4454

.
  10.  foo

           bar
.

    

  1. 

    foo
    

    bar

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4473

.
    indented code

paragraph

    more code
.

indented code



paragraph


more code


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4488

.
1.     indented code

   paragraph

       more code
.

    

  1. 

    indented code

    

    paragraph
    

    more code

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4510

.
1.      indented code

   paragraph

       more code
.

    

  1. 

     indented code

    

    paragraph
    

    more code

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4537

.
   foo

bar
.

foo


bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4547

.
-    foo

  bar
.

    

  • foo
    • 



bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4564

.
-  foo

   bar
.

    

  • 

    foo
    

    bar
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4591

.
-
  foo
-
  ```
  bar
  ```
-
      baz
.

    

  • foo
    • 

  • 

    bar

    

    • 

  • 

    baz

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4617

.
-   
  foo
.

    

  • foo
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4631

.
-

  foo
.

    

  • 



foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4645

.
- foo
-
- bar
.

    

  • foo
    • 

  • 

  • bar
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4660

.
- foo
-   
- bar
.

    

  • foo
    • 

  • 

  • bar
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4675

.
1. foo
2.
3. bar
.

    

  1. foo
    2. 

  2. 

  3. bar
    4. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4690

.
*
.

    

  • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4700

.
foo
*

foo
1.
.

foo
*


foo
1.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4722

.
 1.  A paragraph
     with two lines.

         indented code

     > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4746

.
  1.  A paragraph
      with two lines.

          indented code

      > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4770

.
   1.  A paragraph
       with two lines.

           indented code

       > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4794

.
    1.  A paragraph
        with two lines.

            indented code

        > A block quote.
.

1.  A paragraph
    with two lines.

        indented code

    > A block quote.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4824

.
  1.  A paragraph
with two lines.

          indented code

      > A block quote.
.

    

  1. 

    A paragraph
with two lines.
    

    indented code

    

    

    A block quote.
    

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4848

.
  1.  A paragraph
    with two lines.
.

    

  1. A paragraph
with two lines.
    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4861

.
> 1. > Blockquote
continued here.
.



    

  1. 

    

    Blockquote
continued here.
    

    

    2. 




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4878

.
> 1. > Blockquote
> continued here.
.



    

  1. 

    

    Blockquote
continued here.
    

    

    2. 




.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4906

.
- foo
  - bar
    - baz
      - boo
.

    

  • foo

      

    • bar

        

      • baz

          

        • boo
          • 

        

        • 

      

      • 

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4932

.
- foo
 - bar
  - baz
   - boo
.

    

  • foo
    • 

  • bar
    • 

  • baz
    • 

  • boo
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4949

.
10) foo
    - bar
.

    

  1. foo

      

    • bar
      • 

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4965

.
10) foo
   - bar
.

    

  1. foo
    2. 



    

  • bar
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4980

.
- - foo
.

    

  • 

      

    • foo
      • 

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 4993

.
1. - 2. foo
.

    

  1. 

      

    • 

        

      1. foo
        2. 

      

      • 

    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5012

.
- # Foo
- Bar
  ---
  baz
.

    

  • 

    Foo
    

    • 

  • 

    Bar
    
baz
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5248

.
- foo
- bar
+ baz
.

    

  • foo
    • 

  • bar
    • 



    

  • baz
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5263

.
1. foo
2. bar
3) baz
.

    

  1. foo
    2. 

  2. bar
    3. 



    

  1. baz
    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5282

.
Foo
- bar
- baz
.

Foo


    

  • bar
    • 

  • baz
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5359

.
The number of windows in my house is
14.  The number of doors is 6.
.

The number of windows in my house is
14.  The number of doors is 6.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5369

.
The number of windows in my house is
1.  The number of doors is 6.
.

The number of windows in my house is


    

  1. The number of doors is 6.
    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5383

.
- foo

- bar


- baz
.

    

  • 

    foo
    

    • 

  • 

    bar
    

    • 

  • 

    baz
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5404

.
- foo
  - bar
    - baz


      bim
.

    

  • foo

      

    • bar

        

      • 

        baz
        

        bim
        

        • 

      

      • 

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5434

.
- foo
- bar



- baz
- bim
.

    

  • foo
    • 

  • bar
    • 




    

  • baz
    • 

  • bim
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5455

.
-   foo

    notcode

-   foo



    code
.

    

  • 

    foo
    

    notcode
    

    • 

  • 

    foo
    

    • 




code


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5486

.
- a
 - b
  - c
   - d
  - e
 - f
- g
.

    

  • a
    • 

  • b
    • 

  • c
    • 

  • d
    • 

  • e
    • 

  • f
    • 

  • g
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5507

.
1. a

  2. b

   3. c
.

    

  1. 

    a
    

    2. 

  2. 

    b
    

    3. 

  3. 

    c
    

    4. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5531

.
- a
 - b
  - c
   - d
    - e
.

    

  • a
    • 

  • b
    • 

  • c
    • 

  • d
- e
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5551

.
1. a

  2. b

    3. c
.

    

  1. 

    a
    

    2. 

  2. 

    b
    

    3. 



3. c


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5574

.
- a
- b

- c
.

    

  • 

    a
    

    • 

  • 

    b
    

    • 

  • 

    c
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5596

.
* a
*

* c
.

    

  • 

    a
    

    • 

  • 

  • 

    c
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5618

.
- a
- b

  c
- d
.

    

  • 

    a
    

    • 

  • 

    b
    

    c
    

    • 

  • 

    d
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5640

.
- a
- b

  [ref]: /url
- d
.

    

  • 

    a
    

    • 

  • 

    b
    

    • 

  • 

    d
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5663

.
- a
- ```
  b


  ```
- c
.

    

  • a
    • 

  • 

    b



    

    • 

  • c
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5689

.
- a
  - b

    c
- d
.

    

  • a

      

    • 

      b
      

      c
      

      • 

    

    • 

  • d
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5713

.
* a
  > b
  >
* c
.

    

  • a

    

    b
    

    

    • 

  • c
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5733

.
- a
  > b
  ```
  c
  ```
- d
.

    

  • a

    

    b
    

    

    c

    

    • 

  • d
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5756

.
- a
.

    

  • a
    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5765

.
- a
  - b
.

    

  • a

      

    • b
      • 

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5782

.
1. ```
   foo
   ```

   bar
.

    

  1. 

    foo

    

    bar
    

    2. 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5801

.
* foo
  * bar

  baz
.

    

  • 

    foo
    

      

    • bar
      • 

    

    baz
    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5819

.
- a
  - b
  - c

- d
  - e
  - f
.

    

  • 

    a
    

      

    • b
      • 

    • c
      • 

    

    • 

  • 

    d
    

      

    • e
      • 

    • f
      • 

    

    • 


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5853

.
`hi`lo`
.

hilo`

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5885

.
`foo`
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5896

.
`` foo ` bar ``
.

foo ` bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5906

.
` `` `
.

``

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5914

.
`  ``  `
.

 `` 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5923

.
` a`
.

 a

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5932

.
` b `
.

 b 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5940

.
` `
`  `
.

 
  

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5951

.
``
foo
bar  
baz
``
.

foo bar   baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5961

.
``
foo 
``
.

foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5972

.
`foo   bar 
baz`
.

foo   bar  baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 5989

.
`foo\`bar`
.

foo\bar`

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6000

.
``foo`bar``
.

foo`bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6006

.
` foo `` bar `
.

foo `` bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6018

.
*foo`*`
.

*foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6027

.
[not a `link](/foo`)
.

[not a link](/foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6037

.
``
.

<a href="">`

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6046

.
`
.

`

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6055

.
``
.

<https://foo.bar.baz>`

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6064

.
`
.

https://foo.bar.`baz`

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6074

.
```foo``
.

```foo``

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6081

.
`foo
.

`foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6090

.
`foo``bar``
.

`foobar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6307

.
*foo bar*
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6317

.
a * foo bar*
.

a * foo bar*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6328

.
a*"foo"*
.

a*"foo"*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6337

.
* a *
.

* a *

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6346

.
*$*alpha.

*£*bravo.

*€*charlie.
.

*$*alpha.


*£*bravo.


*€*charlie.

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6361

.
foo*bar*
.

foobar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6368

.
5*6*78
.

5678

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6377

.
_foo bar_
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6387

.
_ foo bar_
.

_ foo bar_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6397

.
a_"foo"_
.

a_"foo"_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6406

.
foo_bar_
.

foo_bar_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6413

.
5_6_78
.

5_6_78

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6420

.
пристаням_стремятся_
.

пристаням_стремятся_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6430

.
aa_"bb"_cc
.

aa_"bb"_cc

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6441

.
foo-_(bar)_
.

foo-(bar)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6453

.
_foo*
.

_foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6463

.
*foo bar *
.

*foo bar *

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6472

.
*foo bar
*
.

*foo bar
*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6485

.
*(*foo)
.

*(*foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6495

.
*(*foo*)*
.

(foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6504

.
*foo*bar
.

foobar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6517

.
_foo bar _
.

_foo bar _

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6527

.
_(_foo)
.

_(_foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6536

.
_(_foo_)_
.

(foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6545

.
_foo_bar
.

_foo_bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6552

.
_пристаням_стремятся
.

_пристаням_стремятся

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6559

.
_foo_bar_baz_
.

foo_bar_baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6570

.
_(bar)_.
.

(bar).

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6579

.
**foo bar**
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6589

.
** foo bar**
.

** foo bar**

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6600

.
a**"foo"**
.

a**"foo"**

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6609

.
foo**bar**
.

foobar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6618

.
__foo bar__
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6628

.
__ foo bar__
.

__ foo bar__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6636

.
__
foo bar__
.

__
foo bar__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6648

.
a__"foo"__
.

a__"foo"__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6657

.
foo__bar__
.

foo__bar__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6664

.
5__6__78
.

5__6__78

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6671

.
пристаням__стремятся__
.

пристаням__стремятся__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6678

.
__foo, __bar__, baz__
.

foo, bar, baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6689

.
foo-__(bar)__
.

foo-(bar)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6702

.
**foo bar **
.

**foo bar **

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6715

.
**(**foo)
.

**(**foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6725

.
*(**foo**)*
.

(foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6732

.
**Gomphocarpus (*Gomphocarpus physocarpus*, syn.
*Asclepias physocarpa*)**
.

Gomphocarpus (Gomphocarpus physocarpus, syn.
Asclepias physocarpa)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6741

.
**foo "*bar*" foo**
.

foo "bar" foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6750

.
**foo**bar
.

foobar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6762

.
__foo bar __
.

__foo bar __

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6772

.
__(__foo)
.

__(__foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6782

.
_(__foo__)_
.

(foo)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6791

.
__foo__bar
.

__foo__bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6798

.
__пристаням__стремятся
.

__пристаням__стремятся

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6805

.
__foo__bar__baz__
.

foo__bar__baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6816

.
__(bar)__.
.

(bar).

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6828

.
*foo [bar](/url)*
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6835

.
*foo
bar*
.

foo
bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6847

.
_foo __bar__ baz_
.

foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6854

.
_foo _bar_ baz_
.

foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6861

.
__foo_ bar_
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6868

.
*foo *bar**
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6875

.
*foo **bar** baz*
.

foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6881

.
*foo**bar**baz*
.

foobarbaz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6905

.
*foo**bar*
.

foo**bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6918

.
***foo** bar*
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6925

.
*foo **bar***
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6932

.
*foo**bar***
.

foobar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6943

.
foo***bar***baz
.

foobarbaz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6949

.
foo******bar*********baz
.

foobar***baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6958

.
*foo **bar *baz* bim** bop*
.

foo bar baz bim bop

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6965

.
*foo [*bar*](/url)*
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6974

.
** is not an empty emphasis
.

** is not an empty emphasis

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6981

.
**** is not an empty strong emphasis
.

**** is not an empty strong emphasis

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 6994

.
**foo [bar](/url)**
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7001

.
**foo
bar**
.

foo
bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7013

.
__foo _bar_ baz__
.

foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7020

.
__foo __bar__ baz__
.

foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7027

.
____foo__ bar__
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7034

.
**foo **bar****
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7041

.
**foo *bar* baz**
.

foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7048

.
**foo*bar*baz**
.

foobarbaz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7055

.
***foo* bar**
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7062

.
**foo *bar***
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7071

.
**foo *bar **baz**
bim* bop**
.

foo bar baz
bim bop

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7080

.
**foo [*bar*](/url)**
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7089

.
__ is not an empty emphasis
.

__ is not an empty emphasis

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7096

.
____ is not an empty strong emphasis
.

____ is not an empty strong emphasis

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7106

.
foo ***
.

foo ***

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7113

.
foo *\**
.

foo *

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7120

.
foo *_*
.

foo _

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7127

.
foo *****
.

foo *****

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7134

.
foo **\***
.

foo *

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7141

.
foo **_**
.

foo _

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7152

.
**foo*
.

*foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7159

.
*foo**
.

foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7166

.
***foo**
.

*foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7173

.
****foo*
.

***foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7180

.
**foo***
.

foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7187

.
*foo****
.

foo***

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7197

.
foo ___
.

foo ___

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7204

.
foo _\__
.

foo _

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7211

.
foo _*_
.

foo *

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7218

.
foo _____
.

foo _____

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7225

.
foo __\___
.

foo _

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7232

.
foo __*__
.

foo *

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7239

.
__foo_
.

_foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7250

.
_foo__
.

foo_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7257

.
___foo__
.

_foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7264

.
____foo_
.

___foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7271

.
__foo___
.

foo_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7278

.
_foo____
.

foo___

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7288

.
**foo**
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7295

.
*_foo_*
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7302

.
__foo__
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7309

.
_*foo*_
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7319

.
****foo****
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7326

.
____foo____
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7337

.
******foo******
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7346

.
***foo***
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7353

.
_____foo_____
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7362

.
*foo _bar* baz_
.

foo _bar baz_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7369

.
*foo __bar *baz bim__ bam*
.

foo bar *baz bim bam

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7378

.
**foo **bar baz**
.

**foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7385

.
*foo *bar baz*
.

*foo bar baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7394

.
*[bar*](/url)
.

*bar*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7401

.
_foo [bar_](/url)
.

_foo bar_

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7408

.
*
.

*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7415

.
**
.

**

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7422

.
__
.

__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7429

.
*a `*`*
.

a *

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7436

.
_a `_`_
.

a _

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7443

.
**a
.

**ahttps://foo.bar/?q=**

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7450

.
__a
.

__ahttps://foo.bar/?q=__

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7538

.
[link](/uri "title")
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7548

.
[link](/uri)
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7554

.
[](./target.md)
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7561

.
[link]()
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7568

.
[link](<>)
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7575

.
[]()
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7584

.
[link](/my uri)
.

[link](/my uri)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7590

.
[link]()
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7599

.
[link](foo
bar)
.

[link](foo
bar)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7607

.
[link]()
.

[link]()

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7618

.
[a]()
.

a

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7626

.
[link]()
.

[link](<foo>)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7635

.
[a](
[a](c)
.

[a](<b)c
[a](<b)c>
[a](c)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7647

.
[link](\(foo\))
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7656

.
[link](foo(and(bar)))
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7665

.
[link](foo(and(bar))
.

[link](foo(and(bar))

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7672

.
[link](foo\(and\(bar\))
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7679

.
[link]()
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7689

.
[link](foo\)\:)
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7698

.
[link](#fragment)

[link](https://example.com#fragment)

[link](https://example.com?foo=3#frag)
.

link


link


link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7714

.
[link](foo\bar)
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7730

.
[link](foo%20bä)
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7741

.
[link]("title")
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7750

.
[link](/url "title")
[link](/url 'title')
[link](/url (title))
.

link
link
link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7764

.
[link](/url "title \""")
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7775

.
[link](/url "title")
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7784

.
[link](/url "title "and" title")
.

[link](/url "title "and" title")

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7793

.
[link](/url 'title "and" title')
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7818

.
[link](   /uri
  "title"  )
.

link

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7829

.
[link] (/uri)
.

[link] (/uri)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7839

.
[link [foo [bar]]](/uri)
.

link [foo [bar]]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7846

.
[link] bar](/uri)
.

[link] bar](/uri)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7853

.
[link [bar](/uri)
.

[link bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7860

.
[link \[bar](/uri)
.

link [bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7869

.
[link *foo **bar** `#`*](/uri)
.

link foo bar #

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7876

.
[![moon](moon.jpg)](/uri)
.

moon

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7885

.
[foo [bar](/uri)](/uri)
.

[foo bar](/uri)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7892

.
[foo *[bar [baz](/uri)](/uri)*](/uri)
.

[foo [bar baz](/uri)](/uri)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7899

.
![[[foo](uri1)](uri2)](uri3)
.

[foo](uri2)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7909

.
*[foo*](/uri)
.

*foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7916

.
[foo *bar](baz*)
.

foo *bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7926

.
*foo [bar* baz]
.

foo [bar baz]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7936

.
[foo 
.

[foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7943

.
[foo`](/uri)`
.

[foo](/uri)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7950

.
[foo
.

[foohttps://example.com/?search=](uri)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 7988

.
[foo][bar]

[bar]: /url "title"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8003

.
[link [foo [bar]]][ref]

[ref]: /uri
.

link [foo [bar]]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8012

.
[link \[bar][ref]

[ref]: /uri
.

link [bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8023

.
[link *foo **bar** `#`*][ref]

[ref]: /uri
.

link foo bar #

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8032

.
[![moon](moon.jpg)][ref]

[ref]: /uri
.

moon

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8043

.
[foo [bar](/uri)][ref]

[ref]: /uri
.

[foo bar]ref

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8052

.
[foo *bar [baz][ref]*][ref]

[ref]: /uri
.

[foo bar baz]ref

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8067

.
*[foo*][ref]

[ref]: /uri
.

*foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8076

.
[foo *bar][ref]*

[ref]: /uri
.

foo *bar*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8088

.
[foo 

[ref]: /uri
.

[foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8097

.
[foo`][ref]`

[ref]: /uri
.

[foo][ref]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8106

.
[foo

[ref]: /uri
.

[foohttps://example.com/?search=][ref]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8117

.
[foo][BaR]

[bar]: /url "title"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8128

.
[ẞ]

[SS]: /url
.

ẞ

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8140

.
[Foo
  bar]: /url

[Baz][Foo bar]
.

Baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8153

.
[foo] [bar]

[bar]: /url "title"
.

[foo] bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8162

.
[foo]
[bar]

[bar]: /url "title"
.

[foo]
bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8203

.
[foo]: /url1

[foo]: /url2

[bar][foo]
.

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8218

.
[bar][foo\!]

[foo!]: /url
.

[bar][foo!]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8230

.
[foo][ref[]

[ref[]: /uri
.

[foo][ref[]


[ref[]: /uri

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8240

.
[foo][ref[bar]]

[ref[bar]]: /uri
.

[foo][ref[bar]]


[ref[bar]]: /uri

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8250

.
[[[foo]]]

[[[foo]]]: /url
.

[[[foo]]]


[[[foo]]]: /url

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8260

.
[foo][ref\[]

[ref\[]: /uri
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8271

.
[bar\\]: /uri

[bar\\]
.

bar\

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8283

.
[]

[]: /uri
.

[]


[]: /uri

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8293

.
[
 ]

[
 ]: /uri
.

[
]


[
]: /uri

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8316

.
[foo][]

[foo]: /url "title"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8325

.
[*foo* bar][]

[*foo* bar]: /url "title"
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8336

.
[Foo][]

[foo]: /url "title"
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8349

.
[foo] 
[]

[foo]: /url "title"
.

foo
[]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8369

.
[foo]

[foo]: /url "title"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8378

.
[*foo* bar]

[*foo* bar]: /url "title"
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8387

.
[[*foo* bar]]

[*foo* bar]: /url "title"
.

[foo bar]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8396

.
[[bar [foo]

[foo]: /url
.

[[bar foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8407

.
[Foo]

[foo]: /url "title"
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8418

.
[foo] bar

[foo]: /url
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8430

.
\[foo]

[foo]: /url "title"
.

[foo]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8442

.
[foo*]: /url

*[foo*]
.

*foo*

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8454

.
[foo][bar]

[foo]: /url1
[bar]: /url2
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8463

.
[foo][]

[foo]: /url1
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8473

.
[foo]()

[foo]: /url1
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8481

.
[foo](not a link)

[foo]: /url1
.

foo(not a link)

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8492

.
[foo][bar][baz]

[baz]: /url
.

[foo]bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8504

.
[foo][bar][baz]

[baz]: /url1
[bar]: /url2
.

foobaz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8517

.
[foo][bar][baz]

[baz]: /url1
[foo]: /url2
.

[foo]bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8540

.
![foo](/url "title")
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8547

.
![foo *bar*]

[foo *bar*]: train.jpg "train & tracks"
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8556

.
![foo ![bar](/url)](/url2)
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8563

.
![foo [bar](/url)](/url2)
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8577

.
![foo *bar*][]

[foo *bar*]: train.jpg "train & tracks"
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8586

.
![foo *bar*][foobar]

[FOOBAR]: train.jpg "train & tracks"
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8595

.
![foo](train.jpg)
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8602

.
My ![foo bar](/path/to/train.jpg  "title"   )
.

My foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8609

.
![foo]()
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8616

.
![](/url)
.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8625

.
![foo][bar]

[bar]: /url
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8634

.
![foo][bar]

[BAR]: /url
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8645

.
![foo][]

[foo]: /url "title"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8654

.
![*foo* bar][]

[*foo* bar]: /url "title"
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8665

.
![Foo][]

[foo]: /url "title"
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8677

.
![foo] 
[]

[foo]: /url "title"
.

foo
[]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8690

.
![foo]

[foo]: /url "title"
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8699

.
![*foo* bar]

[*foo* bar]: /url "title"
.

foo bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8710

.
![[foo]]

[[foo]]: /url "title"
.

![[foo]]


[[foo]]: /url "title"

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8722

.
![Foo]

[foo]: /url "title"
.

Foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8734

.
!\[foo]

[foo]: /url "title"
.

![foo]

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8746

.
\![foo]

[foo]: /url "title"
.

!foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8779

.

.

http://foo.bar.baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8786

.

.

https://foo.bar.baz/test?q=hello&id=22&boolean

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8793

.

.

irc://foo.bar:2233/baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8802

.

.

MAILTO:FOO@BAR.BAZ

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8814

.

.

a+b+c:d

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8821

.

.

made-up-scheme://foo,bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8828

.

.

https://../

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8835

.

.

localhost:5001/foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8844

.

.

<https://foo.bar/baz bim>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8853

.

.

https://example.com/\[\

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8875

.

.

foo@bar.example.com

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8882

.

.

foo+special@Bar.baz-bar0.com

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8891

.

.

<foo+@bar.example.com>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8900

.
<>
.

<>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8907

.
< https://foo.bar >
.

< https://foo.bar >

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8914

.

.

<m:abc>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8921

.

.

<foo.bar.baz>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8928

.
https://example.com
.

https://example.com

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 8935

.
foo@bar.example.com
.

foo@bar.example.com

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9015

.

.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9024

.

.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9033

.

.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9044

.

.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9055

.
Foo 
.

Foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9064

.
<33> <__>
.

<33> <__>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9073

.

.

<a h*#ref="hi">

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9082

.

.

</a href="foo">

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9133

.
foo 
.

foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9141

.
foo  foo -->

foo  foo -->
.

foo  foo -->


foo  foo -->

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9153

.
foo 
.

foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9162

.
foo 
.

foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9171

.
foo &<]]>
.

foo &<]]>

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9181

.
foo 
.

foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9190

.
foo 
.

foo 

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9197

.

.

<a href=""">

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9211

.
foo  
baz
.

foo

baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9223

.
foo\
baz
.

foo

baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9234

.
foo       
baz
.

foo

baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9245

.
foo  
     bar
.

foo

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9254

.
foo\
     bar
.

foo

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9266

.
*foo  
bar*
.

foo

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9275

.
*foo\
bar*
.

foo

bar

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9286

.
`code  
span`
.

code   span

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9294

.
`code\
span`
.

code\ span

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9304

.

.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9313

.

.


.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9326

.
foo\
.

foo\

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9333

.
foo  
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9340

.
### foo\
.

foo\

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9347

.
### foo  
.

foo

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9362

.
foo
baz
.

foo
baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9374

.
foo 
 baz
.

foo
baz

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9394

.
hello $.;'there
.

hello $.;'there

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9401

.
Foo χρῆν
.

Foo χρῆν

.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src line: 9410

.
Multiple     spaces
.

Multiple     spaces

.

markdown-it-py-4.2.0/tests/test_port/fixtures/disable_code_block.md000066400000000000000000000013301517710005200255210ustar00rootroot00000000000000indent paragraph
.
    This is a paragraph,
    with multiple lines.

    This paragraph
has variable indents,
      like this.
.

This is a paragraph,
with multiple lines.


This paragraph
has variable indents,
like this.

.

indent in HTML
.



    Paragraph



.



Paragraph



.

indent fence
.
        ```python
        def foo():
            pass
        ```
.

def foo():
    pass


.

indent heading
.
     # Heading
.

Heading

.

indent table
.
     | foo | bar |
     | --- | --- |
     | baz | bim |
.





foo
bar






baz
bim





.
markdown-it-py-4.2.0/tests/test_port/fixtures/fatal.md000066400000000000000000000017411517710005200230470ustar00rootroot00000000000000Should not throw exception on invalid chars in URL (`*` not allowed in path) [malformed URI]
.
[foo](<%test>)
.

foo

.


Should not throw exception on broken utf-8 sequence in URL [malformed URI]
.
[foo](%C3)
.

foo

.


Should not throw exception on broken utf-16 surrogates sequence in URL [malformed URI]
.
[foo](�)
.

foo

.


Should not hang comments regexp
.
foo 
.

foo <!— xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ->


foo 

.


Should not hang cdata regexp
.
foo 
.

foo <![CDATA[ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ]>

.
markdown-it-py-4.2.0/tests/test_port/fixtures/issue-fixes.md000066400000000000000000000012111517710005200242140ustar00rootroot00000000000000#31 empty lines after certain lists raises exception:
.
> a

- b


.



a




    

  • b
    • 


.

#50 blank lines after block quotes
.
> A Block Quote

> Another Block Quote


.



A Block Quote






Another Block Quote



.

#80 UnicodeError with codepoints larger than 0xFFFF
.
💬
.

💬

.

Fix CVE-2023-26303
.
![![]()
]([)
.




.

Fix parsing of incorrect numeric character references
.
[]("y;) "y;
[](#y;) #y;
.

 &#X22y;
 &#35y;

.
markdown-it-py-4.2.0/tests/test_port/fixtures/linkify.md000066400000000000000000000141641517710005200234300ustar00rootroot00000000000000linkify
.
url http://www.youtube.com/watch?v=5Jt5GEr4AYg.
.

url http://www.youtube.com/watch?v=5Jt5GEr4AYg.

.


don't touch text in links
.
[https://example.com](https://example.com)
.

https://example.com

.


don't touch text in autolinks
.

.

https://example.com

.


don't touch text in html  tags
.
https://example.com
.

https://example.com

.

entities inside raw links
.
https://example.com/foo&bar
.

https://example.com/foo&amp;bar

.


emphasis inside raw links (asterisk, can happen in links with params)
.
https://example.com/foo*bar*baz
.

https://example.com/foo*bar*baz

.


emphasis inside raw links (underscore)
.
http://example.org/foo._bar_-_baz
.

http://example.org/foo._bar_-_baz

.


backticks inside raw links
.
https://example.com/foo`bar`baz
.

https://example.com/foo`bar`baz

.


links inside raw links
.
https://example.com/foo[123](456)bar
.

https://example.com/foo[123](456)bar

.


escapes not allowed at the start
.
\https://example.com
.

\https://example.com

.


escapes not allowed at comma
.
https\://example.com
.

https://example.com

.


escapes not allowed at slashes
.
https:\//aa.org https://bb.org
.

https://aa.org https://bb.org

.


fuzzy link shouldn't match cc.org
.
https:/\/cc.org
.

https://cc.org

.


bold links (exclude markup of pairs from link tail)
.
**http://example.com/foobar**
.

http://example.com/foobar

.

match links without protocol
.
www.example.org
.

www.example.org

.

coverage, prefix not valid
.
http:/example.com/
.

http:/example.com/

.


coverage, negative link level
.
[https://example.com](https://example.com)
.

https://example.com

.


emphasis with '*', real link:
.
http://cdecl.ridiculousfish.com/?q=int+%28*f%29+%28float+*%29%3B
.

http://cdecl.ridiculousfish.com/?q=int+(*f)+(float+*)%3B

.

emphasis with '_', real link:
.
https://www.sell.fi/sites/default/files/elainlaakarilehti/tieteelliset_artikkelit/kahkonen_t._et_al.canine_pancreatitis-_review.pdf
.

https://www.sell.fi/sites/default/files/elainlaakarilehti/tieteelliset_artikkelit/kahkonen_t._et_al.canine_pancreatitis-_review.pdf

.

emails
.
test@example.com

mailto:test@example.com
.

test@example.com


mailto:test@example.com

.


typorgapher should not break href
.
http://example.com/(c)
.

http://example.com/(c)

.

before line
.
before
github.com
.

before
github.com

.

after line
.
github.com
after
.

github.com
after

.

before after lines
.
before
github.com
after
.

before
github.com
after

.

before after lines with blank line
.
before

github.com

after
.

before


github.com


after

.

Don't match escaped
.
google\.com
.

google.com

.

Issue [#300](https://github.com/executablebooks/markdown-it-py/issues/300) emphasis inside raw links (underscore) at beginning of line
.
http://example.org/foo._bar_-_baz This works
.

http://example.org/foo._bar_-_baz This works

.

Issue [#300](https://github.com/executablebooks/markdown-it-py/issues/300) emphasis inside raw links (underscore) at end of line
.
This doesnt http://example.org/foo._bar_-_baz
.

This doesnt http://example.org/foo._bar_-_baz

.

Issue [#300](https://github.com/executablebooks/markdown-it-py/issues/300) emphasis inside raw links (underscore) mix1
.
While this `does` http://example.org/foo._bar_-_baz, this doesnt http://example.org/foo._bar_-_baz and this **does** http://example.org/foo._bar_-_baz
.

While this does http://example.org/foo._bar_-_baz, this doesnt http://example.org/foo._bar_-_baz and this does http://example.org/foo._bar_-_baz

.

Issue [#300](https://github.com/executablebooks/markdown-it-py/issues/300) emphasis inside raw links (underscore) mix2
.
This applies to _series of URLs too_ http://example.org/foo._bar_-_baz http://example.org/foo._bar_-_baz, these dont http://example.org/foo._bar_-_baz http://example.org/foo._bar_-_baz and these **do** http://example.org/foo._bar_-_baz http://example.org/foo._bar_-_baz
.

This applies to series of URLs too http://example.org/foo._bar_-_baz http://example.org/foo._bar_-_baz, these dont http://example.org/foo._bar_-_baz http://example.org/foo._bar_-_baz and these do http://example.org/foo._bar_-_baz http://example.org/foo._bar_-_baz

.

emphasis inside raw links (asterisk) at end of line
.
This doesnt http://example.org/foo.*bar*-*baz
.

This doesnt http://example.org/foo.*bar*-*baz

.markdown-it-py-4.2.0/tests/test_port/fixtures/normalize.md000066400000000000000000000014001517710005200237500ustar00rootroot00000000000000
Encode link destination, decode text inside it:

.

.

http://example.com/αβγδ

.

.
[foo](http://example.com/α%CE%B2γ%CE%B4)
.

foo

.


Keep %25 as is because decoding it may break urls, #720
.

.

https://www.google.com/search?q=hello.%252Ehello

.


Don't encode domains in unknown schemas:

.
[](skype:γγγ)
.


.


Square brackets are allowed
.
[foo](https://bar]baz.org)
.

foo

.
markdown-it-py-4.2.0/tests/test_port/fixtures/proto.md000066400000000000000000000002601517710005200231160ustar00rootroot00000000000000.
[__proto__]

[__proto__]: blah
.

proto

.


.
[hasOwnProperty]

[hasOwnProperty]: blah
.

hasOwnProperty

.
markdown-it-py-4.2.0/tests/test_port/fixtures/punycode.md000066400000000000000000000022061517710005200236030ustar00rootroot00000000000000Should decode punycode:

.

.

http://☃.net/

.

.

.

http://☃.net/

.

Invalid punycode:

.

.

http://xn--xn.com/

.

Invalid punycode (non-ascii):

.

.

http://xn--γ.com/

.

Two slashes should start a domain:

.
[](//☃.net/)
.


.

Should auto-add protocol to autolinks:

.
test google.com foo
.

test google.com foo

.

Should support IDN in autolinks:

.
test http://xn--n3h.net/ foo
.

test http://☃.net/ foo

.

.
test http://☃.net/ foo
.

test http://☃.net/ foo

.

.
test //xn--n3h.net/ foo
.

test //☃.net/ foo

.

.
test xn--n3h.net foo
.

test ☃.net foo

.

.
test xn--n3h@xn--n3h.net foo
.

test xn--n3h@☃.net foo

.
markdown-it-py-4.2.0/tests/test_port/fixtures/smartquotes.md000066400000000000000000000051171517710005200243500ustar00rootroot00000000000000Should parse nested quotes:
.
"foo 'bar' baz"

'foo 'bar' baz'
.

“foo ‘bar’ baz”


‘foo ‘bar’ baz’

.


Should not overlap quotes:
.
'foo "bar' baz"
.

‘foo "bar’ baz"

.


Should match quotes on the same level:
.
"foo *bar* baz"
.

“foo bar baz”

.


Should handle adjacent nested quotes:
.
'"double in single"'

"'single in double'"
.

‘“double in single”’


“‘single in double’”

.



Should not match quotes on different levels:
.
*"foo* bar"

"foo *bar"*

*"foo* bar *baz"*
.

"foo bar"


"foo bar"


"foo bar baz"

.

Smartquotes should not overlap with other tags:
.
*foo "bar* *baz" quux*
.

foo "bar baz" quux

.


Should try and find matching quote in this case:
.
"foo "bar 'baz"
.

"foo “bar 'baz”

.


Should not touch 'inches' in quotes:
.
"Monitor 21"" and "Monitor""
.

“Monitor 21"” and “Monitor”"

.


Should render an apostrophe as a rsquo:
.
This isn't and can't be the best approach to implement this...
.

This isn’t and can’t be the best approach to implement this…

.


Apostrophe could end the word, that's why original smartypants replaces all of them as rsquo:
.
users' stuff
.

users’ stuff

.

Quotes between punctuation chars:

.
"(hai)".
.

“(hai)”.

.

Quotes at the start/end of the tokens:
.
"*foo* bar"

"foo *bar*"

"*foo bar*"
.

“foo bar”


“foo bar”


“foo bar”

.

Should treat softbreak as a space:
.
"this"
and "that".

"this" and
"that".
.

“this”
and “that”.


“this” and
“that”.

.

Should treat hardbreak as a space:
.
"this"\
and "that".

"this" and\
"that".
.

“this”

and “that”.


“this” and

“that”.

.

Should allow quotes adjacent to other punctuation characters, #643:
.
The dog---"'man's' best friend"
.

The dog—“‘man’s’ best friend”

.

Should parse quotes adjacent to code block, #677:
.
"test `code`"

"`code` test"
.

“test code”


“code test”

.

Should parse quotes adjacent to inline html, #677:
.
"test 
"

"
 test"
.

“test 
”


“
 test”

.

Should be escapable:
.
"foo"

\"foo"

"foo\"
.

“foo”


"foo"


"foo"

.

Should not replace entities:
.
"foo"

"foo"

"foo"
.

"foo"


"foo"


"foo"

.
markdown-it-py-4.2.0/tests/test_port/fixtures/strikethrough.md000066400000000000000000000030321517710005200246550ustar00rootroot00000000000000.
~~Strikeout~~
.

Strikeout

.

.
x ~~~~foo~~ bar~~
.

x foo bar

.

.
x ~~foo ~~bar~~~~
.

x foo bar

.

.
x ~~~~foo~~~~
.

x foo

.

.
x ~~a ~~foo~~~~~~~~~~~bar~~ b~~

x ~~a ~~foo~~~~~~~~~~~~bar~~ b~~
.

x a foo~~~bar b


x a foo~~~~bar b

.


Strikeouts have the same priority as emphases:
.
**~~test**~~

~~**test~~**
.

~~test~~


**test**

.


Strikeouts have the same priority as emphases with respect to links:
.
[~~link]()~~

~~[link~~]()
.

~~link~~


~~link~~

.


Strikeouts have the same priority as emphases with respect to backticks:
.
~~`code~~`

`~~code`~~
.

~~code~~


~~code~~

.


Nested strikeouts:
.
~~foo ~~bar~~ baz~~

~~f **o ~~o b~~ a** r~~
.

foo bar baz


f o o b a r

.


Should not have a whitespace between text and "~~":
.
foo ~~ bar ~~ baz
.

foo ~~ bar ~~ baz

.


Should parse strikethrough within link tags:
.
[~~foo~~]()
.

foo

.


Newline should be considered a whitespace:
.
~~test
~~

~~
test~~

~~
test
~~
.

~~test
~~


~~
test~~


~~
test
~~

.

From CommonMark test suite, replacing `**` with our marker:

.
a~~"foo"~~
.

a~~"foo"~~

.

Coverage: single tilde
.
~a~
.

~a~

.

Regression test for #742:
.
-~~~~;~~~~~~
.

-;~~

.
markdown-it-py-4.2.0/tests/test_port/fixtures/strikethrough_single_tilde.md000066400000000000000000000020311517710005200273750ustar00rootroot00000000000000Single tilde basic
.
~Strikeout~
.

Strikeout

.

Double tilde still works
.
~~Strikeout~~
.

Strikeout

.

Single and double don't cross-match
.
~foo~~
.

~foo~~

.

Single and double don't cross-match (reversed)
.
~~foo~
.

~~foo~

.

Three or more tildes rejected in inline context
.
a ~~~foo~~~ b
.

a ~~~foo~~~ b

.

Four tildes rejected in inline context
.
a ~~~~foo~~~~ b
.

a ~~~~foo~~~~ b

.

Mixed single and double
.
~single~ and ~~double~~
.

single and double

.

Nested double inside single
.
~foo ~~bar~~ baz~
.

foo bar baz

.

Single tilde with spaces (no match - flanking rules)
.
foo ~ bar ~ baz
.

foo ~ bar ~ baz

.

Single tilde with punctuation
.
~foo~bar
.

foobar

.

Multiple single tildes
.
~one~ ~two~ ~three~
.

one two three

.

Single tilde emphasis priority with bold
.
**~test**~
.

~test~

.

Single tilde in link context
.
[~link]()~
.

~link~

.
markdown-it-py-4.2.0/tests/test_port/fixtures/tables.md000066400000000000000000000246771517710005200232470ustar00rootroot00000000000000Simple:
.
| Heading 1 | Heading 2
| --------- | ---------
| Cell 1    | Cell 2
| Cell 3    | Cell 4
.





Heading 1
Heading 2






Cell 1
Cell 2




Cell 3
Cell 4





.


Column alignment:
.
| Header 1 | Header 2 | Header 3 | Header 4 |
| :------: | -------: | :------- | -------- |
| Cell 1   | Cell 2   | Cell 3   | Cell 4   |
| Cell 5   | Cell 6   | Cell 7   | Cell 8   |
.





Header 1
Header 2
Header 3
Header 4






Cell 1
Cell 2
Cell 3
Cell 4




Cell 5
Cell 6
Cell 7
Cell 8





.


Nested emphases:
.
Header 1|Header 2|Header 3|Header 4
:-------|:------:|-------:|--------
Cell 1  |Cell 2  |Cell 3  |Cell 4
*Cell 5*|Cell 6  |Cell 7  |Cell 8
.





Header 1
Header 2
Header 3
Header 4






Cell 1
Cell 2
Cell 3
Cell 4




Cell 5
Cell 6
Cell 7
Cell 8





.


Nested tables inside blockquotes:
.
> foo|foo
> ---|---
> bar|bar
baz|baz
.







foo
foo






bar
bar








baz|baz

.


Minimal one-column:
.
| foo
|----
| test2
.





foo






test2





.


This is parsed as one big table:
.
-   foo|foo
---|---
bar|bar
.





-   foo
foo






bar
bar





.


Second line should not contain symbols except "-", ":", "|" and " ":
.
foo|foo
-----|-----s
bar|bar
.

foo|foo
-----|-----s
bar|bar

.


Second line should contain "|" symbol:
.
foo|foo
-----:-----
bar|bar
.

foo|foo
-----:-----
bar|bar

.


Second line should not have empty columns in the middle:
.
foo|foo
-----||-----
bar|bar
.

foo|foo
-----||-----
bar|bar

.


Wrong alignment symbol position:
.
foo|foo
-----|-::-
bar|bar
.

foo|foo
-----|-::-
bar|bar

.


Title line should contain "|" symbol:
.
foo
-----|-----
bar|bar
.

foo
-----|-----
bar|bar

.


Allow tabs as a separator on 2nd line
.
|	foo	|	bar	|
|	---	|	---	|
|	baz	|	quux	|
.





foo
bar






baz
quux





.


Should terminate paragraph:
.
paragraph
foo|foo
---|---
bar|bar
.

paragraph






foo
foo






bar
bar





.


Table no longer terminated via row without "|" symbol:
.
foo|foo
---|---
paragraph
.





foo
foo






paragraph






.


Delimiter escaping (deprecated):
.
| Heading 1 \\\\| Heading 2
| --------- | ---------
| Cell\|1\|| Cell\|2
\| Cell\\\|3 \\| Cell\|4
.

| Heading 1 \\| Heading 2
| --------- | ---------
| Cell|1|| Cell|2
| Cell\|3 \| Cell|4

.

Pipes inside backticks DO split cells, unless `\` escaped:
.
| Heading 1 | Heading 2
| --------- | ---------
| `Cell\|1` | Cell 2
| `Cell|3` | Cell 4
.





Heading 1
Heading 2






Cell|1
Cell 2




`Cell
3`





.

Unclosed backticks don't count
.
| Heading 1 | Heading 2
| --------- | ---------
| Cell 1 | Cell 2
| `Cell 3| Cell 4
.





Heading 1
Heading 2






Cell 1
Cell 2




`Cell 3
Cell 4





.

Another complicated backticks case
.
| Heading 1 | Heading 2
| --------- | ---------
| Cell 1 | Cell 2
| \\\`|\\\`
.





Heading 1
Heading 2






Cell 1
Cell 2




\`
\`





.

`\` in tables should not count as escaped backtick
.
# | 1 | 2
--|--|--
x | `\` | `x`
.





#
1
2






x
\
x





.

Tables should handle escaped backticks
.
# | 1 | 2
--|--|--
x | \`\` | `x`
.





#
1
2






x
``
x





.


An amount of rows might be different across table (issue #171), but header and alignment rows must be equal (#697):
.
| 1 | 2 |
| :-----: |  :-----: |
| 3 | 4 | 5 | 6 |
.





1
2






3
4





.


An amount of rows might be different across the table #2:
.
| 1 | 2 | 3 | 4 |
| :-----: |  :-----: |  :-----: |  :-----: |
| 5 | 6 |
.





1
2
3
4






5
6







.


Allow one-column tables (issue #171):
.
| foo |
:-----:
| bar |
.





foo






bar





.


Allow indented tables (issue #325):
.
  | Col1a | Col2a |
  | ----- | ----- |
  | Col1b | Col2b |
.





Col1a
Col2a






Col1b
Col2b





.


Tables should not be indented more than 4 spaces (1st line):
.
    | Col1a | Col2a |
  | ----- | ----- |
  | Col1b | Col2b |
.

| Col1a | Col2a |



| ----- | ----- |
| Col1b | Col2b |

.


Tables should not be indented more than 4 spaces (2nd line):
.
  | Col1a | Col2a |
    | ----- | ----- |
  | Col1b | Col2b |
.

| Col1a | Col2a |
| ----- | ----- |
| Col1b | Col2b |

.


Tables should not be indented more than 4 spaces (3rd line):
.
  | Col1a | Col2a |
  | ----- | ----- |
    | Col1b | Col2b |
.





Col1a
Col2a






| Col1b | Col2b |


.


Allow tables with empty body:
.
  | Col1a | Col2a |
  | ----- | ----- |
.





Col1a
Col2a





.


Align row should be at least as large as any actual rows:
.
Col1a | Col1b | Col1c
----- | -----
Col2a | Col2b | Col2c
.

Col1a | Col1b | Col1c
----- | -----
Col2a | Col2b | Col2c

.

Escaped pipes inside backticks don't split cells:
.
| Heading 1 | Heading 2
| --------- | ---------
| Cell 1 | Cell 2
| `Cell 3\|` | Cell 4
.





Heading 1
Heading 2






Cell 1
Cell 2




Cell 3|
Cell 4





.

Escape before escaped Pipes inside backticks don't split cells:
.
| Heading 1 | Heading 2
| --------- | ---------
| Cell 1 | Cell 2
| `Cell 3\\|` | Cell 4
.





Heading 1
Heading 2






Cell 1
Cell 2




Cell 3\|
Cell 4





.

Regression test for #721, table in a list indented with tabs:
.
- Level 1

	- Level 2

		| Column 1 | Column 2 |
		| -------- | -------- |
		| abcdefgh | ijklmnop |
.

    

  • 

    Level 1
    

      

    • 

      Level 2
      

      


      
Column 1
Column 2

      
      


      
abcdefgh
ijklmnop

      
      

      

      • 

    

    • 


.

Table without any columns is not a table, #724
.
|
|
|
.

|
|
|

.

GFM 4.10 Tables (extension), Example 198
.
| foo | bar |
| --- | --- |
| baz | bim |
.





foo
bar






baz
bim





.

GFM 4.10 Tables (extension), Example 199
.
| abc | defghi |
:-: | -----------:
bar | baz
.





abc
defghi






bar
baz





.

GFM 4.10 Tables (extension), Example 200
.
| f\|oo  |
| ------ |
| b `\|` az |
| b **\|** im |
.





f|oo






b | az




b | im





.

GFM 4.10 Tables (extension), Example 201
.
| abc | def |
| --- | --- |
| bar | baz |
> bar
.





abc
def






bar
baz








bar



.

GFM 4.10 Tables (extension), Example 202
.
| abc | def |
| --- | --- |
| bar | baz |
bar

bar
.





abc
def






bar
baz




bar







bar

.

GFM 4.10 Tables (extension), Example 203
.
| abc | def |
| --- |
| bar |
.

| abc | def |
| --- |
| bar |

.

GFM 4.10 Tables (extension), Example 204
.
| abc | def |
| --- | --- |
| bar |
| bar | baz | boo |
.





abc
def






bar





bar
baz





.

GFM 4.10 Tables (extension), Example 205
.
| abc | def |
| --- | --- |
.





abc
def





.

A list takes precedence in case of ambiguity
.
a | b
- | -
1 | 2
.

a | b


    

  • | -
1 | 2
    • 


.
markdown-it-py-4.2.0/tests/test_port/fixtures/tasklists.md000066400000000000000000000072341517710005200240040ustar00rootroot00000000000000Bullet unchecked and checked
.
- [ ] unchecked item 1
- [ ] unchecked item 2
- [x] checked item 3
.

    

  •  unchecked item 1
    • 

  •  unchecked item 2
    • 

  •  checked item 3
    • 


.

Uppercase X
.
- [X] checked uppercase
- [x] checked lowercase
.

    

  •  checked uppercase
    • 

  •  checked lowercase
    • 


.

Ordered list with tasks
.
1. [x] checked ordered 1
2. [ ] unchecked ordered 2
.

    

  1.  checked ordered 1
    2. 

  2.  unchecked ordered 2
    3. 


.

Invalid checkbox syntax
.
- [  ] not a todo
- [ x] not a todo
- [x ] not a todo
.

    

  • [  ] not a todo
    • 

  • [ x] not a todo
    • 

  • [x ] not a todo
    • 


.

Mixed task and non-task items
.
- normal item
- [ ] unchecked
- another normal
- [x] checked
.

    

  • normal item
    • 

  •  unchecked
    • 

  • another normal
    • 

  •  checked
    • 


.

No task items - no class on list
.
- normal 1
- normal 2
.

    

  • normal 1
    • 

  • normal 2
    • 


.

Nested list with tasks
.
- foo
  - [ ] nested unchecked
  - [x] nested checked
.

    

  • foo

      

    •  nested unchecked
      • 

    •  nested checked
      • 

    

    • 


.

Task with inline formatting
.
- [x] **bold** task
- [ ] *italic* task
- [x] `code` task
.

    

  •  bold task
    • 

  •  italic task
    • 

  •  code task
    • 


.

Single task item
.
- [x] only item
.

    

  •  only item
    • 


.

Different bullet markers
.
+ [x] plus checked
+ [ ] plus unchecked
.

    

  •  plus checked
    • 

  •  plus unchecked
    • 


.

Ordered list starting from non-1
.
3. [x] task three
4. [ ] task four
.

    

  1.  task three
    2. 

  2.  task four
    3. 


.
markdown-it-py-4.2.0/tests/test_port/fixtures/typographer.md000066400000000000000000000021241517710005200243200ustar00rootroot00000000000000.
(bad)
.

(bad)

.

copyright (Lower)
.
(c)
.

©

.

copyright (Upper)
.
(C)
.

©

.

copyright
.
(c) (C)
.

© ©

.


reserved
.
(r) (R)
.

® ®

.


trademark
.
(tm) (TM)
.

™ ™

.

plus-minus
.
+-5
.

±5

.


ellipsis
.
test.. test... test..... test?..... test!....
.

test… test… test… test?.. test!..

.


dupes
.
!!!!!! ???? ,,
.

!!! ??? ,

.


dupes-ellipsis
.
!... ?... ,... !!!!!!.... ????.... ,,...
.

!.. ?.. ,… !!!.. ???.. ,…

.

copyright should be escapable
.
\(c)
.

(c)

.


dashes
.
---markdownit --- super---

markdownit---awesome

abc ----

--markdownit -- super--

markdownit--awesome
.

—markdownit — super—


markdownit—awesome


abc ----


–markdownit – super–


markdownit–awesome

.

dashes should be escapable
.
foo \-- bar

foo -\- bar
.

foo -- bar


foo -- bar

.

regression tests for #624
.
1---2---3

1--2--3

1 -- -- 3
.

1—2—3


1–2–3


1 – – 3

.

shouldn't replace entities
.
(c) (c) (c)
.

(c) (c) ©

.
markdown-it-py-4.2.0/tests/test_port/fixtures/xss.md000066400000000000000000000043211517710005200225720ustar00rootroot00000000000000.
[normal link](javascript)
.

normal link

.


Should not allow some protocols in links and images
.
[xss link](javascript:alert(1))

[xss link](JAVASCRIPT:alert(1))

[xss link](vbscript:alert(1))

[xss link](VBSCRIPT:alert(1))

[xss link](file:///123)
.

[xss link](javascript:alert(1))


[xss link](JAVASCRIPT:alert(1))


[xss link](vbscript:alert(1))


[xss link](VBSCRIPT:alert(1))


[xss link](file:///123)

.


.
[xss link]("><script>alert("xss")</script>)

[xss link](Javascript:alert(1))

[xss link](&#74;avascript:alert(1))

[xss link](\Javascript:alert(1))
.

xss link


[xss link](Javascript:alert(1))


xss link


xss link

.

.
[xss link]()
.

[xss link](<javascript:alert(1)>)

.

.
[xss link](javascript:alert(1))
.

[xss link](javascript:alert(1))

.


Should not allow data-uri except some whitelisted mimes
.
![](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)
.


.

.
[xss link](data:text/html;base64,PHNjcmlwdD5hbGVydCgnWFNTJyk8L3NjcmlwdD4K)
.

[xss link](data:text/html;base64,PHNjcmlwdD5hbGVydCgnWFNTJyk8L3NjcmlwdD4K)

.

.
[normal link](/javascript:link)
.

normal link

.


Image parser use the same code base as link.
.
![xss link](javascript:alert(1))
.

![xss link](javascript:alert(1))

.


Autolinks
.



.

<javascript:alert(1)>


<javascript:alert(1)>

.


Linkifier
.
javascript:alert(1)

javascript:alert(1)
.

javascript:alert(1)


javascript:alert(1)

.


References
.
[test]: javascript:alert(1)
.

[test]: javascript:alert(1)

.


Make sure we decode entities before split:
.
```js custom-class
test1
```

```jscustom-class
test2
```
.

test1



test2


.
markdown-it-py-4.2.0/tests/test_port/test_fixtures.py000066400000000000000000000107201517710005200230440ustar00rootroot00000000000000from pathlib import Path

import pytest

from markdown_it import MarkdownIt
from markdown_it.utils import read_fixture_file

FIXTURE_PATH = Path(__file__).parent.joinpath("fixtures")


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("linkify.md")),
)
def test_linkify(line, title, input, expected):
    md = MarkdownIt().enable("linkify")
    md.options["linkify"] = True
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()

    # if not install linkify-it-py
    md.linkify = None
    with pytest.raises(ModuleNotFoundError):
        md.render(input)


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("smartquotes.md")),
)
def test_smartquotes(line, title, input, expected):
    md = MarkdownIt().enable("replacements").enable("smartquotes")
    md.options["typographer"] = True
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("typographer.md")),
)
def test_typographer(line, title, input, expected):
    md = MarkdownIt().enable("replacements")
    md.options["typographer"] = True
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected", read_fixture_file(FIXTURE_PATH.joinpath("tables.md"))
)
def test_table(line, title, input, expected):
    md = MarkdownIt().enable("table")
    text = md.render(input)
    try:
        assert text.rstrip() == expected.rstrip()
    except AssertionError:
        print(text)
        raise


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("commonmark_extras.md")),
)
def test_commonmark_extras(line, title, input, expected):
    md = MarkdownIt("commonmark")
    md.options["langPrefix"] = ""
    text = md.render(input)
    if text.rstrip() != expected.rstrip():
        print(text)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("normalize.md")),
)
def test_normalize_url(line, title, input, expected):
    md = MarkdownIt("commonmark")
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected", read_fixture_file(FIXTURE_PATH.joinpath("fatal.md"))
)
def test_fatal(line, title, input, expected):
    md = MarkdownIt("commonmark").enable("replacements")
    md.options["typographer"] = True
    text = md.render(input)
    if text.rstrip() != expected.rstrip():
        print(text)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("strikethrough.md")),
)
def test_strikethrough(line, title, input, expected):
    md = MarkdownIt().enable("strikethrough")
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("strikethrough_single_tilde.md")),
)
def test_strikethrough_single_tilde(line, title, input, expected):
    md = MarkdownIt("gfm-like2")
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("disable_code_block.md")),
)
def test_disable_code_block(line, title, input, expected):
    md = MarkdownIt().enable("table").disable("code")
    text = md.render(input)
    print(text.rstrip())
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("tasklists.md")),
)
def test_tasklists(line, title, input, expected):
    md = MarkdownIt("gfm-like2")
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("alerts.md")),
)
def test_alerts(line, title, input, expected):
    md = MarkdownIt("gfm-like2")
    text = md.render(input)
    assert text.rstrip() == expected.rstrip()


@pytest.mark.parametrize(
    "line,title,input,expected",
    read_fixture_file(FIXTURE_PATH.joinpath("issue-fixes.md")),
)
def test_issue_fixes(line, title, input, expected):
    md = MarkdownIt()
    text = md.render(input)
    print(text)
    assert text.rstrip() == expected.rstrip()
markdown-it-py-4.2.0/tests/test_port/test_misc.py000066400000000000000000000027011517710005200221260ustar00rootroot00000000000000from markdown_it import MarkdownIt, presets


def test_highlight_arguments():
    def highlight_func(str_, lang, attrs):
        assert lang == "a"
        assert attrs == "b  c  d"
        return "
==" + str_ + "==
"

    conf = presets.commonmark.make()
    conf["options"]["highlight"] = highlight_func
    md = MarkdownIt(config=conf)
    assert md.render("``` a  b  c  d \nhl\n```") == "
==hl\n==
\n"


def test_ordered_list_info():
    def type_filter(tokens, type_):
        return [t for t in tokens if t.type == type_]

    md = MarkdownIt()

    tokens = md.parse("1. Foo\n2. Bar\n20. Fuzz")
    assert len(type_filter(tokens, "ordered_list_open")) == 1
    tokens = type_filter(tokens, "list_item_open")
    assert len(tokens) == 3
    assert tokens[0].info == "1"
    assert tokens[0].markup == "."
    assert tokens[1].info == "2"
    assert tokens[1].markup == "."
    assert tokens[2].info == "20"
    assert tokens[2].markup == "."

    tokens = md.parse(" 1. Foo\n2. Bar\n  20. Fuzz\n 199. Flp")
    assert len(type_filter(tokens, "ordered_list_open")) == 1
    tokens = type_filter(tokens, "list_item_open")
    assert len(tokens) == 4
    assert tokens[0].info == "1"
    assert tokens[0].markup == "."
    assert tokens[1].info == "2"
    assert tokens[1].markup == "."
    assert tokens[2].info == "20"
    assert tokens[2].markup == "."
    assert tokens[3].info == "199"
    assert tokens[3].markup == "."
markdown-it-py-4.2.0/tests/test_port/test_no_end_newline.py000066400000000000000000000014521517710005200241600ustar00rootroot00000000000000import pytest

from markdown_it import MarkdownIt


@pytest.mark.parametrize(
    "input,expected",
    [
        ("#", "
\n"),
        ("###", "
\n"),
        ("` `", "
 
\n"),
        ("``````", "
\n"),
        ("-", "
    \n
  • \n
\n"),
        ("1.", "
    \n
  1. \n
\n"),
        (">", "
\n"),
        ("---", "
\n"),
        ("
", "
"),
        ("p", "
p
\n"),
        ("[reference]: /url", ""),
        ("    indented code block", "
indented code block\n
\n"),
        ("> test\n>", "
\n
test
\n
\n"),
    ],
)
def test_no_end_newline(input, expected):
    md = MarkdownIt()
    text = md.render(input)
    assert text == expected
markdown-it-py-4.2.0/tests/test_port/test_references.py000066400000000000000000000030651517710005200233200ustar00rootroot00000000000000from markdown_it import MarkdownIt


def test_ref_definitions():
    md = MarkdownIt()
    src = "[a]: abc\n\n[b]: xyz\n\n[b]: ijk"
    env = {}  # type: ignore
    tokens = md.parse(src, env)
    assert tokens == []
    assert env == {
        "references": {
            "A": {"title": "", "href": "abc", "map": [0, 1]},
            "B": {"title": "", "href": "xyz", "map": [2, 3]},
        },
        "duplicate_refs": [{"href": "ijk", "label": "B", "map": [4, 5], "title": ""}],
    }


def test_use_existing_env(data_regression):
    md = MarkdownIt()
    src = "[a]\n\n[c]: ijk"
    env = {
        "references": {
            "A": {"title": "", "href": "abc", "map": [0, 1]},
            "B": {"title": "", "href": "xyz", "map": [2, 3]},
        }
    }
    tokens = md.parse(src, env)
    data_regression.check([token.as_dict() for token in tokens])
    assert env == {
        "references": {
            "A": {"title": "", "href": "abc", "map": [0, 1]},
            "B": {"title": "", "href": "xyz", "map": [2, 3]},
            "C": {"title": "", "href": "ijk", "map": [2, 3]},
        }
    }


def test_store_labels(data_regression):
    md = MarkdownIt()
    md.options["store_labels"] = True
    src = "[a]\n\n![a]\n\n[a]: ijk"
    tokens = md.parse(src)
    data_regression.check([token.as_dict() for token in tokens])


def test_inline_definitions(data_regression):
    md = MarkdownIt()
    md.options["inline_definitions"] = True
    src = '[a]: url "title"\n- [a]: url "title"'
    tokens = md.parse(src)
    data_regression.check([token.as_dict() for token in tokens])
markdown-it-py-4.2.0/tests/test_port/test_references/000077500000000000000000000000001517710005200227425ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_port/test_references/test_inline_definitions.yml000066400000000000000000000022661517710005200304030ustar00rootroot00000000000000- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map:
  - 0
  - 1
  markup: ''
  meta:
    id: A
    label: a
    title: title
    url: url
  nesting: 0
  tag: ''
  type: definition
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map:
  - 1
  - 2
  markup: '-'
  meta: {}
  nesting: 1
  tag: ul
  type: bullet_list_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 1
  map:
  - 1
  - 2
  markup: '-'
  meta: {}
  nesting: 1
  tag: li
  type: list_item_open
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 2
  map:
  - 1
  - 2
  markup: ''
  meta:
    id: A
    label: a
    title: title
    url: url
  nesting: 0
  tag: ''
  type: definition
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 1
  map: null
  markup: '-'
  meta: {}
  nesting: -1
  tag: li
  type: list_item_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map: null
  markup: '-'
  meta: {}
  nesting: -1
  tag: ul
  type: bullet_list_close
markdown-it-py-4.2.0/tests/test_port/test_references/test_store_labels.yml000066400000000000000000000042031517710005200272010ustar00rootroot00000000000000- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map:
  - 0
  - 1
  markup: ''
  meta: {}
  nesting: 1
  tag: p
  type: paragraph_open
- attrs: null
  block: true
  children:
  - attrs:
    - - href
      - ijk
    block: false
    children: null
    content: ''
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta:
      label: A
    nesting: 1
    tag: a
    type: link_open
  - attrs: null
    block: false
    children: null
    content: a
    hidden: false
    info: ''
    level: 1
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  - attrs: null
    block: false
    children: null
    content: ''
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: -1
    tag: a
    type: link_close
  content: '[a]'
  hidden: false
  info: ''
  level: 1
  map:
  - 0
  - 1
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: p
  type: paragraph_close
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map:
  - 2
  - 3
  markup: ''
  meta: {}
  nesting: 1
  tag: p
  type: paragraph_open
- attrs: null
  block: true
  children:
  - attrs:
    - - src
      - ijk
    - - alt
      - ''
    block: false
    children:
    - attrs: null
      block: false
      children: null
      content: a
      hidden: false
      info: ''
      level: 0
      map: null
      markup: ''
      meta: {}
      nesting: 0
      tag: ''
      type: text
    content: a
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta:
      label: A
    nesting: 0
    tag: img
    type: image
  content: '![a]'
  hidden: false
  info: ''
  level: 1
  map:
  - 2
  - 3
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: p
  type: paragraph_close
markdown-it-py-4.2.0/tests/test_port/test_references/test_use_existing_env.yml000066400000000000000000000022061517710005200301020ustar00rootroot00000000000000- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map:
  - 0
  - 1
  markup: ''
  meta: {}
  nesting: 1
  tag: p
  type: paragraph_open
- attrs: null
  block: true
  children:
  - attrs:
    - - href
      - abc
    block: false
    children: null
    content: ''
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: 1
    tag: a
    type: link_open
  - attrs: null
    block: false
    children: null
    content: a
    hidden: false
    info: ''
    level: 1
    map: null
    markup: ''
    meta: {}
    nesting: 0
    tag: ''
    type: text
  - attrs: null
    block: false
    children: null
    content: ''
    hidden: false
    info: ''
    level: 0
    map: null
    markup: ''
    meta: {}
    nesting: -1
    tag: a
    type: link_close
  content: '[a]'
  hidden: false
  info: ''
  level: 1
  map:
  - 0
  - 1
  markup: ''
  meta: {}
  nesting: 0
  tag: ''
  type: inline
- attrs: null
  block: true
  children: null
  content: ''
  hidden: false
  info: ''
  level: 0
  map: null
  markup: ''
  meta: {}
  nesting: -1
  tag: p
  type: paragraph_close
markdown-it-py-4.2.0/tests/test_tree.py000066400000000000000000000060631517710005200201140ustar00rootroot00000000000000from markdown_it import MarkdownIt
from markdown_it.tree import SyntaxTreeNode

EXAMPLE_MARKDOWN = """
## Heading here

Some paragraph text and **emphasis here** and more text here.
"""


def test_tree_to_tokens_conversion():
    tokens = MarkdownIt().parse(EXAMPLE_MARKDOWN)
    tokens_after_roundtrip = SyntaxTreeNode(tokens).to_tokens()
    assert tokens == tokens_after_roundtrip


def test_property_passthrough():
    tokens = MarkdownIt().parse(EXAMPLE_MARKDOWN)
    heading_open = tokens[0]
    tree = SyntaxTreeNode(tokens)
    heading_node = tree.children[0]
    assert heading_open.tag == heading_node.tag
    assert tuple(heading_open.map or ()) == heading_node.map
    assert heading_open.level == heading_node.level
    assert heading_open.content == heading_node.content
    assert heading_open.markup == heading_node.markup
    assert heading_open.info == heading_node.info
    assert heading_open.meta == heading_node.meta
    assert heading_open.block == heading_node.block
    assert heading_open.hidden == heading_node.hidden


def test_type():
    tokens = MarkdownIt().parse(EXAMPLE_MARKDOWN)
    tree = SyntaxTreeNode(tokens)
    # Root type is "root"
    assert tree.type == "root"
    # "_open" suffix must be stripped from nested token type
    assert tree.children[0].type == "heading"
    assert tree[0].type == "heading"
    # For unnested tokens, node type must remain same as token type
    assert tree.children[0].children[0].type == "inline"


def test_sibling_traverse():
    tokens = MarkdownIt().parse(EXAMPLE_MARKDOWN)
    tree = SyntaxTreeNode(tokens)
    paragraph_inline_node = tree.children[1].children[0]
    text_node = paragraph_inline_node.children[0]
    assert text_node.type == "text"
    strong_node = text_node.next_sibling
    assert strong_node
    assert strong_node.type == "strong"
    another_text_node = strong_node.next_sibling
    assert another_text_node
    assert another_text_node.type == "text"
    assert another_text_node.next_sibling is None
    assert another_text_node.previous_sibling.previous_sibling == text_node  # type: ignore
    assert text_node.previous_sibling is None


def test_pretty(file_regression):
    md = MarkdownIt("commonmark")
    tokens = md.parse(
        """
# Header

Here's some text and an image ![title](image.png)

1. a **list**

> a *quote*
    """
    )
    node = SyntaxTreeNode(tokens)
    file_regression.check(node.pretty(indent=2, show_text=True), extension=".xml")


def test_pretty_text_special(file_regression):
    md = MarkdownIt()
    md.disable("text_join")
    tree = SyntaxTreeNode(md.parse("foo © bar \\("))
    file_regression.check(tree.pretty(show_text=True), extension=".xml")


def test_walk():
    tokens = MarkdownIt().parse(EXAMPLE_MARKDOWN)
    tree = SyntaxTreeNode(tokens)
    expected_node_types = (
        "root",
        "heading",
        "inline",
        "text",
        "paragraph",
        "inline",
        "text",
        "strong",
        "text",
        "text",
    )
    for node, expected_type in zip(tree.walk(), expected_node_types):
        assert node.type == expected_type
markdown-it-py-4.2.0/tests/test_tree/000077500000000000000000000000001517710005200175355ustar00rootroot00000000000000markdown-it-py-4.2.0/tests/test_tree/test_pretty.xml000066400000000000000000000007661517710005200226560ustar00rootroot00000000000000
  
    
      
        Header
  
    
      
        Here's some text and an image 
      
        
          title
  
    
      
        
          
            a 
          
            
              list
          
  

    
      
        
          a 
        
          
            quotemarkdown-it-py-4.2.0/tests/test_tree/test_pretty_text_special.xml000066400000000000000000000002251517710005200254100ustar00rootroot00000000000000
  
    
      
        foo 
      
        ©
      
         bar 
      
        (markdown-it-py-4.2.0/tox.ini000066400000000000000000000041201517710005200157050ustar00rootroot00000000000000# To use tox, see https://tox.readthedocs.io
# Simply pip or conda install tox
# If you use conda, you may also want to install tox-conda
# then run `tox` or `tox -- {pytest args}`
# run in parallel using `tox -p`
[tox]
envlist = py310

[testenv]
usedevelop = true

[testenv:py{310,311,312,313}]
extras =
    linkify
    testing
commands = pytest {posargs:tests/}

[testenv:py{310,311,312,313}-plugins]
extras = testing
changedir = {envtmpdir}
allowlist_externals =
    git
    pip
commands_pre =
    git clone https://github.com/executablebooks/mdit-py-plugins.git
    pip install --no-deps -e mdit-py-plugins
commands =
    pytest {posargs}

[testenv:py{310,311,312,313}-bench-core]
extras = benchmarking
commands = pytest benchmarking/bench_core.py {posargs}

[testenv:py{310,311,312,313}-bench-packages]
extras = benchmarking,compare
commands = pytest benchmarking/bench_packages.py {posargs}

[testenv:docs-{update,clean}]
extras = linkify,plugins,rtd
allowlist_externals =
    echo
    rm
setenv =
    update: SKIP_APIDOC = true
commands =
    clean: rm -rf docs/_build
    sphinx-build -nW --keep-going -b {posargs:html} docs/ docs/_build/{posargs:html}
commands_post = echo "open file://{toxinidir}/docs/_build/{posargs:html}/index.html"

[testenv:profile]
description = run profiler (use e.g. `firefox .tox/prof/output.svg` to open)
extras = profiling
allowlist_externals =
    mkdir
    dot
commands =
    mkdir -p "{toxworkdir}/prof"
    python -m cProfile -o "{toxworkdir}/prof/output.pstats" scripts/profiler.py
    gprof2dot -f pstats -o "{toxworkdir}/prof/output.dot" "{toxworkdir}/prof/output.pstats"
    dot -Tsvg -o "{toxworkdir}/prof/output.svg" "{toxworkdir}/prof/output.dot"
    python -c 'import pathlib; print("profiler svg output under file://\{0\}".format(pathlib.Path(r"{toxworkdir}") / "prof" / "output.svg"))'

[testenv:fuzz]
description = run fuzzer on testcase file
; See: https://google.github.io/oss-fuzz/
deps = atheris
commands_pre = python scripts/build_fuzzers.py {envdir}/oss-fuzz
commands = python {envdir}/oss-fuzz/infra/helper.py reproduce markdown-it-py fuzz_markdown {posargs:testcase}