powerlevel10k/docs/configuration/index.html

261 lines
12 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>Configuration - 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">
<a href="../installation/" 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 href="https://github.com/romkatv/powerlevel10k/edit/master/docs/configuration.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="#configuration" class="nav-link">Configuration</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#for-new-users" class="nav-link">For new users</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#for-powerlevel9k-users" class="nav-link">For Powerlevel9k users</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="configuration">Configuration</h1>
<h2 id="for-new-users">For new users</h2>
<p>On the first run, Powerlevel10k <a href="../features/wizard/">configuration wizard</a> will ask you a few
questions and configure your prompt. If it doesn't trigger automatically, type <code>p10k configure</code>.
Configuration wizard creates <code>~/.p10k.zsh</code> based on your preferences. Additional prompt
customization can be done by editing this file. It has plenty of comments to help you navigate
through configuration options.</p>
<p><em>FAQ</em>:</p>
<ul>
<li><a href="../faq/#what-is-the-best-prompt-style-in-the-configuration-wizard">What is the best prompt style in the configuration wizard?</a></li>
<li><a href="../faq/#what-do-different-symbols-in-git-status-mean">What do different symbols in Git status mean?</a></li>
<li><a href="../faq/#how-do-i-change-the-format-of-git-status">How do I change the format of Git status?</a></li>
<li><a href="../faq/#how-do-i-add-username-andor-hostname-to-prompt">How do I add username and/or hostname to prompt?</a></li>
<li><a href="../faq/#how-do-i-change-prompt-colors">How do I change prompt colors?</a></li>
<li><a href="../faq/#why-some-prompt-segments-appear-and-disappear-as-im-typing">Why some prompt segments appear and disappear as I'm typing?</a></li>
</ul>
<p><em>Troubleshooting</em>:</p>
<ul>
<li><a href="../troubleshooting/#question-mark-in-prompt">Question mark in prompt</a>.</li>
<li><a href="../troubleshooting/#icons-glyphs-or-powerline-symbols-dont-render">Icons, glyphs or powerline symbols don't render</a>.</li>
<li><a href="../troubleshooting/#sub-pixel-imperfections-around-powerline-symbols">Sub-pixel imperfections around powerline symbols</a>.</li>
<li><a href="../troubleshooting/#directory-is-difficult-to-see-in-prompt-when-using-rainbow-style">Directory is difficult to see in prompt when using Rainbow style</a>.</li>
</ul>
<h2 id="for-powerlevel9k-users">For Powerlevel9k users</h2>
<p>If you've been using Powerlevel9k before, <strong>do not remove the configuration options</strong>. Powerlevel10k
will pick them up and provide you with the same prompt UI you are used to. See
<a href="#powerlevel9k-compatibility">Powerlevel9k compatibility</a>.</p>
<p><em>FAQ</em>:</p>
<ul>
<li><a href="../faq/#im-using-powerlevel9k-with-oh-my-zsh-how-do-i-migrate">I'm using Powerlevel9k with Oh My Zsh. How do I migrate?</a></li>
<li><a href="../faq/#what-is-the-relationship-between-powerlevel9k-and-powerlevel10k">What is the relationship between Powerlevel9k and Powerlevel10k?</a></li>
<li><a href="../faq/#does-powerlevel10k-always-render-exactly-the-same-prompt-as-powerlevel9k-given-the-same-config">Does Powerlevel10k always render exactly the same prompt as Powerlevel9k given the same config?</a></li>
</ul>
<p><em>Troubleshooting</em>: <a href="../troubleshooting/#extra-or-missing-spaces-in-prompt-compared-to-powerlevel9k">Extra or missing spaces in prompt compared to Powerlevel9k</a>.</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">&times;</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">&times;</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>