| Name | mksync JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2023-06-29 22:13:55 |
| maintainer | |
| docs_url | None |
| author | Niklas Rosenstein |
| requires_python | >=3.10,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mksync
MkSync replaces directives in a Markdown file with corresponding content. It's a useful tool to add nice
features to your project's `README.md` file, such as a table of contents, without the manual upkeep.
<!-- table of contents -->
* [Example](#example)
* [Available Directives](#available-directives)
* [Synopsis](#synopsis)
* [Changelog](#changelog)
* [0.1.4 (2023-06-29)](#014-2023-06-29)
* [0.1.3 (2023-06-29)](#013-2023-06-29)
<!-- end table of contents -->
## Example
Say this is your `README.md`:
```md
# My Project
<!-- toc -->
## Installation
## Documentation
```
Then running `mksync README.md` will update the file in-place to:
```md
# My Project
<!-- toc -->
* [Installation](#installation)
* [Documentation](#documentation)
<!-- end toc -->
## Installation
## Documentation
```
## Available Directives
* `toc` or `table of contents`: Produce an unordered list of links to all headers in the document after the directive.
* `include <path>`: Include the contents of the file at the given path. You can optionally specify a language name to
wrap the content in a code block, e.g. `include code:python <path>`.
* `runcmd <command>`: Run the given command and include the output in the document. You can optionally specify a
language name to wrap the output in a code block, e.g. `runcmd code:python <command>`.
## Synopsis
<!-- runcmd code: mksync --help -->
```
usage: mksync [-h] [--inplace] [--verbose] file
MkSync is a utility to update Markdown files in-place to automate some common upkeep tasks, such as inling
example code and updating table of contents.
positional arguments:
file the file to process
options:
-h, --help show this help message and exit
--inplace, -i update the file in-place
--verbose, -v enable verbose logging
```
<!-- end runcmd -->
---
# Changelog
<!-- runcmd slap changelog format --all --markdown -->
## 0.1.4 (2023-06-29)
<table><tr><th>Type</th><th>Description</th><th>PR</th><th>Issues</th><th>Author</th></tr>
<tr><td>Fix</td><td>
Fix placement of code block when rendering `include` directive back into the Markdown file.</td><td></td><td></td><td>@NiklasRosenstein</td></tr>
<tr><td>Improvement</td><td>
Keep the same keyword that was used for the TOC directive, which can be one of `toc` and `table of contents`</td><td></td><td></td><td>@NiklasRosenstein</td></tr>
</table>
## 0.1.3 (2023-06-29)
<table><tr><th>Type</th><th>Description</th><th>PR</th><th>Issues</th><th>Author</th></tr>
<tr><td>Fix</td><td>
Fix parsing of `include` directives</td><td></td><td></td><td>@NiklasRosenstein</td></tr>
</table>
<!-- end runcmd -->
Raw data
{
"_id": null,
"home_page": "",
"name": "mksync",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Niklas Rosenstein",
"author_email": "rosensteinniklas@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/79/88/9ac650c1b5cb2de3a5a2aa6136caf3e856a5ea8e5218c64ff4d6d674241e/mksync-0.1.4.tar.gz",
"platform": null,
"description": "# mksync\n\nMkSync replaces directives in a Markdown file with corresponding content. It's a useful tool to add nice\nfeatures to your project's `README.md` file, such as a table of contents, without the manual upkeep.\n\n<!-- table of contents -->\n * [Example](#example)\n * [Available Directives](#available-directives)\n * [Synopsis](#synopsis)\n* [Changelog](#changelog)\n * [0.1.4 (2023-06-29)](#014-2023-06-29)\n * [0.1.3 (2023-06-29)](#013-2023-06-29)\n<!-- end table of contents -->\n\n## Example\n\nSay this is your `README.md`:\n\n```md\n# My Project\n\n<!-- toc -->\n\n## Installation\n\n## Documentation\n```\n\nThen running `mksync README.md` will update the file in-place to:\n\n```md\n# My Project\n\n<!-- toc -->\n* [Installation](#installation)\n* [Documentation](#documentation)\n<!-- end toc -->\n\n## Installation\n\n## Documentation\n```\n\n## Available Directives\n\n* `toc` or `table of contents`: Produce an unordered list of links to all headers in the document after the directive.\n* `include <path>`: Include the contents of the file at the given path. You can optionally specify a language name to\n wrap the content in a code block, e.g. `include code:python <path>`.\n* `runcmd <command>`: Run the given command and include the output in the document. You can optionally specify a\n language name to wrap the output in a code block, e.g. `runcmd code:python <command>`.\n\n## Synopsis\n\n<!-- runcmd code: mksync --help -->\n```\nusage: mksync [-h] [--inplace] [--verbose] file\n\nMkSync is a utility to update Markdown files in-place to automate some common upkeep tasks, such as inling\nexample code and updating table of contents.\n\npositional arguments:\n file the file to process\n\noptions:\n -h, --help show this help message and exit\n --inplace, -i update the file in-place\n --verbose, -v enable verbose logging\n```\n<!-- end runcmd -->\n\n---\n\n# Changelog\n\n<!-- runcmd slap changelog format --all --markdown -->\n## 0.1.4 (2023-06-29)\n\n<table><tr><th>Type</th><th>Description</th><th>PR</th><th>Issues</th><th>Author</th></tr>\n <tr><td>Fix</td><td>\n\nFix placement of code block when rendering `include` directive back into the Markdown file.</td><td></td><td></td><td>@NiklasRosenstein</td></tr>\n <tr><td>Improvement</td><td>\n\nKeep the same keyword that was used for the TOC directive, which can be one of `toc` and `table of contents`</td><td></td><td></td><td>@NiklasRosenstein</td></tr>\n</table>\n\n## 0.1.3 (2023-06-29)\n\n<table><tr><th>Type</th><th>Description</th><th>PR</th><th>Issues</th><th>Author</th></tr>\n <tr><td>Fix</td><td>\n\nFix parsing of `include` directives</td><td></td><td></td><td>@NiklasRosenstein</td></tr>\n</table>\n<!-- end runcmd -->\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "0.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/NiklasRosenstein/mksync/issues",
"Repository": "https://github.com/NiklasRosenstein/mksync"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b00ece85824919352a8f19198cd59f2f6bf18d900b48caf7125f4dbd6e8e33d4",
"md5": "fcdb23a9cb7e556c2be5f9d12a72ee21",
"sha256": "280ad45bfddacfd73665a25a2a6f56e5843f45c9f6fcc3ab089e9aac504872a4"
},
"downloads": -1,
"filename": "mksync-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fcdb23a9cb7e556c2be5f9d12a72ee21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 10512,
"upload_time": "2023-06-29T22:13:54",
"upload_time_iso_8601": "2023-06-29T22:13:54.061961Z",
"url": "https://files.pythonhosted.org/packages/b0/0e/ce85824919352a8f19198cd59f2f6bf18d900b48caf7125f4dbd6e8e33d4/mksync-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "79889ac650c1b5cb2de3a5a2aa6136caf3e856a5ea8e5218c64ff4d6d674241e",
"md5": "9da871acf9c8322ea1b3e15a75f0a7dc",
"sha256": "b39b217169a987f74cc718d230d71f1c79d001f5e7692bef5fe87226b808caf1"
},
"downloads": -1,
"filename": "mksync-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "9da871acf9c8322ea1b3e15a75f0a7dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 7894,
"upload_time": "2023-06-29T22:13:55",
"upload_time_iso_8601": "2023-06-29T22:13:55.577527Z",
"url": "https://files.pythonhosted.org/packages/79/88/9ac650c1b5cb2de3a5a2aa6136caf3e856a5ea8e5218c64ff4d6d674241e/mksync-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 22:13:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NiklasRosenstein",
"github_project": "mksync",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mksync"
}
