microsoft / microsoft/markitdown

Add a shortcut for markitdown

Open Beginner friendly
#1,681 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
186k
Forks
13.7k
Avg merge
1d 4h
Merged PRs (30d)
49

Description

Once we have set up the markitdown environment, we can quickly start it by defining a markitdown-init function in the .zshrc or .bashrc file.

# ~/.zshrc / ~/.bashrc
# markitdown (Microsoft) Settings
markitdown-init() {
    if conda info --envs | grep -q "markitdown"; then
        conda activate markitdown
	markitdown --version
    else
        echo "The Conda environment 'markitdown' does not exist. Please build 'https://github.com/microsoft/markitdown.git' first."
    fi
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The requested entry points are ~/.zshrc and ~/.bashrc; start by checking the setup and usage instructions for how the markitdown Conda environment and CLI are launched. Add the markitdown-init shortcut with the requested missing-environment message and version check, then verify it in a shell with and without the markitdown environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, python, zsh
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.