dashy/assets/js/52e2a80b.682983ab.js

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