dashy/docs/readme.md
2021-08-25 23:13:14 +01:00

33 lines
2.2 KiB
Markdown

![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png)
### Running Dashy
- [Quick Start](/docs/quick-start) - TDLR guide on getting Dashy up and running
- [Deployment](/docs/deployment) - Full guide on deploying Dashy either locally or online
- [Configuring](/docs/configuring) - Complete list of all available options in the config file
- [App Management](/docs/management) - Managing your app, updating, security, web server configuration, etc
- [Troubleshooting](/docs/troubleshooting) - Common errors and problems, and how to fix them
### Development and Contributing
- [Developing](/docs/developing) - Running Dashy development server locally, and general workflow
- [Development Guides](/docs/development-guides) - Common development tasks, to help new contributors
- [Contributing](/docs/contributing) - How you can help keep Dashy alive
- [Showcase](/docs/showcase) - See how others are using Dashy, and share your dashboard
- [Credits](/docs/credits) - List of people and projects that have made Dashy possible
### Feature Docs
- [Authentication](/docs/authentication) - Guide to setting up authentication to protect your dashboard
- [Alternate Views](/docs/alternate-views) - Outline of available pages / views and item opening methods
- [Backup & Restore](/docs/backup-restore) - Guide to Dashy's cloud sync feature
- [Icons](/docs/icons) - Outline of all available icon types for sections and items
- [Language Switching](/docs/multi-language-support) - Details on how to switch language, or add a new locale
- [Status Indicators](/docs/status-indicators) - Using Dashy to monitor uptime and status of your apps
- [Searching & Shortcuts](/docs/searching) - Finding and launching your apps, and using keyboard shortcuts
- [Theming](/docs/theming) - Complete guide to applying, writing and modifying themes and styles
### Misc
- [Privacy & Security](/docs/privacy) - List of requests, potential issues, and security resources
- [License](/LICENSE) - Copy of the MIT License
- [Legal](/.github/LEGAL) - Licenses of direct dependencies
- [Code of Conduct](/.github/CODE_OF_CONDUCT) - Contributor Covenant Code of Conduct
- [Changelog](/.github/CHANGELOG) - Details of recent changes, and historical versions