selfhosted
/
dashy
mirror of https://github.com/lissy93/dashy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
A self-hosted startpage for your server. Easy to use visual editor, status checking, widgets, themes and tons more!
418 Commits 20 Branches 47 Tags 593 MiB
Vue 71%
JavaScript 18.5%
SCSS 9%
HTML 1.2%
CSS 0.2%
Other 0.1%
Go to file
Alicia Sykes ce8f79ca4d 🚀 Adds link to new widgets docs in contents page 2022-01-23 00:30:32 +00:00
.github 👷 Update base path to be relative 2021-08-30 19:10:13 +01:00
docs 🔥 Updates all the documentation from master branch 2022-01-23 00:30:04 +00:00
src 🚀 Adds link to new widgets docs in contents page 2022-01-23 00:30:32 +00:00
static 🚀 Adds link to new widgets docs in contents page 2022-01-23 00:30:32 +00:00
.gitignore 🎉 Initialised Dashy Docs Website 2021-06-27 13:47:20 +01:00
babel.config.js 🎉 Initialised Dashy Docs Website 2021-06-27 13:47:20 +01:00
docusaurus.config.js 🌀 Fixes broken links 2021-11-13 19:52:14 +00:00
package.json 🌀 Fixes broken links 2021-11-13 19:52:14 +00:00
sidebars.js Updates sidebar and footer links 2021-08-29 18:42:57 +01:00
yarn.lock 🌀 Fixes broken links 2021-11-13 19:52:14 +00:00

docs/readme.md

Dashy Docs

Running Dashy

  • Quick Start - TDLR 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
  • 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