MacDownApp / MacDownApp/macdown
[wiki] simpler instructions for launching macdown from terminal
Nobody has claimed this yet.
- Dominant language
- Rich Text Format
- Stars
- 9.8k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
It looks like I could edit the Wiki directly, but wanted to open an issue first. The proposed instructions for adding the 'macdown' command in the wiki are:
```
macdown() {
"$(mdfind kMDItemCFBundleIdentifier=com.uranusjr.macdown | head -n1)/Contents/SharedSupport/bin/macdown" $@
}
```
It's a bit simpler to just add the following to your bash profile instead:
```
$ cat ~/.bash_profile
alias macdown='open -a MacDown'
```
I'll happily modify the wiki if given a go-ahead. Thanks for reading.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the MacDown wiki page containing the terminal-launch instructions and compare them with the proposed ~/.bash_profile alias. Update the wiki if the simpler alias is appropriate, then verify that it launches MacDown from a terminal.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash, macos
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100