Skip to content

Commit

Permalink
build based on 3f9394f
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 31, 2024
1 parent 5d24fc8 commit 4aa7f24
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-31T18:27:55","documenter_version":"1.0.1"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-31T18:33:20","documenter_version":"1.0.1"}}
2 changes: 1 addition & 1 deletion dev/defaults/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Introduction · BaseDirs.jl</title><meta name="title" content="Introduction · BaseDirs.jl"/><meta property="og:title" content="Introduction · BaseDirs.jl"/><meta property="twitter:title" content="Introduction · BaseDirs.jl"/><meta name="description" content="Documentation for BaseDirs.jl."/><meta property="og:description" content="Documentation for BaseDirs.jl."/><meta property="twitter:description" content="Documentation for BaseDirs.jl."/><meta property="og:url" content="https://tecosaur.github.io/BaseDirs.jl/"/><meta property="twitter:url" content="https://tecosaur.github.io/BaseDirs.jl/"/><link rel="canonical" href="https://tecosaur.github.io/BaseDirs.jl/"/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>BaseDirs.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Introduction</a><ul class="internal"><li><a class="tocitem" href="#Why-should-I-care?"><span>Why should I care?</span></a></li><li><a class="tocitem" href="#Choosing-the-appropriate-base-directory"><span>Choosing the appropriate base directory</span></a></li></ul></li><li><a class="tocitem" href="usage/">Usage</a></li><li><a class="tocitem" href="defaults/">Defaults</a></li><li><a class="tocitem" href="others/">Prior Art</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Introduction</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Introduction</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/tecosaur/BaseDirs.jl/blob/main/docs/src/index.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="BaseDirs"><a class="docs-heading-anchor" href="#BaseDirs">BaseDirs</a><a id="BaseDirs-1"></a><a class="docs-heading-anchor-permalink" href="#BaseDirs" title="Permalink"></a></h1><p>This package exists to help you <em>put and look for files in the appropriate place(s)</em>.</p><p>It is essentially an implementation of the XDG (Cross-Desktop Group) directory specifications, with analogues for Windows and MacOS for cross-platform. More specifically, this is a hybrid of:</p><ul><li>The <a href="https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG base directory</a> and the <a href="https://www.freedesktop.org/wiki/Software/xdg-user-dirs/">XDG user directory</a> specifications on Linux</li><li>The <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd378457.aspx">Known Folder</a> API on Windows</li><li>The <a href="https://developer.apple.com/library/content/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW6">Standard Directories</a> guidelines on macOS</li></ul><h2 id="Why-should-I-care?"><a class="docs-heading-anchor" href="#Why-should-I-care?">Why should I care?</a><a id="Why-should-I-care?-1"></a><a class="docs-heading-anchor-permalink" href="#Why-should-I-care?" title="Permalink"></a></h2><p>It may be easy to treat file paths haphazardly, but for the user in particular abiding by the standards/conventions of the their platform has a number of major benefits, such as:</p><ul><li>Improved ease of backups, since it is easier to make rules for which folders need to be backed up.</li><li>Improved configuration portability, since it is easier to identify and share the relevant configuration files.</li><li>Ease of isolating application state, by containing state to a single directory it is easy to avoid sharing it.</li><li>Decreased reliance on hard-coded paths, improving flexibility and composability.</li></ul><p>It is worth noting that these considerations apply to <em>both</em> graphical and command-line desktop applications.</p><h2 id="Choosing-the-appropriate-base-directory"><a class="docs-heading-anchor" href="#Choosing-the-appropriate-base-directory">Choosing the appropriate base directory</a><a id="Choosing-the-appropriate-base-directory-1"></a><a class="docs-heading-anchor-permalink" href="#Choosing-the-appropriate-base-directory" title="Permalink"></a></h2><p><img src="xdg-flowchart.svg" alt="image"/></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">Usage »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 31 July 2024 18:27">Wednesday 31 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Introduction · BaseDirs.jl</title><meta name="title" content="Introduction · BaseDirs.jl"/><meta property="og:title" content="Introduction · BaseDirs.jl"/><meta property="twitter:title" content="Introduction · BaseDirs.jl"/><meta name="description" content="Documentation for BaseDirs.jl."/><meta property="og:description" content="Documentation for BaseDirs.jl."/><meta property="twitter:description" content="Documentation for BaseDirs.jl."/><meta property="og:url" content="https://tecosaur.github.io/BaseDirs.jl/"/><meta property="twitter:url" content="https://tecosaur.github.io/BaseDirs.jl/"/><link rel="canonical" href="https://tecosaur.github.io/BaseDirs.jl/"/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>BaseDirs.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Introduction</a><ul class="internal"><li><a class="tocitem" href="#Why-should-I-care?"><span>Why should I care?</span></a></li><li><a class="tocitem" href="#Choosing-the-appropriate-base-directory"><span>Choosing the appropriate base directory</span></a></li></ul></li><li><a class="tocitem" href="usage/">Usage</a></li><li><a class="tocitem" href="defaults/">Defaults</a></li><li><a class="tocitem" href="others/">Prior Art</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Introduction</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Introduction</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/tecosaur/BaseDirs.jl/blob/main/docs/src/index.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="BaseDirs"><a class="docs-heading-anchor" href="#BaseDirs">BaseDirs</a><a id="BaseDirs-1"></a><a class="docs-heading-anchor-permalink" href="#BaseDirs" title="Permalink"></a></h1><p>This package exists to help you <em>put and look for files in the appropriate place(s)</em>.</p><p>It is essentially an implementation of the XDG (Cross-Desktop Group) directory specifications, with analogues for Windows and MacOS for cross-platform. More specifically, this is a hybrid of:</p><ul><li>The <a href="https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG base directory</a> and the <a href="https://www.freedesktop.org/wiki/Software/xdg-user-dirs/">XDG user directory</a> specifications on Linux</li><li>The <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd378457.aspx">Known Folder</a> API on Windows</li><li>The <a href="https://developer.apple.com/library/content/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW6">Standard Directories</a> guidelines on macOS</li></ul><h2 id="Why-should-I-care?"><a class="docs-heading-anchor" href="#Why-should-I-care?">Why should I care?</a><a id="Why-should-I-care?-1"></a><a class="docs-heading-anchor-permalink" href="#Why-should-I-care?" title="Permalink"></a></h2><p>It may be easy to treat file paths haphazardly, but for the user in particular abiding by the standards/conventions of the their platform has a number of major benefits, such as:</p><ul><li>Improved ease of backups, since it is easier to make rules for which folders need to be backed up.</li><li>Improved configuration portability, since it is easier to identify and share the relevant configuration files.</li><li>Ease of isolating application state, by containing state to a single directory it is easy to avoid sharing it.</li><li>Decreased reliance on hard-coded paths, improving flexibility and composability.</li></ul><p>It is worth noting that these considerations apply to <em>both</em> graphical and command-line desktop applications.</p><h2 id="Choosing-the-appropriate-base-directory"><a class="docs-heading-anchor" href="#Choosing-the-appropriate-base-directory">Choosing the appropriate base directory</a><a id="Choosing-the-appropriate-base-directory-1"></a><a class="docs-heading-anchor-permalink" href="#Choosing-the-appropriate-base-directory" title="Permalink"></a></h2><p><img src="xdg-flowchart.svg" alt="image"/></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">Usage »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 31 July 2024 18:33">Wednesday 31 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/others/index.html
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 4aa7f24

Please sign in to comment.