Lissy93/dashy
1
1
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2024-12-29 20:11:53 +03:00
Code Issues Packages Projects Releases Wiki Activity
8ca21edd22
dashy/docs
History
repo-visualizer 8ca21edd22 💛 Updates repo diagram
2023-04-23 01:30:04 +00:00
..
assets 💛 Updates repo diagram 2023-04-23 01:30:04 +00:00
showcase Fix various typos 2022-08-23 11:22:47 +02:00
alternate-views.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
authentication.md 📝 Add documentation for 'appConfig.auth.keycloak.idpHint' option. 2023-02-09 13:40:31 +00:00
backup-restore.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
configuring.md 📝 Fixes incorrect value, for enableServiceWorker 2023-03-01 16:40:42 +00:00
contributing.md Fix various typos 2022-08-23 11:22:47 +02:00
credits.md 💜 Updates contributors list 2023-04-23 02:28:23 +01:00
deployment.md Update new pricing policy of Heroku 2022-11-27 12:27:07 +01:00
developing.md Fix various typos 2022-08-23 11:22:47 +02:00
development-guides.md Fix various typos 2022-08-23 11:22:47 +02:00
icons.md 📝 Updates hyperlink to dashboard-icons 2022-11-27 16:04:45 +00:00
management.md Fix missed bolding 2022-08-23 11:42:19 +02:00
multi-language-support.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
pages-and-sections.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
privacy.md Fix various typos 2022-08-23 11:22:47 +02:00
quick-start.md Fix various typos 2022-08-23 11:22:47 +02: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 Fix various typos 2022-08-23 11:22:47 +02: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 Fix various typos 2022-08-23 11:22:47 +02:00
widgets.md Added documentation 2023-02-14 19:05:24 +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