squishie 0.5.1

Squish multiple Pandoc-flavored Markdown files into one super squished document.

squishie

Squish multiple Pandoc-flavored Markdown files into one super squished document.

Installation

python3 -m pip install squishie

Usage

Create a directory with your Markdown files:

$ tree
.
├── doc1.md
└── doc2.md

0 directories, 2 files

Each Markdown file should have Pandoc-compatible front matter. For example, doc1.md has the following contents:

# doc1.md
---
title: Doc 1
---
This is some text.

Add a squishie document file to the directory:

# config.yaml
title: My squished document
version: "1.2.3"

sections:
  - file: doc1.md
  - file: doc2.md

Your directory should now look like this:

$ tree
.
├── squishie.yaml
├── doc1.md
└── doc2.md

0 directories, 2 files

Run squishie with the -c/--config option to render the final document:

squishie -c squishie.yaml

$ squishie -c squishie.yaml
---
title: My squished document
version: 1.2.3
---

# Doc 1

This is some text.

# Doc 2

This is different text.

Add the -o/--output option to write the output to a file:

squishie -c squishie.yaml -o my-squished-document.md

It is also possible to add subsections:

sections:
  # ...
  - title: Subsection
    sections:
      - file: doc3.md

      - title: Subsubsection
        sections:
          - file: doc4.md

The header level of a document is automatically adjusted based on the document's position in the overall section tree.

Page and section titles

A title can be added to a page or section with the title keyword:

sections:
  - file: doc1.md
    title: My Title

For each header, an anchor and attribute is also added. Pandoc header_attributes or attributes must be enabled. The following Markdown is generated:

# [My Title](#my-title) {#my-title}

The generated anchors can be customized with the anchor keyword:

sections:
  - file: doc1.md
    title: My Title
    anchor: different-anchor

This will produce the following markdown:

# [My Title](#different-anchor) {#different-anchor}

squishie automatically adds the header anchor as an attribute, but you can add additional attributes with the attributes keyword:

sections:
  - file: doc1.md
    title: My Title
    attributes: .bg-blue .text-white

This produces the following markdown:

# [My Title](#my-title) {#my-title .bg-blue .text-white}

If a page includes a title that you don't want to be shown, set show_title to false to remove it from the output:

sections:
  - file: doc1.md
    show_title: false

License

Copyright 2025 UL Research Institutes.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.