Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/willmcgugan/textual-markdown

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/willmcgugan/textual-markdown
Owner: willmcgugan
License: mit
Archived: true
Created: 2022-12-14T12:39:22.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-03-07T09:46:33.000Z (almost 2 years ago)
Last Synced: 2024-07-31T08:18:44.380Z (5 months ago)
Language: Python
Size: 104 KB
Stars: 504
Watchers: 6
Forks: 9
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

my-awesome-github-stars - willmcgugan/textual-markdown - (Python)
awesome-textualize-projects - Markdown Browser - Markdown in the terminal. (Community / Third Party Applications)

README

> **Note**
>
> 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/)

# Textual Markdown Browser

This project is an experimental "Markdown browser" for the terminal, built with [Textual](https://github.com/Textualize/textual).

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](./demo.md), code fences with scrollbars, and tables.

Links 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.

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

![Screenshot 2022-12-17 at 08 41 58](https://user-images.githubusercontent.com/554369/208233944-542b1fec-daaf-4c4b-81d1-2d9eec61e727.png)

![Screenshot 2022-12-17 at 08 42 33](https://user-images.githubusercontent.com/554369/208233987-9667dd87-5ef3-45c3-91fc-166f069e14cb.png)

![Screenshot 2022-12-17 at 08 42 38](https://user-images.githubusercontent.com/554369/208233988-f0733761-6794-41f9-893f-f0258b23b988.png)

## Try it out

You can install `textual-markdown` from PyPI in the usual way:

```
pip install textual-markdown
```

Here's how you open a Markdown file:

```
python -m textual_markdown README.md
```

## Disclaimer

At time of writing, there is less than a week's 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.