Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mdBook Documentation #74

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# A Prefix Chapter
6 changes: 6 additions & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[book]
authors = ["Pablo Ovelleiro Corral"]
language = "en"
multilingual = false
src = "src"
title = "NixOS Configuration"
205 changes: 205 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js light">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>A Prefix Chapter - NixOS Configuration</title>


<!-- Custom HTML head -->


<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />

<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">

<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">

<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">

<!-- Custom theme stylesheets -->

</head>
<body>
<!-- Provide site root to javascript -->
<script type="text/javascript">
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>

<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script type="text/javascript">
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script type="text/javascript">
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
</script>

<!-- Hide / unhide sidebar before it is displayed -->
<script type="text/javascript">
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../index.html" class="active">A Prefix Chapter</a></li><li class="chapter-item expanded "><a href="structure.html"><strong aria-hidden="true">1.</strong> Structure</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="hosts.html"><strong aria-hidden="true">1.1.</strong> Hosts</a></li><li class="chapter-item expanded "><a href="modules.html"><strong aria-hidden="true">1.2.</strong> Modules</a></li><li class="chapter-item expanded "><a href="users.html"><strong aria-hidden="true">1.3.</strong> Users Profiles</a></li><li class="chapter-item expanded "><a href="overlay.html"><strong aria-hidden="true">1.4.</strong> Custom Packages</a></li></ol></li><li class="chapter-item expanded "><a href="deployment.html"><strong aria-hidden="true">2.</strong> Deployment</a></li><li class="chapter-item expanded "><a href="secrets.html"><strong aria-hidden="true">3.</strong> Secrets</a></li><li class="chapter-item expanded "><a href="backup.html"><strong aria-hidden="true">4.</strong> Backup Stategy</a></li><li class="chapter-item expanded "><a href="cache.html"><strong aria-hidden="true">5.</strong> Cache</a></li><li class="chapter-item expanded "><a href="monitoring.html"><strong aria-hidden="true">6.</strong> Monitoring</a></li><li class="chapter-item expanded "><a href="add_host.html"><strong aria-hidden="true">7.</strong> Adding Hosts</a></li><li class="chapter-item expanded "><a href="documentation.html"><strong aria-hidden="true">8.</strong> Documentation</a></li></ol> </div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>

<div id="page-wrapper" class="page-wrapper">

<div class="page">

<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky bordered">
<div class="left-buttons">
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</button>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title">NixOS Configuration</h1>

<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>

</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>

<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script type="text/javascript">
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="a-prefix-chapter"><a class="header" href="#a-prefix-chapter">A Prefix Chapter</a></h1>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->

<a rel="next" href="structure.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">

<a rel="next" href="structure.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>

</div>

<!-- Livereload script (if served using the cli tool) -->
<script type="text/javascript">
var socket = new WebSocket("ws://localhost:3000/__livereload");
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



<script type="text/javascript">
window.playground_copyable = true;
</script>


<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>

<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="book.js" type="text/javascript" charset="utf-8"></script>

<!-- Custom JS scripts -->


</body>
</html>
25 changes: 25 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Summary

[Readme](../../README.md)

- [Repository Structure](./structure.md)
- [Hosts](./structure/hosts.md)
- [Modules](./structure/modules.md)
- [Users Profiles](./structure/users.md)
- [Custom Packages](./structure/overlay.md)
- [Deployment](./deployment.md)
- [Secrets](./secrets.md)
- [Networking](./network.md)
- [User Configuration](./users/main.md)
- [Home-Manager](./users/home_manager.md)
- [Keys](./users/keys.md)
- [Monitoring](./monitoring.md)
- [Backup Stategy](./backup.md)
- [Initialize Repository](./backup/init_repo.md)
- [Includes and Excludes](./backup/paths.md)
- [Monitoring Reports](./backup/reports.md)
- [Cache](./cache.md)
- [Common Tasks](./tasks/main.md)
- [Adding Hosts](./tasks/add_host.md)
- [Adding/Modifying Packages](./tasks/add_package.md)
- [Documentation](./documentation.md)
1 change: 1 addition & 0 deletions docs/src/add_host.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding Hosts
1 change: 1 addition & 0 deletions docs/src/backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Backup Stategy
1 change: 1 addition & 0 deletions docs/src/cache.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Cache
1 change: 1 addition & 0 deletions docs/src/chapter_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Chapter 1
1 change: 1 addition & 0 deletions docs/src/deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Deployment
1 change: 1 addition & 0 deletions docs/src/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Documentation
1 change: 1 addition & 0 deletions docs/src/home_manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Home-Manager
1 change: 1 addition & 0 deletions docs/src/hosts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Hosts
1 change: 1 addition & 0 deletions docs/src/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Other Modules
1 change: 1 addition & 0 deletions docs/src/monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Monitoring
1 change: 1 addition & 0 deletions docs/src/network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Networking
1 change: 1 addition & 0 deletions docs/src/overlay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Custom Packages
1 change: 1 addition & 0 deletions docs/src/secrets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Secrets
1 change: 1 addition & 0 deletions docs/src/structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Structure
1 change: 1 addition & 0 deletions docs/src/structure/hosts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Hosts
1 change: 1 addition & 0 deletions docs/src/structure/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Modules
1 change: 1 addition & 0 deletions docs/src/structure/overlay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Custom Packages
1 change: 1 addition & 0 deletions docs/src/structure/users.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Users Profiles
1 change: 1 addition & 0 deletions docs/src/tasks/add_host.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding Hosts
1 change: 1 addition & 0 deletions docs/src/tasks/add_package.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding/Modifying Packages
1 change: 1 addition & 0 deletions docs/src/tasks/main.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Common Tasks
1 change: 1 addition & 0 deletions docs/src/users.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Users
1 change: 1 addition & 0 deletions docs/src/users/home_manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Home-Manager
1 change: 1 addition & 0 deletions docs/src/users/keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Keys
1 change: 1 addition & 0 deletions docs/src/users/main.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# User Configuration