adphi/oh-my-zsh
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Notes on self-linking images

Andrew Janke 2015-02-21 20:30:09 -05:00
parent 5c762fbd62
commit af4bb179ed
1 changed files with 29 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
Themes.md

@ -330,20 +330,39 @@ Clean, simple, compatible and meaningful. ([more info](http://blog.ysmood.org/my
### zhann
[![zhann](https://cloud.githubusercontent.com/assets/2618447/6316771/520a5170-ba00-11e4-9561-78f0c76e996c.png)](https://cloud.githubusercontent.com/assets/2618447/6316771/520a5170-ba00-11e4-9561-78f0c76e996c.png)
## Theme Description Format
The theme descriptions should contain:
* The name of the theme.
* A screenshot. Preferably in PNG format.
* Instructions for any configuration besides setting `ZSH_THEME` in `~/.zshrc`. For example, font installation, terminal colorscheme configuration, or optional environment variables that affect the theme.
* Any dependencies outside Oh My Zsh.
We use manually-constructed screenshots because some of the themes require additional terminal configuration to look their best, and so the code in example shell sessions can showcase the theme's features. There is also a separate collection of automatically-generated screenshots linked [at the bottom of this page](#screenshots-of-each-theme).
## (Don’t) Send us your theme! (for now)
We have enough themes for the time being. Please fork the project and add on in there, you can let people know how to grab it from there.
## Theme Description Format
The theme descriptions in this page should contain:
* The name of the theme
* A screenshot
** (Preferably in PNG format, and hosted on a GitHub issue)
* Instructions for any configuration besides setting `ZSH_THEME` in `~/.zshrc`
** For example, font installation, terminal color scheme configuration, or optional environment variables that affect the theme
* Any dependencies outside Oh My Zsh
We use manually-constructed screenshots because some of the themes require additional terminal configuration to look their best, and so the code in example shell sessions can showcase the theme's features. There is also a separate collection of automatically-generated screenshots linked [at the bottom of this page](#screenshots-of-each-theme).
### Uploading screenshots to GitHub
We host all the screenshot images on GitHub itself, to avoid external dependencies on other hosting services or URLs that might break. We use issue attachments which will get them in to githubusercontent.com. (It's also possible to store image files in a GitHub wiki itself, but this requires you to have Contributor permissions for the repo whose Wiki you're editing. The issue-attachment method can be done by anybody.)
To upload an image to GitHub, just drag and drop it into the text area on an issue you're editing. You can use issue #3619 for this to avoid spamming people with notifications about new issues. The uploaded image will turn in to a link in Markdown format. Edit that to use the special `[![name](image-url)](image-url)` syntax to make the image link to itself, so people can open the image in a new tab to view it full size. (Images inside a wiki page may be displayed scaled down.)
For example:
```
[![wezm](https://cloud.githubusercontent.com/assets/1441704/6315419/915f6ca6-ba01-11e4-95b3-2c98114b5e5c.png)](https://cloud.githubusercontent.com/assets/1441704/6315419/915f6ca6-ba01-11e4-95b3-2c98114b5e5c.png)
```
If you have several uploaded screenshot links you need to convert to that self-linked syntax, you can use this `sed` command on the markdown file to programmatically convert them.
sed 's/^!\[[a-zA-Z0-9 -]*\](\([^)]*\)) *$/[&](\1)/'
## Screenshots of Each Theme
[Screenshots of each theme](https://www.dropbox.com/sh/u532agyv1hyash1/LS9yNESRlQ?lst) (as of 2013-04-10), in OS X Terminal.app using Consolas 13pt and Pro color scheme, inside a folder containing both a git and a mercurial repo. Each screenshot displays the output of the `pwd` command. It has shortcomings (plugins for some themes might be missing), but it offers a convenient and uniform overview of each theme. Plugins used were battery, rvm, hg prompt, among others.