add docs for links

This commit is contained in:
Hayden 2022-10-19 16:47:36 -08:00
parent 584675fd97
commit ad2c9a241f
3 changed files with 18 additions and 1 deletions

View file

@ -13,7 +13,7 @@ docker run --name=homebox \
## Docker-Compose
```yml
```yaml
version: "3.4"
services:

16
docs/docs/tips-tricks.md Normal file
View file

@ -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)`

View file

@ -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