From ad2c9a241fdc90a2971e688adef196b17970ac52 Mon Sep 17 00:00:00 2001 From: Hayden <64056131+hay-kot@users.noreply.github.com> Date: Wed, 19 Oct 2022 16:47:36 -0800 Subject: [PATCH] add docs for links --- docs/docs/quick-start.md | 2 +- docs/docs/tips-tricks.md | 16 ++++++++++++++++ docs/mkdocs.yml | 1 + 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 docs/docs/tips-tricks.md diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.md index d3e97a2..8f25644 100644 --- a/docs/docs/quick-start.md +++ b/docs/docs/quick-start.md @@ -13,7 +13,7 @@ docker run --name=homebox \ ## Docker-Compose -```yml +```yaml version: "3.4" services: diff --git a/docs/docs/tips-tricks.md b/docs/docs/tips-tricks.md new file mode 100644 index 0000000..30f9f1c --- /dev/null +++ b/docs/docs/tips-tricks.md @@ -0,0 +1,16 @@ +# Tips and Tricks + +## Custom Fields + +Custom fields are a great way to add any extra information to your item. The following types are supported: + +- [x] Text +- [ ] Integer (Future) +- [ ] Boolean (Future) +- [ ] Timestamp (Future) + +Custom fields are appended to the main details section of your item. + +!!! tip + Homebox Custom Fields also have special support for URLs. Provide a URL (`https://google.com`) and it will be automatically converted to a clickable link in the UI. Optionally, you can also use markdown syntax to add a custom text to the button. `[Google](https://google.com)` + diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3437089..6d0924e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -47,5 +47,6 @@ markdown_extensions: nav: - Home: index.md - Quick Start: quick-start.md + - Tips and Tricks: tips-tricks.md - Importing Data: import-csv.md - Building The Binary: build.md