| Name | squishie JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | Squish multiple Pandoc-flavored Markdown files into one super squished document. |
| upload_time | 2025-07-10 22:06:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
pandoc
markdown
documentation
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# squishie
<!-- BADGIE TIME -->
[](https://gitlab.com/saferatday0/sandbox/squishy/-/commits/main)
[](https://gitlab.com/saferatday0/sandbox/squishy/-/commits/main)
[](https://github.com/pre-commit/pre-commit)
[](https://gitlab.com/saferatday0/cici)
[](https://github.com/prettier/prettier)
<!-- END BADGIE TIME -->
Squish multiple Pandoc-flavored Markdown files into one super squished document.
## Installation
```sh
python3 -m pip install squishie
```
## Usage
Create a directory with your Markdown files:
```console
$ 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:
```yaml
# doc1.md
---
title: Doc 1
---
This is some text.
```
Add a squishie document file to the directory:
```yaml
# config.yaml
title: My squished document
version: "1.2.3"
sections:
- file: doc1.md
- file: doc2.md
```
Your directory should now look like this:
```console
$ tree
.
├── squishie.yaml
├── doc1.md
└── doc2.md
0 directories, 2 files
```
Run `squishie` with the `-c`/`--config` option to render the final document:
```sh
squishie -c squishie.yaml
```
```console
$ 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:
```sh
squishie -c squishie.yaml -o my-squished-document.md
```
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "squishie",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pandoc, markdown, documentation",
"author": null,
"author_email": "Digital Safety Research Institute <contact@dsri.org>",
"download_url": "https://files.pythonhosted.org/packages/da/3a/e7147eb43d0eff50b18f3d2b8ea717a5f82e6b9b42737b8e5167982561be/squishie-0.3.1.tar.gz",
"platform": null,
"description": "# squishie\n\n<!-- BADGIE TIME -->\n\n[](https://gitlab.com/saferatday0/sandbox/squishy/-/commits/main)\n[](https://gitlab.com/saferatday0/sandbox/squishy/-/commits/main)\n[](https://github.com/pre-commit/pre-commit)\n[](https://gitlab.com/saferatday0/cici)\n[](https://github.com/prettier/prettier)\n\n<!-- END BADGIE TIME -->\n\nSquish multiple Pandoc-flavored Markdown files into one super squished document.\n\n## Installation\n\n```sh\npython3 -m pip install squishie\n```\n\n## Usage\n\nCreate a directory with your Markdown files:\n\n```console\n$ tree\n.\n\u251c\u2500\u2500 doc1.md\n\u2514\u2500\u2500 doc2.md\n\n0 directories, 2 files\n```\n\nEach Markdown file should have Pandoc-compatible front matter. For example,\n`doc1.md` has the following contents:\n\n```yaml\n# doc1.md\n---\ntitle: Doc 1\n---\nThis is some text.\n```\n\nAdd a squishie document file to the directory:\n\n```yaml\n# config.yaml\ntitle: My squished document\nversion: \"1.2.3\"\n\nsections:\n - file: doc1.md\n - file: doc2.md\n```\n\nYour directory should now look like this:\n\n```console\n$ tree\n.\n\u251c\u2500\u2500 squishie.yaml\n\u251c\u2500\u2500 doc1.md\n\u2514\u2500\u2500 doc2.md\n\n0 directories, 2 files\n```\n\nRun `squishie` with the `-c`/`--config` option to render the final document:\n\n```sh\nsquishie -c squishie.yaml\n```\n\n```console\n$ squishie -c squishie.yaml\n---\ntitle: My squished document\nversion: 1.2.3\n---\n\n# Doc 1\n\nThis is some text.\n\n# Doc 2\n\nThis is different text.\n```\n\nAdd the `-o`/`--output` option to write the output to a file:\n\n```sh\nsquishie -c squishie.yaml -o my-squished-document.md\n```\n\n## License\n\nCopyright 2025 UL Research Institutes.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use\nthis file except in compliance with the License. You may obtain a copy of the\nLicense at\n\n<http://www.apache.org/licenses/LICENSE-2.0>\n\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied. See the License for the\nspecific language governing permissions and limitations under the License.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Squish multiple Pandoc-flavored Markdown files into one super squished document.",
"version": "0.3.1",
"project_urls": {
"Home": "https://gitlab.com/saferatday0/sandbox/squishie",
"Issues": "https://gitlab.com/saferatday0/sandbox/squishie/-/issues"
},
"split_keywords": [
"pandoc",
" markdown",
" documentation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8a3e4121e2ef95cdfcad053d18f492e9980ff1b49133db4a6421e6c2bd9ee4c6",
"md5": "2b7bcf47efacf00940c5b86ae755c1c8",
"sha256": "70c143bead861256f56a7c046d143fe1d77b1e13c3f94083deea3ca8abcf5917"
},
"downloads": -1,
"filename": "squishie-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b7bcf47efacf00940c5b86ae755c1c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9174,
"upload_time": "2025-07-10T22:06:49",
"upload_time_iso_8601": "2025-07-10T22:06:49.934610Z",
"url": "https://files.pythonhosted.org/packages/8a/3e/4121e2ef95cdfcad053d18f492e9980ff1b49133db4a6421e6c2bd9ee4c6/squishie-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "da3ae7147eb43d0eff50b18f3d2b8ea717a5f82e6b9b42737b8e5167982561be",
"md5": "5befccd2d4242b5a63f8ed518e49f0f1",
"sha256": "d22978d69e79cf21fb1278e64226a4e5a62f0d676292c7427d6278f4522b59c8"
},
"downloads": -1,
"filename": "squishie-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "5befccd2d4242b5a63f8ed518e49f0f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7761,
"upload_time": "2025-07-10T22:06:50",
"upload_time_iso_8601": "2025-07-10T22:06:50.641832Z",
"url": "https://files.pythonhosted.org/packages/da/3a/e7147eb43d0eff50b18f3d2b8ea717a5f82e6b9b42737b8e5167982561be/squishie-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 22:06:50",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "saferatday0",
"gitlab_project": "sandbox",
"lcname": "squishie"
}
