| Name | mizuku JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | None |
| Summary | A command-line interface tool to make a professional HTML website from MIML files. |
| upload_time | 2024-08-14 19:25:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Mizuku = 水区 = Water District
This is a Python package that provides the CLI script `mizu`, meaning "water".
It converts .mizu files to .html files.
## Installation
pip install mizuku
## Usage
mizu
## Documentation
`mizu` is designed to produce output for any number of domain names.
This is useful for A/B testing domain names for your product or website.
The domains are listed one per line in the DOMAINS file.
---
Running `mizu` will look for all .mizu files in the current directory, and convert them to .html files.
So, for example, `Resume.mizu` will be converted to `./example.com/Resume.html`.
If a corresponding CSS file is present (e.g. Resume.css), it's contents will be automatically loaded into the resulting HTML.
---
To wrap some text in `<strong>` tags:
Look at some *strong text here*; voila!
---
To link to a URL:
{Text Here}.
{Text Here|https://example.com}.
{Text Here|some_file.html}.
The first one will automatically link to `Text_Here.html`.
---
To include an image:
At any location in a paragraph, just do this: [FileNameGoesHere.png].
Only PNG format is supported and the `.png` extension must be provided.
---
To wrap some text in a `<div>` use the following format:
[Any text here]
[center: Any text here]
In the first case, the class of the div will be "Any", and you can style it in the related CSS file.
In the second case, the class of the div will be "center" and the text "center" will not be rendered.
---
To include another mizu file:
<filename.mizu>
---
To wrap some text in a paragraph tag:
Here is some text.
Make sure this text is surrounded by two newlines, before and after, and it
will get surrounded by P tags.
Here is some more text.
---
HTML is parsed normally and as expected:
Some left-aligned text.
<center>
Some centered aligned text.
</center>
---
Bullet points are supported:
- This is rendered as a bullet point. Make sure to include a space between
this and the next bullet point, otherwise they're considered the same
paragraph.
- Here is the second bullet point!
Raw data
{
"_id": null,
"home_page": null,
"name": "mizuku",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Jack Murray <info@jackmurray.com>",
"download_url": "https://files.pythonhosted.org/packages/8a/6e/48620f53ce1321fe1013b8333b0866781454f9795fe48bc647600bb253fc/mizuku-1.1.2.tar.gz",
"platform": null,
"description": "# Mizuku = \u6c34\u533a = Water District\n\nThis is a Python package that provides the CLI script `mizu`, meaning \"water\".\n\nIt converts .mizu files to .html files.\n\n## Installation\n\n pip install mizuku\n\n## Usage\n\n mizu\n\n## Documentation\n\n`mizu` is designed to produce output for any number of domain names.\n\nThis is useful for A/B testing domain names for your product or website.\n\nThe domains are listed one per line in the DOMAINS file.\n\n---\n\nRunning `mizu` will look for all .mizu files in the current directory, and convert them to .html files.\n\nSo, for example, `Resume.mizu` will be converted to `./example.com/Resume.html`.\n\nIf a corresponding CSS file is present (e.g. Resume.css), it's contents will be automatically loaded into the resulting HTML.\n\n---\n\nTo wrap some text in `<strong>` tags:\n\n Look at some *strong text here*; voila!\n\n---\n\nTo link to a URL:\n\n {Text Here}.\n {Text Here|https://example.com}.\n {Text Here|some_file.html}.\n\nThe first one will automatically link to `Text_Here.html`.\n\n---\n\nTo include an image:\n\n At any location in a paragraph, just do this: [FileNameGoesHere.png].\n\nOnly PNG format is supported and the `.png` extension must be provided.\n\n---\n\nTo wrap some text in a `<div>` use the following format:\n\n [Any text here]\n [center: Any text here]\n\nIn the first case, the class of the div will be \"Any\", and you can style it in the related CSS file.\n\nIn the second case, the class of the div will be \"center\" and the text \"center\" will not be rendered.\n\n---\n\nTo include another mizu file:\n\n <filename.mizu>\n\n---\n\nTo wrap some text in a paragraph tag:\n\n Here is some text.\n\n Make sure this text is surrounded by two newlines, before and after, and it\n will get surrounded by P tags.\n\n Here is some more text.\n\n---\n\nHTML is parsed normally and as expected:\n\n Some left-aligned text.\n\n <center>\n Some centered aligned text.\n </center>\n\n---\n\nBullet points are supported:\n\n - This is rendered as a bullet point. Make sure to include a space between\n this and the next bullet point, otherwise they're considered the same\n paragraph.\n\n - Here is the second bullet point!\n",
"bugtrack_url": null,
"license": null,
"summary": "A command-line interface tool to make a professional HTML website from MIML files.",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/d3987ef8/mizuku",
"Issues": "https://github.com/d3987ef8/mizuku/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b43ff6de2abd63d711b9e79330631e1c60c77132a0dfbfe38c6753561835fcf",
"md5": "7348c1e0a1d753c1ec6a59af95f7121d",
"sha256": "0fa442a0f10ec009f6faabaf3f8b5ddd1edeb483badd951c5f353d9c40d4856b"
},
"downloads": -1,
"filename": "mizuku-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7348c1e0a1d753c1ec6a59af95f7121d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5503,
"upload_time": "2024-08-14T19:25:18",
"upload_time_iso_8601": "2024-08-14T19:25:18.078643Z",
"url": "https://files.pythonhosted.org/packages/4b/43/ff6de2abd63d711b9e79330631e1c60c77132a0dfbfe38c6753561835fcf/mizuku-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a6e48620f53ce1321fe1013b8333b0866781454f9795fe48bc647600bb253fc",
"md5": "b0f96aba010e1a1688a031c401a24573",
"sha256": "3e1de53bdd29c20686fa72abd69813011a45f92e53f00cd33acdac72c01e861f"
},
"downloads": -1,
"filename": "mizuku-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "b0f96aba010e1a1688a031c401a24573",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4687,
"upload_time": "2024-08-14T19:25:19",
"upload_time_iso_8601": "2024-08-14T19:25:19.340540Z",
"url": "https://files.pythonhosted.org/packages/8a/6e/48620f53ce1321fe1013b8333b0866781454f9795fe48bc647600bb253fc/mizuku-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 19:25:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "d3987ef8",
"github_project": "mizuku",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mizuku"
}
