selfhosted
/
dashy
mirror of https://github.com/lissy93/dashy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
dashy/docs/readme.md

40 lines
2.6 KiB
Markdown
Raw Permalink Normal View History

Fix inconsistent markdown formatting. This changes all of the documentation markdown files to follow the same rules. The rules I've applied are from https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md The reason I felt it was necessary to change all the files was that there were a lot inconsistencies in how the markdown was used. Ranging from header levels to some headers having a new line before content and some not.
2022-08-23 07:57:02 +00:00
# ![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png)
## Running Dashy
Added index and updated docws
2021-06-07 15:00:24 +00:00
Update readme.md it ain't much, but it's honest work ;)
2022-06-19 17:38:17 +00:00
- [Quick Start](/docs/quick-start.md) - TLDR guide on getting Dashy up and running
:memo: Adds alternate views page to docs
2021-08-21 16:17:02 +00:00
- [Deployment](/docs/deployment.md) - Full guide on deploying Dashy either locally or online
:memo: New contents page for docs
2021-07-25 14:01:27 +00:00
- [Configuring](/docs/configuring.md) - Complete list of all available options in the config file
:arrow_heading_up: Rebased from develop
2021-07-30 18:54:41 +00:00
- [App Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc
:memo: New contents page for docs
2021-07-25 14:01:27 +00:00
- [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them
Fix inconsistent markdown formatting. This changes all of the documentation markdown files to follow the same rules. The rules I've applied are from https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md The reason I felt it was necessary to change all the files was that there were a lot inconsistencies in how the markdown was used. Ranging from header levels to some headers having a new line before content and some not.
2022-08-23 07:57:02 +00:00
## Development and Contributing
:memo: New contents page for docs
2021-07-25 14:01:27 +00:00
- [Developing](/docs/developing.md) - Running Dashy development server locally, and general workflow
- [Development Guides](/docs/development-guides.md) - Common development tasks, to help new contributors
:arrow_heading_up: Rebased from develop
2021-07-30 18:54:41 +00:00
- [Contributing](/docs/contributing.md) - How you can help keep Dashy alive
:memo: New contents page for docs
2021-07-25 14:01:27 +00:00
- [Showcase](/docs/showcase.md) - See how others are using Dashy, and share your dashboard
:arrow_heading_up: Rebased from develop
2021-07-30 18:54:41 +00:00
- [Credits](/docs/credits.md) - List of people and projects that have made Dashy possible
:memo: Updates documentation, includes release schedule
2021-09-12 16:08:57 +00:00
- [Release Workflow](/docs/release-workflow.md) - Info about releases, CI and automated tasks
:memo: New contents page for docs
2021-07-25 14:01:27 +00:00
Fix inconsistent markdown formatting. This changes all of the documentation markdown files to follow the same rules. The rules I've applied are from https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md The reason I felt it was necessary to change all the files was that there were a lot inconsistencies in how the markdown was used. Ranging from header levels to some headers having a new line before content and some not.
2022-08-23 07:57:02 +00:00
## Feature Docs
:memo: Adds Internationalization to contents
2021-07-29 17:01:32 +00:00
- [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard
:memo: Adds alternate views page to docs
2021-08-21 16:17:02 +00:00
- [Alternate Views](/docs/alternate-views.md) - Outline of available pages / views and item opening methods
:memo: Adds link to Widgets docs in contents page
2021-12-20 16:15:38 +00:00
- [Backup & Restore](/docs/backup-restore.md) - Guide to backing up config with Dashy's cloud sync feature
- [Icons](/docs/icons.md) - Outline of all available icon types for sections and items, with examples
:memo: Adds alternate views page to docs
2021-08-21 16:17:02 +00:00
- [Language Switching](/docs/multi-language-support.md) - Details on how to switch language, or add a new locale
:memo: Starts writing multi-page docs
2022-04-26 21:27:02 +00:00
- [Pages and Sections](/docs/pages-and-sections.md) - Multi-page support, sections, items and sub-items
:arrow_heading_up: Rebased from develop
2021-07-30 18:54:41 +00:00
- [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps
:memo: Adds link to Widgets docs in contents page
2021-12-20 16:15:38 +00:00
- [Searching & Shortcuts](/docs/searching.md) - Searching, launching methods + keyboard shortcuts
- [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes + styles
- [Widgets](/docs/widgets.md) - List of all dynamic content widgets, with usage guides and examples
:memo: Adds Privacy and Security docs
2021-08-01 12:19:49 +00:00
Fix inconsistent markdown formatting. This changes all of the documentation markdown files to follow the same rules. The rules I've applied are from https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md The reason I felt it was necessary to change all the files was that there were a lot inconsistencies in how the markdown was used. Ranging from header levels to some headers having a new line before content and some not.
2022-08-23 07:57:02 +00:00
## Misc
:memo: Adds Privacy and Security docs
2021-08-01 12:19:49 +00:00
- [Privacy & Security](/docs/privacy.md) - List of requests, potential issues, and security resources
- [License](/LICENSE) - Copy of the MIT License
- [Legal](/.github/LEGAL.md) - Licenses of direct dependencies
- [Code of Conduct](/.github/CODE_OF_CONDUCT.md) - Contributor Covenant Code of Conduct
- [Changelog](/.github/CHANGELOG.md) - Details of recent changes, and historical versions