powerlevel10k/docs/site/features/current_directory/index.html

247 lines
11 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>Current Directory that just works - 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 active">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Features <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../wizard/" class="dropdown-item">Configuration wizard</a>
</li>
<li>
<a href="../uncompromising_performance/" class="dropdown-item">Uncompromising performance</a>
</li>
<li>
<a href="../p9k_compatibility/" class="dropdown-item">Powerlevel9k Compatibility</a>
</li>
<li>
<a href="../pure_compatibility/" class="dropdown-item">Pure compatibility</a>
</li>
<li>
<a href="../instant_prompt/" class="dropdown-item">Instant prompt</a>
</li>
<li>
<a href="../show_on_command/" class="dropdown-item">Show on command</a>
</li>
<li>
<a href="../transient_prompt/" class="dropdown-item">Transient prompt</a>
</li>
<li>
<a href="./" class="dropdown-item active">Current Directory that just works</a>
</li>
<li>
<a href="../customizable/" class="dropdown-item">Extremely Customizable</a>
</li>
<li>
<a href="../batteries_included/" class="dropdown-item">Batteries included</a>
</li>
<li>
<a href="../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="../transient_prompt/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../customizable/" 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/features/current_directory.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="#current-directory-that-just-works" class="nav-link">Current directory that just works</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="current-directory-that-just-works">Current directory that just works</h1>
<p>The current working directory is perhaps the most important prompt segment. Powerlevel10k goes to
great length to highlight its important parts and to truncate it with the least loss of information
when horizontal space gets scarce.</p>
<p><img alt="Powerlevel10k Directory Truncation" src="https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/directory-truncation.gif" /></p>
<p>When the full directory doesn't fit, the leftmost segment gets truncated to its shortest unique
prefix. In the screencast, <code>~/work</code> becomes <code>~/wo</code>. It couldn't be truncated to <code>~/w</code> because it
would be ambiguous (there was <code>~/wireguard</code> when the session was recorded). The next segment --
<code>projects</code> -- turns into <code>p</code> as there was nothing else that started with <code>p</code> in <code>~/work/</code>.</p>
<p>Directory segments are shown in one of three colors:</p>
<ul>
<li>Truncated segments are bleak.</li>
<li>Important segments are bright and never truncated. These include the first and the last segment,
roots of Git repositories, etc.</li>
<li>Regular segments (not truncated but can be) use in-between color.</li>
</ul>
<p><em>Tip</em>: If you copy-paste a truncated directory and hit <em>TAB</em>, it'll complete to the original.</p>
<p><em>Troubleshooting</em>: <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></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>