Markdown Code Packer
include source code files unobtrusively in markdown notes (a Sublime Text 3 plugin)
- Total 37
- Win 17
- Mac 12
- Linux 8
|Jun 4||Jun 3||Jun 2||Jun 1||May 31||May 30||May 29||May 28||May 27||May 26||May 25||May 24||May 23||May 22||May 21||May 20||May 19||May 18||May 17||May 16||May 15||May 14||May 13||May 12||May 11||May 10||May 9||May 8||May 7||May 6||May 5||May 4||May 3||May 2||May 1||Apr 30||Apr 29||Apr 28||Apr 27||Apr 26||Apr 25||Apr 24||Apr 23||Apr 22||Apr 21|
Markdown Code Packer
Packs code and files into markdown documents. This Sublime 3 plugin converts code blocks to compressed, single-line comments to improve visibility.
For my personal note taking and note sharing, I often want to save all project code in my Markdown documents. But too many code blocks disrupt the reading flow and there is no way to extract all files. This plugin allows to pack and unpack code blocks/files in a document.
- show off a technical spike), but also keep the needed but boring config files
- include a lengthy CSV table you want to send along for reference
- archive a set of files as a starter template for a project
- include a small asset in your note, so you don't have to keep it as an additional file
- archive the contents of an external blog article without overloading your document
Up until now, I solved these use cases by creating a gist, put files in an
assets/ folder or zip the whole document along with its files.
This plugin removes the need for these.
Markdown Code Packer: Pack: Pack selected code block(s)
Markdown Code Packer: Unpack: Unpack selected code block(s)
Markdown Code Packer: Extract Selection to Folder: Extract selected blocks to a folder (filename can include relative path)
Markdown Code Packer: Extract All to Folder: Extract all blocks in the document to a folder
Markdown Code Packer: Pack Folder: Insert all files of a folder into the document
You can also include binary files (e.g. images)
Extract All to Folder
- Test: Use for playing around - also includes an a binary file (image) to extract
- My Mac Setup: Includes packed config files
- Webpack: Includes mini-projects, make sure to select one and then extract it to a folder
- With Package Control: Open the command palette and run the
Package Control: Install Packagecommand, find and install the
Markdown Code Packerplugin.
- Manually: Clone or download git repository into your packages folder (to find the folder run the command
Preferences - Browse Packages).
If you are wondering what
[] means: These are references to other notes (see Sublime ZK for more info).
`optional_filename`: ```optional_type // code ```
For packing I chose deflate and then base64 (see [assets/FormatChoice.md] for more info).
Please create an issue if you find a bug or fix it and make a pull request. For direct contact, please find my email on tomrothe.de.
- Use functools.partial (MarkdownCodePacker.py#L37)
file_pathvariable from extract_variables
- VSCode plugin?
- Command line tool (with brew formula)?
- remember/infer file type for fenced code blocks