updated docs

This commit is contained in:
Paul Wilde 2024-08-24 21:22:25 +01:00
parent 2d2988b9aa
commit ec981010f9
4 changed files with 50 additions and 6 deletions

View file

@ -6,3 +6,11 @@ date = 2024-08-24T13:00:00
This website serves as a point of reference for both documentation and This website serves as a point of reference for both documentation and
assistance when using the `norg` backup utilitiy. assistance when using the `norg` backup utilitiy.
Please use the menu or search function to find the information you require. Please use the menu or search function to find the information you require.
## Naming. Why "Norg"?
Norg is really short for "Nice Borg" - a way to nicely handle borg based backups.
Also, I'm a Star Trek fan so obviously I wanted to keep something in line with the
[Borg pseudo-species](https://memory-alpha.fandom.com/wiki/Borg) as the borg backup utility does.
Also, sometimes I feel my code has elements of inexperience but loads of potential... which reminded me of [Nog](https://memory-alpha.fandom.com/wiki/Nog).
So, simply put, `Norg` could also be a portmanteau of "Borg" and "Nog".

View file

@ -1,8 +1,31 @@
header {
padding:0 1rem;
border-bottom:1px solid black;
a { a {
&:link {
color: green;
}
&:visited {
color: darkgreen;
}
&:hover {
color: lightgreen;
}
}
main{
a {
&:link {
text-decoration: underline;
}
}
nav {
a {
&:link {
text-decoration: none; text-decoration: none;
color:initial;
} }
} }
}
}
footer {
padding:1rem;
text-align:right;
}

3
docs/static/.domains vendored Normal file
View file

@ -0,0 +1,3 @@
norgbackup.net
www.norgbackup.net
pages.norgbackupweb.pswilde.codeberg.page

View file

@ -3,6 +3,7 @@
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<link rel="stylesheet" href="{{ get_url(path="main.css") | safe }}"> <link rel="stylesheet" href="{{ get_url(path="main.css") | safe }}">
<link rel="stylesheet" href="{{ get_url(path="norg.css") | safe }}">
{% if config.extra.favicon -%} {% if config.extra.favicon -%}
{% set _favicon = config.extra.favicon -%} {% set _favicon = config.extra.favicon -%}
{% if (_favicon is starting_with("http")) == false -%} {% if (_favicon is starting_with("http")) == false -%}
@ -142,9 +143,18 @@
{% endif -%} {% endif -%}
{% endblock content %} {% endblock content %}
</div> </div>
<hr />
<h2>Help us improve this documentation.</h2>
<p>If you find an error, or think something could be explained better,
<a href="https://codeberg.org/pswilde/norgbackup/issues">raise an issue</a> to
send your feedback.</p>
</article> </article>
</main> </main>
<footer>
<p>Norg Backup Utility &copy; {{ now() | date(format="%Y") }} Paul Wilde<br/>
Site created using <a href="https://getzola.org">Zola</a> using the
<a href="https://github.com/codeandmedia/zola_easydocs_theme">easydocs</a> theme.</p>
</footer>
{% if config.build_search_index %} {% if config.build_search_index %}
<script type="text/javascript" src="{{ get_url(path="elasticlunr.min.js") | safe }}" defer></script> <script type="text/javascript" src="{{ get_url(path="elasticlunr.min.js") | safe }}" defer></script>