mirror of
https://github.com/Artemis-RGB/Artemis
synced 2026-11-11 19:36:28 +00:00
Swap to a basic DocFX config that hopefully doesn't break every 10 minutes
This commit is contained in:
1 parent
158c380747
commit
654ea94e16
30 files changed
+32
-1979
No files matched your search
@@ -1,26 +1,11 @@
|
||||
---
|
||||
_layout: landing
|
||||
---
|
||||
|
||||
# Welcome to the **Artemis API documentation**
|
||||
On this website you can browse the Artemis Core and Shared UI API.
|
||||
A large part of this documentation is being generated based on code but over time the plan is to expand the documentation with written guides.
|
||||
# This is the **HOMEPAGE**.
|
||||
|
||||
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
|
||||
|
||||
## Plugins
|
||||
Artemis 2.0 has been developed from the ground up with plugins in mind. This means almost all functionality can be expanded. The following plugin types are currently available and fully implemented:
|
||||
- [DeviceProvider](api/Artemis.Core.DeviceProviders.DeviceProvider.html)
|
||||
- [LayerBrush\<T\>](api/Artemis.Core.LayerBrushes.LayerBrush-1.html)
|
||||
- [PerLedLayerBrush\<T\>](api/Artemis.Core.LayerBrushes.PerLedLayerBrush-1.html)
|
||||
- [LayerEffect](api/Artemis.Core.LayerEffects.LayerEffect-1.html)
|
||||
- [Module](api/Artemis.Core.Modules.Module.html)
|
||||
- [Module\<T\>](api/Artemis.Core.Modules.Module-1.html)
|
||||
|
||||
These allow you to expand on Artemis's functionality. For quick and interactive plugin creation, use the [Visual Studio template extension](https://marketplace.visualstudio.com/items?itemName=SpoinkyNL.ArtemisTemplates).
|
||||
|
||||
Example implementations of these plugins can be found on [GitHub](https://github.com/Artemis-RGB/Artemis/tree/master/src/Plugins).
|
||||
|
||||
## Services
|
||||
Artemis provides plugins with an API through a range of services.
|
||||
All the services are available to plugins by using dependency injection in your plugin's constructor. Dependency injection is also available for the different view models plugins may provide.
|
||||
|
||||
- [Core Services](api/Artemis.Core.Services.html#interfaces)
|
||||
- [UI Services](api/Artemis.UI.Shared.Services.html#interfaces)
|
||||
## Quick Start Notes:
|
||||
|
||||
1. Add images to the *images* folder if the file is referencing an image.
|
||||
Reference in new issue
Block a user