tyler.durden
/
dashy
mirror of https://github.com/Lissy93/dashy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dashy/docs
History
Alicia Bot 93c2c77f6b 💙 Updates contributor SVG 2024-05-05 02:27:14 +01:00
..
assets 💙 Updates contributor SVG 2024-05-05 02:27:14 +01:00
showcase Fix various typos 2022-08-23 11:22:47 +02:00
alternate-views.md 📝 corrected some typos in the docs 2023-08-20 14:22:23 +02:00
authentication.md 🛂 Adds option for env vars for passwords 2024-04-28 15:07:48 +01:00
backup-restore.md 📝 Update docs for V3 2024-04-16 17:00:22 +01:00
configuring.md 📝 Update docs for V3 2024-04-16 17:00:22 +01:00
contributing.md 📝 Small docs update 2024-03-06 21:58:54 +00:00
credits.md 💜 Updates contributors list 2024-05-05 02:27:09 +01:00
deployment.md 📝 Update port number in docs 2024-04-16 21:24:57 +01:00
developing.md 📝 Update port and directory in docs 2024-04-13 12:41:15 +01:00
development-guides.md 📝 Update port and directory in docs 2024-04-13 12:41:15 +01:00
icons.md 📝 Update docs for V3 2024-04-16 17:00:22 +01:00
management.md 📝 Update docs for V3 2024-04-16 17:00:22 +01:00
multi-language-support.md Update multi-language-support.md 2023-09-05 14:30:54 +02:00
pages-and-sections.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
privacy.md 📝 Update docs for V3 2024-04-16 17:00:22 +01:00
quick-start.md 📝 Clearer docs for user-data directory (#1538) 2024-04-21 21:39:14 +01:00
readme.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
release-workflow.md Fix various typos 2022-08-23 11:22:47 +02:00
searching.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
showcase.md 🖼️ Updated img to higher-def version 2024-03-06 22:32:33 +00:00
status-indicators.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
theming.md Fix various typos 2022-08-23 11:22:47 +02:00
troubleshooting.md 📝 Update port number in docs 2024-04-16 21:24:57 +01:00
widgets.md 📝 Update docs for V3 2024-04-16 17:00:22 +01:00

readme.md

Dashy Docs

Running Dashy

  • Quick Start - TLDR guide on getting Dashy up and running
  • Deployment - Full guide on deploying Dashy either locally or online
  • Configuring - Complete list of all available options in the config file
  • App Management - Managing your app, updating, security, web server configuration, etc
  • Troubleshooting - Common errors and problems, and how to fix them

Development and Contributing

  • Developing - Running Dashy development server locally, and general workflow
  • Development Guides - Common development tasks, to help new contributors
  • Contributing - How you can help keep Dashy alive
  • Showcase - See how others are using Dashy, and share your dashboard
  • Credits - List of people and projects that have made Dashy possible
  • Release Workflow - Info about releases, CI and automated tasks

Feature Docs

  • Authentication - Guide to setting up authentication to protect your dashboard
  • Alternate Views - Outline of available pages / views and item opening methods
  • Backup & Restore - Guide to backing up config with Dashy's cloud sync feature
  • Icons - Outline of all available icon types for sections and items, with examples
  • Language Switching - Details on how to switch language, or add a new locale
  • Pages and Sections - Multi-page support, sections, items and sub-items
  • Status Indicators - Using Dashy to monitor uptime and status of your apps
  • Searching & Shortcuts - Searching, launching methods + keyboard shortcuts
  • Theming - Complete guide to applying, writing and modifying themes + styles
  • Widgets - List of all dynamic content widgets, with usage guides and examples

Misc

  • Privacy & Security - List of requests, potential issues, and security resources
  • License - Copy of the MIT License
  • Legal - Licenses of direct dependencies
  • Code of Conduct - Contributor Covenant Code of Conduct
  • Changelog - Details of recent changes, and historical versions