mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-21 21:13:22 +00:00
sammyette
e5eefb1d2d
changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
19 lines
427 B
Markdown
19 lines
427 B
Markdown
---
|
|
title: Interface hilbish.userDir
|
|
description: user-related directories
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "API"
|
|
---
|
|
|
|
## Introduction
|
|
This interface just contains properties to know about certain user directories.
|
|
It is equivalent to XDG on Linux and gets the user's preferred directories
|
|
for configs and data.
|
|
|
|
## Interface fields
|
|
- `config`: The user's config directory
|
|
- `data`: The user's directory for program data
|
|
|