dashy/assets/js/52e2a80b.e50bbeab.js

"use strict";(self.webpackChunkdashy=self.webpackChunkdashy||[]).push([[12],{3905:function(e,t,n){n.d(t,{Zo:function(){return c},kt:function(){return m}});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),u=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=u(e.components);return a.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=u(n),m=r,h=d["".concat(s,".").concat(m)]||d[m]||p[m]||i;return n?a.createElement(h,o(o({ref:t},c),{},{components:n})):a.createElement(h,o({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,o[1]=l;for(var u=2;u<i;u++)o[u]=n[u];return a.createElement.apply(null,o)}return a.createElement.apply(null,n)}d.displayName="MDXCreateElement"},9288:function(e,t,n){n.r(t),n.d(t,{frontMatter:function(){return l},contentTitle:function(){return s},metadata:function(){return u},toc:function(){return c},default:function(){return d}});var a=n(7462),r=n(3366),i=(n(7294),n(3905)),o=["components"],l={},s=void 0,u={unversionedId:"readme",id:"readme",isDocsHomePage:!1,title:"readme",description:"Dashy Docs",source:"@site/docs/readme.md",sourceDirName:".",slug:"/readme",permalink:"/docs/readme",editUrl:"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/readme.md",version:"current",frontMatter:{}},c=[{value:"Running Dashy",id:"running-dashy",children:[]},{value:"Development and Contributing",id:"development-and-contributing",children:[]},{value:"Feature Docs",id:"feature-docs",children:[]},{value:"Misc",id:"misc",children:[]}],p={toc:c};function d(e){var t=e.components,n=(0,r.Z)(e,o);return(0,i.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.ibb.co/4mdNf7M/heading-docs.png",alt:"Dashy Docs"})),(0,i.kt)("h3",{id:"running-dashy"},"Running Dashy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/quick-start"},"Quick Start")," - TDLR guide on getting Dashy up and running"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/deployment"},"Deployment")," - Full guide on deploying Dashy either locally or online"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/configuring"},"Configuring")," - Complete list of all available options in the config file"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/management"},"App Management")," - Managing your app, updating, security, web server configuration, etc"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/troubleshooting"},"Troubleshooting")," - Common errors and problems, and how to fix them")),(0,i.kt)("h3",{id:"development-and-contributing"},"Development and Contributing"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/developing"},"Developing")," - Running Dashy development server locally, and general workflow"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/development-guides"},"Development Guides")," - Common development tasks, to help new contributors"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/contributing"},"Contributing")," - How you can help keep Dashy alive"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/showcase"},"Showcase")," - See how others are using Dashy, and share your dashboard"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/credits"},"Credits")," - List of people and projects that have made Dashy possible"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/release-workflow"},"Release Workflow")," - Info about releases, CI and automated tasks")),(0,i.kt)("h3",{id:"feature-docs"},"Feature Docs"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/authentication"},"Authentication")," - Guide to setting up authentication to protect your dashboard"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/alternate-views"},"Alternate Views")," - Outline of available pages / views and item opening methods"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/backup-restore"},"Backup & Restore")," - Guide to backing up config with Dashy's cloud sync feature"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/icons"},"Icons")," - Outline of all available icon types for sections and items, with examples"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/multi-language-support"},"Language Switching")," - Details on how to switch language, or add a new locale"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/status-indicators"},"Status Indicators")," - Using Dashy to monitor uptime and status of your apps"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/searching"},"Searching  & Shortcuts")," - Searching, launching methods + keyboard shortcuts"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/theming"},"Theming")," - Complete guide to applying, writing and modifying themes + styles"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/widgets"},"Widgets")," - List of all dynamic content widgets, with usage guides and examples")),(0,i.kt)("h3",{id:"misc"},"Misc"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/privacy"},"Privacy & Security")," - List of requests, potential issues, and security resources"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/LICENSE"},"License")," - Copy of the MIT License"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/.github/LEGAL"},"Legal")," - Licenses of direct dependencies"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/.github/CODE_OF_CONDUCT"},"Code of Conduct")," - Contributor Covenant Code of Conduct"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/.github/CHANGELOG"},"Changelog")," - Details of recent changes, and historical versions")))}d.isMDXComponent=!0}}]);