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

Skip to content Toggle navigation
 
Sign up

  * Product
      +  
        Actions
        Automate any workflow
      +  
        Packages
        Host and manage packages
      +  
        Security
        Find and fix vulnerabilities
      +  
        Codespaces
        Instant dev environments
      +  
        Copilot
        Write better code with AI
      +  
        Code review
        Manage code changes
      +  
        Issues
        Plan and track work
      +  
        Discussions
        Collaborate outside of code
      + Explore
      + All features
      + Documentation
      + GitHub Skills
      + Blog
  * Solutions
      + For
      + Enterprise
      + Teams
      + Startups
      + Education
      + By Solution
      + CI/CD & Automation
      + DevOps
      + DevSecOps
      + Case Studies
      + Customer Stories
      + Resources
  * Open Source
      +  
        GitHub Sponsors
        Fund open source developers
      +  
        The ReadME Project
        GitHub community articles
      + Repositories
      + Topics
      + Trending
      + Collections
  * Pricing

[                    ] 

  *  
    #
    In this repository All GitHub |
    Jump to |

  * No suggested jump to results

  *  
    #
    In this repository All GitHub |
    Jump to |
  *  
    #
    In this user All GitHub |
    Jump to |
  *  
    #
    In this repository All GitHub |
    Jump to |

Sign in
Sign up
{{ message }}
willmcgugan / textual-markdown Public

  * Notifications
  * Fork 3
  * Star 153

License

MIT license
153 stars 3 forks
Star
Notifications

  * Code
  * Issues 2
  * Pull requests 2
  * Actions
  * Projects 0
  * Security
  * Insights

More

  * Code
  * Issues
  * Pull requests
  * Actions
  * Projects
  * Security
  * Insights

willmcgugan/textual-markdown

This commit does not belong to any branch on this repository, and may
belong to a fork outside of the repository.
main
Switch branches/tags
[                    ]
Branches Tags
Could not load branches
Nothing to show
{{ refName }} default View all branches
Could not load tags
Nothing to show
{{ refName }} default
View all tags

Name already in use

A tag already exists with the provided branch name. Many Git commands
accept both tag and branch names, so creating this branch may cause
unexpected behavior. Are you sure you want to create this branch?
Cancel Create
1 branch 0 tags
Code

  * Local
  * Codespaces

  *  
    Clone
    HTTPS GitHub CLI
    [https://github.com/w]

    Use Git or checkout with SVN using the web URL.

    [gh repo clone willmc]

    Work fast with our official CLI. Learn more.

  * Open with GitHub Desktop
  * Download ZIP

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

@willmcgugan
willmcgugan Update README.md
...
79d282a Dec 17, 2022
Update README.md
79d282a

Git stats

  * 18 commits

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
textual_markdown
simplify app
Dec 16, 2022
.gitignore
Initial commit
Dec 14, 2022
LICENSE
Initial commit
Dec 14, 2022
README.md
Update README.md
Dec 17, 2022
demo.md
demo
Dec 17, 2022
poetry.lock
markdown widget
Dec 14, 2022
pyproject.toml
version bump
Dec 17, 2022
View code
Textual Markdown Browser Video Screenshots Try it out Disclaimer The
future

README.md

 Textual Markdown Browser

This project is an experimental "Markdown browser" for the terminal,
built with Textual.

Markdown in the terminal is not unusual. 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, 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.

Screen.Recording.2022-12-17.at.08.49.48.mov

 Screenshots

Screenshot 2022-12-17 at 08 41 58

Screenshot 2022-12-17 at 08 42 33

Screenshot 2022-12-17 at 08 42 38

 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. It may also
become a project in its own right. If there is enough interest.

About

No description, website, or topics provided.

Resources

Readme

License

MIT license

Stars

153 stars

Watchers

3 watching

Forks

3 forks

Releases

No releases published

Packages 0

No packages published

Contributors 2

  * @willmcgugan willmcgugan Will McGugan
  * @davep davep Dave Pearson

Languages

  * Python 100.0%

Footer

 (c) 2022 GitHub, Inc.

Footer navigation

  * Terms
  * Privacy
  * Security
  * Status
  * Docs
  * Contact GitHub
  * Pricing
  * API
  * Training
  * Blog
  * About

You can't perform that action at this time.
You signed in with another tab or window. Reload to refresh your
session. You signed out in another tab or window. Reload to refresh
your session.