[{"_1":2,"_180":-5,"_181":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_153":154},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_95":-5,"_96":97,"_142":-5,"_143":11,"_144":21,"_145":11,"_146":-5,"_147":11,"_148":-5,"_149":150,"_151":98,"_152":-7},"canonicalUrl","https://hub.docker.com/r/svbaelen/cowkit/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","svbaelen","reponame","cowkit","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_50":51,"_53":54,"_55":56,"_57":11,"_58":59,"_60":61,"_62":63,"_43":35,"_32":33,"_65":66,"_67":52,"_68":69,"_70":71,"_72":73,"_74":-5,"_75":69,"_76":77,"_78":11,"_79":33,"_80":81,"_86":11,"_87":88,"_92":33,"_93":94},"categories",[42,47],{"_43":44,"_45":46},"name","Integration & delivery","slug","integration-and-delivery",{"_43":48,"_45":49},"Developer tools","developer-tools","content_types",[52],"image","date_registered","2024-04-12T19:40:01.668432Z","description","Comfortable Open Writing Kit","is_private","last_updated","2025-06-05T07:59:58.771718Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[64],"application/vnd.docker.container.image.v1+json","pull_count",1047,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# cowkit\n\n## Comfortable features\n\nWrite and compose in markdown (or HTML) - [convert to HTML](https://svbaelen.github.io/cowkit/), LaTeX, and PDF.\n\n- Convenient, though [far from perfect](#caveats-and-known-limitations)\n- Can handle **interconnected content structures** (auto numbering of sections, tables, figures, etc.; `.bib`-based references and citations;\n among many other things. Also see [example output](https://svbaelen.github.io/cowkit/))\n- Zero setup, no frameworks (requires only [Docker](https://docs.docker.com/engine/install/) with [Pandoc](https://pandoc.org/)-based image)\n- Fully customizable (styling, metadata, layout, ...)\n- Focus on writing instead of compiling (file-watcher + auto build)\n\nBuilt on top of [Pandoc](https://pandoc.org/) (file format converter), and inspired by this [pandoc book template](https://github.com/wikiti/pandoc-book-template).\n\n## Get started\n\n### Initialize new (example) project\n\n```sh\ndocker run -u $(id -u):$(id -g) --rm -v \"$(pwd):/app\" -p 8000:8000 svbaelen/config --init\n```\n\n### Run\n\nFor default HTML output (and file watcher + HTTP server):\n\n```sh\ndocker run -u $(id -u):$(id -g) --rm -v \"$(pwd):/app\" -p 8000:8000 svbaelen/cowkit\n```\n\nSee the [config section](#configuration) to find out where to put what.\nOther examples can be [found here](./examples/examples_cli.md).\n\nYou can specify a `cowkit` version with the image tag, e.g., `cowkit:latest`. For a non-docker runtime environment, see [development](#development)\nsection.\n\n### CLI options\n\nCheck available options for the `cowkit` utility with `--help`:\n\n```sh\ndocker run -u $(id -u):$(id -g) --rm -v \"$(pwd):/app\" -p 8000:8000 svbaelen/cowkit --help\n```\n\n### Update to latest version\n\n```sh\ndocker image pull svbaelen/cowkit:latest\n```\n\n## Configuration\n\n- `config/config.yaml`: main (output-independent) config\n- `config//config.yaml`: output-specific config (can overwrite values set in main `config.yaml`).\n- `config//templates/`: templates related to specific output formats\n- `src/.md`: content files written in **markdown**. Every section, subsection, paragraph, figure, etc. *can*\n have a separate file. In the metadata section of each markdown file (between `---`) you can add all kinds of metadata and config options supported\n by pandoc (and pandoc extensions), e.g., [see here](https://github.com/svbaelen/cowkit/blob/main/src/_base.md?plain=1#L3).\n\nSet (different) config and/or template files via `cowkit` [CLI arguments](#cli-options).\n\nAdditional functionality such as auto-reload can be disabled or extended via the `header-includes` section in the markdown metadata, e.g., see [this example](https://github.com/svbaelen/cowkit/blob/main/src/_base.md?plain=1#L60).\n\n## Examples\n\n- See [cowkit CLI examples here](./examples/examples_cli.md)\n- For an example output document, check out [this webpage](https://svbaelen.github.io/cowkit/).\n\n## More comfort\n\n### Create alias\n\nCreate an alias to one or more relevant docker commands. Note that you can replace `.bash_aliases` with `.bashrc` or some other shell config file in your `PATH`:\n\n```sh\n# map to `cowkit`\nCMD='docker run -u $(id -u):$(id -g) --rm -v \"$(pwd):/app\" -p 8000:8000 svbaelen/cowkit'\necho \"alias cowkit='$CMD'\" >> ~/.bash_aliases && source ~/.bash_aliases\n```\n\nNote that CLI arguments still work, e.g.:\n - `cowkit --init`\n - `cowkit --format pdf --template /path/to/template`\n\nNaturally, these commands can be updated or removed anytime in `~/.bash_aliases`.\n\n### Speed up building\n\nIf re-running build process is too slow for you, open a `./config//config.yaml` file and comment out stuff. Start with the Lua-based\nfilters (which will skip bibliography rebuilds). If still too slow, uncomment sections/chapters etc.\n\n## Caveats and known limitations\n\n### General:\n\n- Tested only on\n - Ubuntu 22.04\n\n### CLI utility\n\n- A fatal Pandoc error can crash the program (and file-watcher/builder), requiring the user to re-launch\n\n### HTML output\n\n- browser auto-reload after rebuild is based on [LiveJS](https://livejs.com/), however, sometimes a manual refresh is necessary on the browser tab\n to re-initialize this script. This seems to occur on layout changes (not always). Need to inspect!\n","has_starred","hub_user","immutable_tags_settings",{"_82":11,"_83":84},"enabled","rules",[85],".*","is_automated","permissions",{"_89":21,"_90":11,"_91":11},"read","write","admin","user","storage_size",1800354361,"orgData","recentTags",[98,136],{"_99":52,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_58":125,"_126":101,"_127":33,"_128":64,"_43":129,"_130":131,"_132":116,"_133":125,"_134":73,"_135":21},"content_type","creator",4124350,"digest","sha256:60432834a885c8d22d03ec615ef9d204a6db533ec981aaffa144b7df7359dc0b","full_size",571916124,"id",639570166,"images",[110],{"_111":112,"_102":103,"_113":114,"_115":116,"_117":118,"_119":120,"_121":114,"_122":-5,"_123":105,"_70":73,"_124":-5},"architecture","amd64","features","","last_pulled","2026-10-07T07:19:18.198156396Z","last_pushed","2025-06-05T07:59:54.294419763Z","os","linux","os_features","os_version","size","variant","2025-06-05T07:59:54.957965Z","last_updater","last_updater_username","media_type","latest","repository",23815303,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_99":52,"_100":101,"_102":103,"_104":105,"_106":137,"_108":138,"_58":140,"_126":101,"_127":33,"_128":64,"_43":141,"_130":131,"_132":116,"_133":140,"_134":73,"_135":21},639569920,[139],{"_111":112,"_102":103,"_113":114,"_115":116,"_117":118,"_119":120,"_121":114,"_122":-5,"_123":105,"_70":73,"_124":-5},"2025-06-05T07:59:58.238734Z","v0.1.0","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":155,"_164":165,"_149":178,"_179":11},{"_40":156,"_50":159,"_53":54,"_55":56,"_57":11,"_58":59,"_60":61,"_62":160,"_43":35,"_32":33,"_65":66,"_67":52,"_68":69,"_70":71,"_72":73,"_74":-5,"_75":69,"_76":77,"_78":11,"_79":33,"_80":161,"_86":11,"_87":163,"_92":33,"_93":94},[157,158],{"_43":44,"_45":46},{"_43":48,"_45":49},[52],[64],{"_82":11,"_83":162},[85],{"_89":21,"_90":11,"_91":11},"tags",{"_166":167,"_168":-5,"_169":-5,"_170":171},"count",2,"next","previous","results",[172,175],{"_99":52,"_100":101,"_102":103,"_104":105,"_106":137,"_108":173,"_58":140,"_126":101,"_127":33,"_128":64,"_43":141,"_130":131,"_132":116,"_133":140,"_134":73,"_135":21},[174],{"_111":112,"_102":103,"_113":114,"_115":116,"_117":118,"_119":120,"_121":114,"_122":-5,"_123":105,"_70":73,"_124":-5},{"_99":52,"_100":101,"_102":103,"_104":105,"_106":107,"_108":176,"_58":125,"_126":101,"_127":33,"_128":64,"_43":129,"_130":131,"_132":116,"_133":125,"_134":73,"_135":21},[177],{"_111":112,"_102":103,"_113":114,"_115":116,"_117":118,"_119":120,"_121":114,"_122":-5,"_123":105,"_70":73,"_124":-5},[],"canDeleteTags","actionData","errors"]

svbaelen/cowkit

Tags for svbaelen/cowkit