356 lines
16 KiB
HTML
356 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Get Started - Powerlevel10k</title>
|
|
<link href="../css/bootstrap.min.css" rel="stylesheet">
|
|
<link href="../css/font-awesome.min.css" rel="stylesheet">
|
|
<link href="../css/base.css" rel="stylesheet">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css">
|
|
|
|
<script src="../js/jquery-1.10.2.min.js" defer></script>
|
|
<script src="../js/bootstrap.min.js" defer></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/bash.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/zsh.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/sh.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/yaml.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body>
|
|
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-dark">
|
|
<div class="container">
|
|
<a class="navbar-brand" href="..">Powerlevel10k</a>
|
|
<!-- Expander button -->
|
|
<button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
|
|
<!-- Expanded navigation -->
|
|
<div id="navbar-collapse" class="navbar-collapse collapse">
|
|
<!-- Main navigation -->
|
|
<ul class="nav navbar-nav">
|
|
<li class="navitem">
|
|
<a href=".." class="nav-link">Home</a>
|
|
</li>
|
|
<li class="navitem active">
|
|
<a href="./" class="nav-link">Get Started</a>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Features <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li>
|
|
<a href="../features/wizard/" class="dropdown-item">Configuration wizard</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/uncompromising_performance/" class="dropdown-item">Uncompromising performance</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/p9k_compatibility/" class="dropdown-item">Powerlevel9k Compatibility</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/pure_compatibility/" class="dropdown-item">Pure compatibility</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/instant_prompt/" class="dropdown-item">Instant prompt</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/show_on_command/" class="dropdown-item">Show on command</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/transient_prompt/" class="dropdown-item">Transient prompt</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/current_directory/" class="dropdown-item">Current Directory that just works</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/customizable/" class="dropdown-item">Extremely Customizable</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/batteries_included/" class="dropdown-item">Batteries included</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../features/extensible/" class="dropdown-item">Extensible</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="navitem">
|
|
<a href="../faq/" class="nav-link">FAQ</a>
|
|
</li>
|
|
<li class="navitem">
|
|
<a href="../troubleshooting/" class="nav-link">Troubleshooting</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<ul class="nav navbar-nav ml-auto">
|
|
<li class="nav-item">
|
|
<a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
|
|
<i class="fa fa-search"></i> Search
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a rel="prev" href=".." class="nav-link">
|
|
<i class="fa fa-arrow-left"></i> Previous
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a rel="next" href="../features/wizard/" class="nav-link">
|
|
Next <i class="fa fa-arrow-right"></i>
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a href="https://github.com/romkatv/powerlevel10k/edit/master/docs/installation.md" class="nav-link"><i class="fa fa-github"></i> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
|
|
<span class="fa fa-angle-down"></span>
|
|
</button>
|
|
</div>
|
|
|
|
|
|
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
|
|
<ul class="nav flex-column">
|
|
|
|
<li class="nav-item" data-level="1"><a href="#installation" class="nav-link">Installation</a>
|
|
<ul class="nav flex-column">
|
|
<li class="nav-item" data-level="2"><a href="#manual" class="nav-link">Manual</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#oh-my-zsh" class="nav-link">Oh My Zsh</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#prezto" class="nav-link">Prezto</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#zim" class="nav-link">Zim</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#antibody" class="nav-link">Antibody</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#antigen" class="nav-link">Antigen</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#zplug" class="nav-link">Zplug</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#zgen" class="nav-link">Zgen</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#zplugin" class="nav-link">Zplugin</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#zinit" class="nav-link">Zinit</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#homebrew" class="nav-link">Homebrew</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="nav-item" data-level="2"><a href="#arch-linux" class="nav-link">Arch Linux</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div></div>
|
|
<div class="col-md-9" role="main">
|
|
|
|
<h1 id="installation">Installation</h1>
|
|
<ol>
|
|
<li>Install <a href="../fonts/">the recommended font</a>. <em>Optional but highly
|
|
recommended.</em></li>
|
|
<li>Install Powerlevel10k for your plugin manager.</li>
|
|
<li><a href="#manual">Manual</a> 👈 <strong>choose this if confused or uncertain</strong></li>
|
|
<li><a href="#oh-my-zsh">Oh My Zsh</a></li>
|
|
<li><a href="#prezto">Prezto</a></li>
|
|
<li><a href="#zim">Zim</a></li>
|
|
<li><a href="#antibody">Antibody</a></li>
|
|
<li><a href="#antigen">Antigen</a></li>
|
|
<li><a href="#zplug">Zplug</a></li>
|
|
<li><a href="#zgen">Zgen</a></li>
|
|
<li><a href="#zplugin">Zplugin</a></li>
|
|
<li><a href="#zinit">Zinit</a></li>
|
|
<li><a href="#homebrew">Homebrew</a></li>
|
|
<li><a href="#arch-linux">Arch Linux</a></li>
|
|
<li>Restart Zsh.</li>
|
|
<li>Type <code>p10k configure</code> if the configuration wizard doesn't start automatically.</li>
|
|
</ol>
|
|
<h2 id="manual">Manual</h2>
|
|
<pre><code class="zsh">git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ~/powerlevel10k
|
|
echo 'source ~/powerlevel10k/powerlevel10k.zsh-theme' >>~/.zshrc
|
|
</code></pre>
|
|
|
|
<p>Users in mainland China can use the official mirror on gitee.com for faster download.<br>
|
|
中国大陆用户可以使用 gitee.com 上的官方镜像加速下载.</p>
|
|
<pre><code class="zsh">git clone --depth=1 https://gitee.com/romkatv/powerlevel10k.git ~/powerlevel10k
|
|
echo 'source ~/powerlevel10k/powerlevel10k.zsh-theme' >>~/.zshrc
|
|
</code></pre>
|
|
|
|
<p>This is the simplest kind of installation and it works even if you are using a plugin manager. Just
|
|
make sure to disable the current theme in your plugin manager. See
|
|
<a href="../troubleshooting/#cannot-make-powerlevel10k-work-with-my-plugin-manager">troubleshooting</a> for help.</p>
|
|
<h2 id="oh-my-zsh">Oh My Zsh</h2>
|
|
<pre><code class="zsh">git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k
|
|
</code></pre>
|
|
|
|
<p>Users in mainland China can use the official mirror on gitee.com for faster download.<br>
|
|
中国大陆用户可以使用 gitee.com 上的官方镜像加速下载.</p>
|
|
<pre><code class="zsh">git clone --depth=1 https://gitee.com/romkatv/powerlevel10k.git ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k
|
|
</code></pre>
|
|
|
|
<p>Set <code>ZSH_THEME="powerlevel10k/powerlevel10k"</code> in <code>~/.zshrc</code>.</p>
|
|
<h2 id="prezto">Prezto</h2>
|
|
<p>Add <code>zstyle :prezto:module:prompt theme powerlevel10k</code> to <code>~/.zpreztorc</code>.</p>
|
|
<h2 id="zim">Zim</h2>
|
|
<p>Add <code>zmodule romkatv/powerlevel10k</code> to <code>~/.zimrc</code> and run <code>zimfw install</code>.</p>
|
|
<h2 id="antibody">Antibody</h2>
|
|
<p>Add <code>antibody bundle romkatv/powerlevel10k</code> to <code>~/.zshrc</code>.</p>
|
|
<h2 id="antigen">Antigen</h2>
|
|
<p>Add <code>antigen theme romkatv/powerlevel10k</code> to <code>~/.zshrc</code>. Make sure you have <code>antigen apply</code>
|
|
somewhere after it.</p>
|
|
<h2 id="zplug">Zplug</h2>
|
|
<p>Add <code>zplug romkatv/powerlevel10k, as:theme, depth:1</code> to <code>~/.zshrc</code>.</p>
|
|
<h2 id="zgen">Zgen</h2>
|
|
<p>Add <code>zgen load romkatv/powerlevel10k powerlevel10k</code> to <code>~/.zshrc</code>.</p>
|
|
<h2 id="zplugin">Zplugin</h2>
|
|
<p>Add <code>zplugin ice depth=1; zplugin light romkatv/powerlevel10k</code> to <code>~/.zshrc</code>.</p>
|
|
<p>The use of <code>depth=1</code> ice is optional. Other types of ice are neither recommended nor officially
|
|
supported by Powerlevel10k.</p>
|
|
<h2 id="zinit">Zinit</h2>
|
|
<p>Add <code>zinit ice depth=1; zinit light romkatv/powerlevel10k</code> to <code>~/.zshrc</code>.</p>
|
|
<p>The use of <code>depth=1</code> ice is optional. Other types of ice are neither recommended nor officially
|
|
supported by Powerlevel10k.</p>
|
|
<h2 id="homebrew">Homebrew</h2>
|
|
<pre><code class="zsh">brew install romkatv/powerlevel10k/powerlevel10k
|
|
echo 'source /usr/local/opt/powerlevel10k/powerlevel10k.zsh-theme' >>~/.zshrc
|
|
</code></pre>
|
|
|
|
<h2 id="arch-linux">Arch Linux</h2>
|
|
<pre><code class="zsh">yay -S --noconfirm zsh-theme-powerlevel10k-git
|
|
echo 'source /usr/share/zsh-theme-powerlevel10k/powerlevel10k.zsh-theme' >>~/.zshrc
|
|
</code></pre>
|
|
|
|
<p><a href="https://aur.archlinux.org/packages/zsh-theme-powerlevel10k-git/">zsh-theme-powerlevel10k-git</a>
|
|
referenced above is the official Powerlevel10k package.</p>
|
|
<p>There is also <a href="https://www.archlinux.org/packages/community/x86_64/zsh-theme-powerlevel10k/">zsh-theme-powerlevel10k</a> community package.
|
|
Historicaly, <a href="https://github.com/romkatv/powerlevel10k/pull/786">it has been breaking often and for extended periods of time</a>. <strong>Do not use it.</strong></p></div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="col-md-12">
|
|
<hr>
|
|
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
|
|
</footer>
|
|
<script>
|
|
var base_url = "..",
|
|
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
|
|
</script>
|
|
<script src="../js/base.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
|
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
|
<div class="modal-dialog modal-lg">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
|
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
|
|
</div>
|
|
<div class="modal-body">
|
|
<p>
|
|
From here you can search these documents. Enter
|
|
your search terms below.
|
|
</p>
|
|
<form>
|
|
<div class="form-group">
|
|
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
|
</div>
|
|
</form>
|
|
<div id="mkdocs-search-results"></div>
|
|
</div>
|
|
<div class="modal-footer">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
|
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
|
|
</div>
|
|
<div class="modal-body">
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 20%;">Keys</th>
|
|
<th>Action</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="help shortcut"><kbd>?</kbd></td>
|
|
<td>Open this help</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="next shortcut"><kbd>n</kbd></td>
|
|
<td>Next page</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
|
<td>Previous page</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="search shortcut"><kbd>s</kbd></td>
|
|
<td>Search</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="modal-footer">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|