| Name | textual-markdown JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | Markdown viewer widgets for Textual |
| upload_time | 2022-12-17 09:37:08 |
| maintainer | |
| docs_url | None |
| author | Will McGugan |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Textual Markdown Browser
This project is an experiment to see how far I could take the idea of a "Markdown browser" in the terminal, using the [Textual](https://github.com/Textualize/textual) framework.
Markdown in the terminal is not unusual, [Rich](https://github.com/Textualize/rich) has a decent Markdown renderer, but its output is essentially static. Textual Markdown creates a more dynamic Markdown document you can interact with: there are working links, srollablr code fences, and tables.
Links must be relative only and on the filesystem for now. These could be made to load from the network for a more browser like experience. It is also relatively easy to intercept links and handle them programatically. Opening up custom hypertext like applications.
And finally, there is a TOC (Table Of Contents) extracted from the Markdown, which can be used to navigate the document.
## Video
A short video of me playing with the demo Markdown.
https://user-images.githubusercontent.com/554369/208234316-be4e6626-c601-4dca-b8d1-59af9b4d08cd.mov
## Screenshots
## Try it out
You can install `textual-markdown` from PyPI in the usual way:
```
pip install textual-markdown
```
Here's how you hopen a Markdown file:
```
python -m textual_markdown README.md
```
## Disclaimer
At time of writing, there is less than a weeks work in this. Which means you may (likely) find bugs.
## The future
Some (or all) of this repo will be rolled in to [Textual](https://github.com/Textualize/textual). It may also become a project in its own right. If there is enough interest.
Raw data
{
"_id": null,
"home_page": "",
"name": "textual-markdown",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Will McGugan",
"author_email": "willmcgugan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9e/b4/2c0af9032e8ae65d588d0f6de4b271a4ae03a115062c857b560794214332/textual_markdown-0.1.1.tar.gz",
"platform": null,
"description": "# Textual Markdown Browser\n\nThis project is an experiment to see how far I could take the idea of a \"Markdown browser\" in the terminal, using the [Textual](https://github.com/Textualize/textual) framework.\n\nMarkdown in the terminal is not unusual, [Rich](https://github.com/Textualize/rich) has a decent Markdown renderer, but its output is essentially static. Textual Markdown creates a more dynamic Markdown document you can interact with: there are working links, srollablr code fences, and tables.\n\nLinks must be relative only and on the filesystem for now. These could be made to load from the network for a more browser like experience. It is also relatively easy to intercept links and handle them programatically. Opening up custom hypertext like applications.\n\nAnd finally, there is a TOC (Table Of Contents) extracted from the Markdown, which can be used to navigate the document.\n\n## Video\n\nA short video of me playing with the demo Markdown.\n\nhttps://user-images.githubusercontent.com/554369/208234316-be4e6626-c601-4dca-b8d1-59af9b4d08cd.mov\n\n\n## Screenshots\n\n\n\n\n\n\n\n\n## Try it out\n\nYou can install `textual-markdown` from PyPI in the usual way:\n\n```\npip install textual-markdown\n```\n\nHere's how you hopen a Markdown file:\n\n```\npython -m textual_markdown README.md\n```\n\n## Disclaimer\n\nAt time of writing, there is less than a weeks work in this. Which means you may (likely) find bugs. \n\n## The future\n\nSome (or all) of this repo will be rolled in to [Textual](https://github.com/Textualize/textual). It may also become a project in its own right. If there is enough interest.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Markdown viewer widgets for Textual",
"version": "0.1.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "54a091be76c4dbd9f3189f36d3793cb9",
"sha256": "0f95689b46abb1b4ed876298c039c5846b22f90bca0eeb0212332064fa30c972"
},
"downloads": -1,
"filename": "textual_markdown-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54a091be76c4dbd9f3189f36d3793cb9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 8261,
"upload_time": "2022-12-17T09:37:07",
"upload_time_iso_8601": "2022-12-17T09:37:07.443296Z",
"url": "https://files.pythonhosted.org/packages/ac/e5/36d846aa1cea93a381acc9c8b63d25a3425affd33c95c81b65d287d1eb55/textual_markdown-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c2ea534a8fa500b2f58acea694317a60",
"sha256": "105d752dad210304be58b593653721139793523a3ad87c650cb901011d107c47"
},
"downloads": -1,
"filename": "textual_markdown-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "c2ea534a8fa500b2f58acea694317a60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 7354,
"upload_time": "2022-12-17T09:37:08",
"upload_time_iso_8601": "2022-12-17T09:37:08.781080Z",
"url": "https://files.pythonhosted.org/packages/9e/b4/2c0af9032e8ae65d588d0f6de4b271a4ae03a115062c857b560794214332/textual_markdown-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-17 09:37:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "textual-markdown"
}
