| Name | marksplitz JSON |
| Version |
0.1.dev10
JSON |
| download |
| home_page | None |
| Summary | Command-line utility to split a Markdown file into linked static web pages. |
| upload_time | 2024-04-27 14:53:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024-present William Melvin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
markdown
converter
html
slideshow
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# marksplitz
Command-line utility to split a Markdown file into linked static web pages.
> Development work in progress.
## Directive Comments
The following HTML comments can be placed in the source Markdown document to alter the generated HTML.
`<!-- title: new-title -->`
- Replace the default HTML **title** for the page.
`<!-- class: class-1 class-2 -->`
- Add one or more classes to the `content` div.
- Use to apply styles to multiple pages via a `custom.css` file.
`<!-- id: id-value -->`
- Add `id="id-value"` to the `content` div.
- Use to apply styles to a specific page via a `custom.css` file.
## Command-line Usage
```
usage: marksplitz [-h] [-o OUTPUT_DIR] [-n OUTPUT_NAME] [-i IMAGES_SUBDIR]
[-c CSS_FILE]
markdown_file
Split a Markdown file into linked HTML pages.
positional arguments:
markdown_file Path to the Markdown file to split.
options:
-h, --help show this help message and exit
-o OUTPUT_DIR, --output-dir OUTPUT_DIR
Path to the output directory.
-n OUTPUT_NAME, --output-name OUTPUT_NAME
Base name for the output HTML files.
-i IMAGES_SUBDIR, --images-subdir IMAGES_SUBDIR
Subdirectory for images. Expected to be in the
directory containing the Markdown file. Contents are
copied to a subdirectory by the same name in the
output directory.
-c CSS_FILE, --css-file CSS_FILE
Optional name of a CSS file to include in the same
location as the HTML output. If a CSS file is not
specified, a default style is embedded in the HTML
output. If a CSS file is specified, the default style
is not included.If the specified CSS file does not
exist, it is created with the default style.
```
## Reference
### CSS
Customizing the generated HTML output requires using CSS.
- MDN Guide: [Learn to style HTML using CSS](https://developer.mozilMDNla.org/en-US/docs/Learn/CSS)
- MDN Reference: [CSS: Cascading Style Sheets](https://developer.mozilla.org/en-US/docs/Web/CSS)
- [Basic concepts of flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flexible_box_layout/Basic_concepts_of_flexbox)
- [Class selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Class_selectors)
### Packages Used
- [mistune](https://pypi.org/project/mistune/): Markdown parser
- [docs](https://mistune.lepture.com/en/latest/)
### Project Tools
- [uv](https://github.com/astral-sh/uv#readme) - Environment management (in place of `pip`)
- [Ruff](https://docs.astral.sh/ruff/) - Linter and code formatter
- [pytest](https://docs.pytest.org/en/stable/) - Testing framework
- [build](https://build.pypa.io/en/stable/index.html) - Python packaging build frontend
- [twine](https://twine.readthedocs.io/en/latest/) - Utility for publishing Python packages
- [Just](https://github.com/casey/just#readme) - Command runner
Raw data
{
"_id": null,
"home_page": null,
"name": "marksplitz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "markdown, converter, html, slideshow",
"author": null,
"author_email": "Bill Melvin <bill@billmelvin.com>",
"download_url": "https://files.pythonhosted.org/packages/00/28/7d021868d507788874255899b4e6bbc87e246313e143ea66e2470ffc136e/marksplitz-0.1.dev10.tar.gz",
"platform": null,
"description": "# marksplitz\n\nCommand-line utility to split a Markdown file into linked static web pages.\n\n> Development work in progress.\n\n## Directive Comments\n\nThe following HTML comments can be placed in the source Markdown document to alter the generated HTML.\n\n`<!-- title: new-title -->` \n\n- Replace the default HTML **title** for the page.\n\n`<!-- class: class-1 class-2 -->` \n\n- Add one or more classes to the `content` div.\n- Use to apply styles to multiple pages via a `custom.css` file. \n\n`<!-- id: id-value -->` \n\n- Add `id=\"id-value\"` to the `content` div.\n- Use to apply styles to a specific page via a `custom.css` file. \n\n## Command-line Usage\n\n```\nusage: marksplitz [-h] [-o OUTPUT_DIR] [-n OUTPUT_NAME] [-i IMAGES_SUBDIR]\n [-c CSS_FILE]\n markdown_file\n\nSplit a Markdown file into linked HTML pages.\n\npositional arguments:\n markdown_file Path to the Markdown file to split.\n\noptions:\n -h, --help show this help message and exit\n -o OUTPUT_DIR, --output-dir OUTPUT_DIR\n Path to the output directory.\n -n OUTPUT_NAME, --output-name OUTPUT_NAME\n Base name for the output HTML files.\n -i IMAGES_SUBDIR, --images-subdir IMAGES_SUBDIR\n Subdirectory for images. Expected to be in the\n directory containing the Markdown file. Contents are\n copied to a subdirectory by the same name in the\n output directory.\n -c CSS_FILE, --css-file CSS_FILE\n Optional name of a CSS file to include in the same\n location as the HTML output. If a CSS file is not\n specified, a default style is embedded in the HTML\n output. If a CSS file is specified, the default style\n is not included.If the specified CSS file does not\n exist, it is created with the default style.\n```\n\n## Reference\n\n### CSS\n\nCustomizing the generated HTML output requires using CSS.\n\n- MDN Guide: [Learn to style HTML using CSS](https://developer.mozilMDNla.org/en-US/docs/Learn/CSS)\n- MDN Reference: [CSS: Cascading Style Sheets](https://developer.mozilla.org/en-US/docs/Web/CSS)\n - [Basic concepts of flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flexible_box_layout/Basic_concepts_of_flexbox)\n - [Class selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Class_selectors)\n\n### Packages Used\n\n- [mistune](https://pypi.org/project/mistune/): Markdown parser \n - [docs](https://mistune.lepture.com/en/latest/)\n\n### Project Tools\n\n- [uv](https://github.com/astral-sh/uv#readme) - Environment management (in place of `pip`)\n- [Ruff](https://docs.astral.sh/ruff/) - Linter and code formatter\n- [pytest](https://docs.pytest.org/en/stable/) - Testing framework\n- [build](https://build.pypa.io/en/stable/index.html) - Python packaging build frontend\n- [twine](https://twine.readthedocs.io/en/latest/) - Utility for publishing Python packages\n- [Just](https://github.com/casey/just#readme) - Command runner\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024-present William Melvin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Command-line utility to split a Markdown file into linked static web pages.",
"version": "0.1.dev10",
"project_urls": null,
"split_keywords": [
"markdown",
" converter",
" html",
" slideshow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "67fd05dc03323363224362d4f4707ac5db69d4f47ed0f9cda9c558c58057f588",
"md5": "87aee918f11af9fef74ccc9583081061",
"sha256": "ce8ff33632d4ba0b5fe4be58839fe5d3837061d86e5da5ea984f226095792aba"
},
"downloads": -1,
"filename": "marksplitz-0.1.dev10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87aee918f11af9fef74ccc9583081061",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9433,
"upload_time": "2024-04-27T14:53:56",
"upload_time_iso_8601": "2024-04-27T14:53:56.514601Z",
"url": "https://files.pythonhosted.org/packages/67/fd/05dc03323363224362d4f4707ac5db69d4f47ed0f9cda9c558c58057f588/marksplitz-0.1.dev10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00287d021868d507788874255899b4e6bbc87e246313e143ea66e2470ffc136e",
"md5": "32b17ff8371260cab512ff0628dbecf3",
"sha256": "db77a08bfddc6cdb463cf6b3d0b0214ef7d428b2c27a8aca425d6f15dbab43e1"
},
"downloads": -1,
"filename": "marksplitz-0.1.dev10.tar.gz",
"has_sig": false,
"md5_digest": "32b17ff8371260cab512ff0628dbecf3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12350,
"upload_time": "2024-04-27T14:53:58",
"upload_time_iso_8601": "2024-04-27T14:53:58.009338Z",
"url": "https://files.pythonhosted.org/packages/00/28/7d021868d507788874255899b4e6bbc87e246313e143ea66e2470ffc136e/marksplitz-0.1.dev10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 14:53:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "marksplitz"
}
