{"id":13456901,"url":"https://github.com/willmcgugan/textual-markdown","last_synced_at":"2025-03-24T11:31:55.464Z","repository":{"id":64914486,"uuid":"578174780","full_name":"willmcgugan/textual-markdown","owner":"willmcgugan","description":null,"archived":true,"fork":false,"pushed_at":"2023-03-07T09:46:33.000Z","size":107,"stargazers_count":504,"open_issues_count":11,"forks_count":9,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-07-31T08:18:44.380Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willmcgugan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-12-14T12:39:22.000Z","updated_at":"2024-07-15T02:42:12.000Z","dependencies_parsed_at":"2024-01-07T21:02:29.780Z","dependency_job_id":"dc226d43-0e53-48cc-ab47-09b0ea594419","html_url":"https://github.com/willmcgugan/textual-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willmcgugan%2Ftextual-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willmcgugan%2Ftextual-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willmcgugan%2Ftextual-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willmcgugan%2Ftextual-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willmcgugan","download_url":"https://codeload.github.com/willmcgugan/textual-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221962483,"owners_count":16908339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T08:01:29.793Z","updated_at":"2024-10-29T00:31:30.502Z","avatar_url":"https://github.com/willmcgugan.png","language":"Python","funding_links":[],"categories":["Community","Python"],"sub_categories":["Third Party Applications"],"readme":"\u003e **Note**\n\u003e \n\u003e This project has been archived, and is now an official part of Textual. See [MarkdownViwer](https://textual.textualize.io/widgets/markdown_viewer/) and [Markdown](https://textual.textualize.io/widgets/markdown/)\n\n# Textual Markdown Browser\n\nThis project is an experimental \"Markdown browser\" for the terminal, built with [Textual](https://github.com/Textualize/textual).\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](./demo.md), code fences with scrollbars, and tables.\n\nLinks must be relative 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![Screenshot 2022-12-17 at 08 41 58](https://user-images.githubusercontent.com/554369/208233944-542b1fec-daaf-4c4b-81d1-2d9eec61e727.png)\n\n\n![Screenshot 2022-12-17 at 08 42 33](https://user-images.githubusercontent.com/554369/208233987-9667dd87-5ef3-45c3-91fc-166f069e14cb.png)\n\n![Screenshot 2022-12-17 at 08 42 38](https://user-images.githubusercontent.com/554369/208233988-f0733761-6794-41f9-893f-f0258b23b988.png)\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 open 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 week's 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillmcgugan%2Ftextual-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillmcgugan%2Ftextual-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillmcgugan%2Ftextual-markdown/lists"}