Skip to content

Commit

Permalink
deploy: d2091f7
Browse files Browse the repository at this point in the history
  • Loading branch information
ulises-jeremias committed Feb 12, 2024
1 parent 335f2e4 commit c25a8b5
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@
<div class="nav-container">
<div class="nav-inner" id="scroll-spy" style="width: min-content; overflow: auto; top: 60px; bottom: 0; padding 10px 0 10px 0;">
<span class="toc">Table of contents</span>
<ul class="nav"><li class="active"><a href="#Home">🏠 Home</a></li><li><a href="dots">💥 Dots Scripts Utility</a></li><li><a href="#Customization">🎨 Customization</a><ul class="nav"><li><a href="#Window-Managers">🪟 Window Manager</a><ul class="nav"><li><a href="#Xfce4">XFCE 4</a></li><li><a href="#i3">i3 WM</a><ul class="nav"><li><a href="i3#autostart-applications">Autostart Applications</a></li><li><a href="i3#i3-keybindings">i3 Keybindings</a></li></ul></li><li><a href="#Openbox">Openbox</a><ul class="nav"><li><a href="Openbox#openbox-configuration">Openbox Configuration</a></li></ul></li></ul></li><li><span>🖌️ Misc Customization</span><ul class="nav"><li><a href="#Alacritty">Alacritty</a></li><li><a href="#Apps-Launcher">Apps Launcher</a></li><li><a href="#Network-Manager">Network Manager</a></li><li><a href="#Polybar">Polybar</a><ul class="nav"><li><a href="Polybar#parameters">Parameters</a></li><li><span>Available polybar modules</span><ul class="nav"><li><a href="./Polybar-Modules:-alsa">alsa</a></li><li><a href="./Polybar-Modules:-backlight">backlight</a></li><li><a href="./Polybar-Modules:-battery">battery</a></li><li><a href="./Polybar-Modules:-bluetooth">bluetooth</a></li><li><a href="./Polybar-Modules:-cpu">cpu</a></li><li><a href="./Polybar-Modules:-date">date</a></li><li><a href="./Polybar-Modules:-i3">i3</a></li><li><a href="./Polybar-Modules:-jgmenu">jgmenu</a></li><li><a href="./Polybar-Modules:-memory">memory</a></li><li><a href="./Polybar-Modules:-microphone">microphone</a></li><li><a href="./Polybar-Modules:-network">network</a></li><li><a href="./Polybar-Modules:-nightmode">nightmode</a></li><li><a href="./Polybar-Modules:-pulseaudio">pulseaudio</a></li><li><a href="./Polybar-Modules:-spotify">spotify</a></li><li><a href="./Polybar-Modules:-temperature">temperature</a></li></ul></li></ul></li><li><a href="#Zsh">Zsh</a><ul class="nav"><li><span>Customization and Parameters</span></li><li><span>Zsh + Antigen</span></li><li><span>Zsh + Power Level 10k</span></li><li><span>Zsh + Oh My Zsh</span></li></ul></li></ul></li></ul></li><li><a href="#Security">🛡️ Privacy and Security</a></li><li><a href="#Dots-Backup">📁 Dots Backup Tool</a></li><li><a href="#Dots-Eject">⏏️ Dots Eject</a></li><li><a href="#CONTRIBUTING">💯 Contributing</a></li><li><a href="#Testing">🧪 Testing</a></li></ul>
<ul class="nav"><li class="active"><a href="#Home">🏠 Home</a></li><li><a href="#Dots-Scripts">💥 Dots Scripts Utility</a><ul class="nav"><li><a href="Dots-Scripts#usage">Usage</a></li><li><a href="Dots-Scripts#available-scripts">Available Scripts</a></li></ul></li><li><a href="#Customization">🎨 Customization</a><ul class="nav"><li><a href="#Window-Managers">🪟 Window Manager</a><ul class="nav"><li><a href="#Xfce4">XFCE 4</a></li><li><a href="#i3">i3 WM</a><ul class="nav"><li><a href="i3#autostart-applications">Autostart Applications</a></li><li><a href="i3#i3-keybindings">i3 Keybindings</a></li></ul></li><li><a href="#Openbox">Openbox</a><ul class="nav"><li><a href="Openbox#openbox-configuration">Openbox Configuration</a></li></ul></li></ul></li><li><span>🖌️ Misc Customization</span><ul class="nav"><li><a href="#Alacritty">Alacritty</a></li><li><a href="#Apps-Launcher">Apps Launcher</a></li><li><a href="#Network-Manager">Network Manager</a></li><li><a href="#Polybar">Polybar</a><ul class="nav"><li><a href="Polybar#parameters">Parameters</a></li><li><span>Available polybar modules</span><ul class="nav"><li><a href="./Polybar-Modules:-alsa">alsa</a></li><li><a href="./Polybar-Modules:-backlight">backlight</a></li><li><a href="./Polybar-Modules:-battery">battery</a></li><li><a href="./Polybar-Modules:-bluetooth">bluetooth</a></li><li><a href="./Polybar-Modules:-cpu">cpu</a></li><li><a href="./Polybar-Modules:-date">date</a></li><li><a href="./Polybar-Modules:-i3">i3</a></li><li><a href="./Polybar-Modules:-jgmenu">jgmenu</a></li><li><a href="./Polybar-Modules:-memory">memory</a></li><li><a href="./Polybar-Modules:-microphone">microphone</a></li><li><a href="./Polybar-Modules:-network">network</a></li><li><a href="./Polybar-Modules:-nightmode">nightmode</a></li><li><a href="./Polybar-Modules:-pulseaudio">pulseaudio</a></li><li><a href="./Polybar-Modules:-spotify">spotify</a></li><li><a href="./Polybar-Modules:-temperature">temperature</a></li></ul></li></ul></li><li><a href="#Zsh">Zsh</a><ul class="nav"><li><span>Customization and Parameters</span></li><li><span>Zsh + Antigen</span></li><li><span>Zsh + Power Level 10k</span></li><li><span>Zsh + Oh My Zsh</span></li></ul></li></ul></li></ul></li><li><a href="#Security">🛡️ Privacy and Security</a></li><li><a href="#Dots-Backup">📁 Dots Backup Tool</a></li><li><a href="#Dots-Eject">⏏️ Dots Eject</a></li><li><a href="#CONTRIBUTING">💯 Contributing</a></li><li><a href="#Testing">🧪 Testing</a></li></ul>

</div>
</div>
Expand Down Expand Up @@ -754,6 +754,39 @@ <h1>🚀 Dotfiles Generator</h1>
<p><img src="https://github.com/ulises-jeremias/dotfiles/blob/master/static/screen-2.jpg?raw=true" /></p>
<p><img src="https://github.com/ulises-jeremias/dotfiles/blob/master/static/screenshot-nord-two-lines.png?raw=true" /></p>
<p><img src="https://github.com/ulises-jeremias/dotfiles/blob/master/static/screenshot-launchpad.png?raw=true" /></p>
<p class="page" id="Dots-Scripts"></p><h1>💥 Dots Scripts Utility</h1>
<p>In the dotfiles installation process, various scripts are added for configuring applications and modules. While these scripts are primarily used for module configuration, they can also be used independently. To simplify the management of these scripts, we provide the <code>dots</code> utility.</p>
<p>The <code>dots</code> utility provides a convenient way to manage and execute these scripts. You can explore their functionalities and customize them as needed.</p>
<h2 id="usage">Usage</h2>
<pre class="hljs">dots --<span class="hljs-built_in">help</span> <span class="hljs-comment"># Show help</span>
dots --list <span class="hljs-comment"># List all available scripts</span>
dots &lt;script&gt; <span class="hljs-comment"># Run a specific script with optional flags</span></pre><h2 id="available-scripts">Available Scripts</h2>
<blockquote>
<p>NOTE: The following list may not be exhaustive. You can always check the up-to-date list of scripts by running <code>dots --list</code>.</p>
</blockquote>
<ul>
<li><code>brightness</code>: Control the screen brightness using various backends such as <code>xbacklight</code>, <code>brightnessctl</code>, <code>blight</code>, or <code>xrandr</code>.</li>
<li><code>check-network</code>: Check if the network connection is up.</li>
<li><code>checkupdates</code>: Check for updates.</li>
<li><code>feh-blur</code>: Blur the background of the current window when using <code>feh</code> to set the wallpaper.</li>
<li><code>git-notify</code>: Show a notification when a git commit is made.</li>
<li><code>microphone</code>: Control the microphone settings.</li>
<li><code>monitor</code>: Print the name of the current monitor.</li>
<li><code>night-mode</code>: Toggle night mode.</li>
<li><code>openweathermap-detailed</code>: Print detailed weather information.</li>
<li><code>popup-calendar</code>: Show a calendar in a popup.</li>
<li><code>rofi-bluetooth</code>: Show a rofi menu to manage Bluetooth devices.</li>
<li><code>rofi-randr</code>: Show a rofi menu to manage the screen resolution.</li>
<li><code>rofi-run</code>: Show a rofi menu to run commands.</li>
<li><code>rofi-xrandr</code>: Show a rofi menu to manage the screen resolution with charts.</li>
<li><code>screenshooter</code>: Take a screenshot.</li>
<li><code>spotify</code>: Get information about the currently playing song in Spotify.</li>
<li><code>sysupdate</code>: Update the system.</li>
<li><code>toggle</code>: Toggle the state of specific applications.</li>
<li><code>updates</code>: Check for updates.</li>
<li><code>weather</code>: Print the current weather information.</li>
</ul>
<p>Feel free to use these scripts to enhance your system configuration and workflow!</p>
<p class="page" id="Customization"></p><h1>🎨 Customization</h1>
<p>You can fork this repository and customize it to suit your preferences and workflow. You are encouraged to maintain a separate GitHub repository of configurations for your own dotfiles and keep this repository as a template!</p>
<p>We use <a href="https://www.chezmoi.io/">Chezmoi</a> to manage the dotfiles. Chezmoi is a sophisticated yet easy-to-use command-line tool that helps you manage your dotfiles across multiple machines. It is designed to be secure, flexible, and easy to use.</p>
Expand Down

0 comments on commit c25a8b5

Please sign in to comment.