diff --git a/website/dist/docs/admin-panel/plugins/index.html b/website/dist/docs/admin-panel/plugins/index.html index f1e2ba0..ba7b686 100644 --- a/website/dist/docs/admin-panel/plugins/index.html +++ b/website/dist/docs/admin-panel/plugins/index.html @@ -20,7 +20,7 @@

Plugins

libreevent can be extended easily with plugins. Plugins add additional features and can be official or community made. When installing plugins, you need to remember that a server restart is required to activate the plugins as libreevent does not feature hot module loading (yet). You then can manage the plugins using their built-in settings page that they ship with.

Please only install plugins from sources you trust!

-

You may read on about plugins here and you can find an installation guide here.

+

You may read on about plugins and how to install them here.

diff --git a/website/dist/docs/contributing/packaging/index.html b/website/dist/docs/contributing/packaging/index.html index 9d82ebb..5e2b023 100644 --- a/website/dist/docs/contributing/packaging/index.html +++ b/website/dist/docs/contributing/packaging/index.html @@ -19,6 +19,10 @@

Packaging

libreevent has a very simple packaging script built in, it's called package.sh and can be run on any bash-compatible shell. This is another thing that should be improved: Add a batch script for the same purpose, it makes Windows user's life so much easier!

+

You can just run the script in a terminal by typing

+
./package.sh
+
+

when in the main directory (Linux and MacOS only, requires installed Node.js and npm).

Setting up the development environment

To be able to work on libreevent, you need to have node.js and npm installed on your computer.

Then, to set up the development environment, run

diff --git a/website/dist/docs/plugins/index.html b/website/dist/docs/plugins/index.html index bb2013d..23c059f 100644 --- a/website/dist/docs/plugins/index.html +++ b/website/dist/docs/plugins/index.html @@ -18,7 +18,15 @@

Plugins

-

libreevent features exensive plugin support, with all internal libreevent libraries also working together with plugins. This though poses a potential risk if the user is installing harmful plugins. This is why there is a curated list of secure plugins that the users might use.

+

libreevent features exensive plugin support, with all internal libreevent libraries also working together with plugins. This though poses a potential risk if the user is installing harmful plugins. This is why there is a curated list of secure plugins that the users might use here

+

Plugin installation

+

Installing plugins currently isn't easy. We expect you to know how to upload files to a server. If you don't know, a guide on how to upload things can be found in the setup guide which is meant for beginners

+

Acquiring the plugins

+

You can find a list of plugins that libreevent supports here. Choose one and click it to be directed to the download page.

+

Installing payment gateway plugins

+

You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to /backend/plugins/payments and uploading the plugin folder into there. Now, restart libreevent.

+

Installing other plugins

+

You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to /backend/plugins/others and uploading the plugin folder into there. Now, restart libreevent.

diff --git a/website/dist/docs/plugins/installation/index.html b/website/dist/docs/plugins/newsletter/index.html similarity index 53% rename from website/dist/docs/plugins/installation/index.html rename to website/dist/docs/plugins/newsletter/index.html index cba0345..84dc330 100644 --- a/website/dist/docs/plugins/installation/index.html +++ b/website/dist/docs/plugins/newsletter/index.html @@ -1,7 +1,7 @@ - Plugin installation :: docs - libreevent + Newsletter plugin :: docs - libreevent @@ -17,14 +17,8 @@
-

Plugin installation

-

Installing plugins currently isn't easy. We expect you to know how to upload files to a server. If you don't know, a guide on how to upload things can be found in the setup guide which is meant for beginners

-

Acquiring the plugins

-

You can find a list of plugins that libreevent supports here. Choose one and click it to be directed to the download page.

-

Installing payment gateway plugins

-

You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to /backend/plugins/payments and uploading the plugin folder into there. Now, restart libreevent.

-

Installing other plugins

-

You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to /backend/plugins/others and uploading the plugin folder into there. Now, restart libreevent.

+

Newsletter plugin

+

Use this plugin to keep people updated about what you do and drive up revenue by doing so. This plugin features a WYSIWYG (What you see is what you get) newsletter editor to create the newsletter.

diff --git a/website/dist/docs/plugins/polls/index.html b/website/dist/docs/plugins/polls/index.html new file mode 100644 index 0000000..26af224 --- /dev/null +++ b/website/dist/docs/plugins/polls/index.html @@ -0,0 +1,27 @@ + + + + Polls plugin :: docs - libreevent + + + + + + + + + + + + +
+
+
+

Polls plugin

+

The polls plugin allows you to ask users about their ideas for e.g. what DJ to hire or what drinks to order. They can make suggestions and vote on suggestions.

+
+
+ + + + \ No newline at end of file diff --git a/website/dist/docs/side-bar.html b/website/dist/docs/side-bar.html index 3b3996c..a748ad5 100644 --- a/website/dist/docs/side-bar.html +++ b/website/dist/docs/side-bar.html @@ -31,7 +31,8 @@ Plugins
Plugins -Plugin installation +Newsletter plugin +Polls plugin
Setup
diff --git a/website/dist/nav.html b/website/dist/nav.html index 0c75a83..7f978d0 100644 --- a/website/dist/nav.html +++ b/website/dist/nav.html @@ -17,6 +17,7 @@ Download About Start page templates + Plugins GitHub
diff --git a/website/dist/plugins/index.html b/website/dist/plugins/index.html new file mode 100644 index 0000000..5b40af1 --- /dev/null +++ b/website/dist/plugins/index.html @@ -0,0 +1,54 @@ + + + + + + + + + About :: libreǝvent + + + + +
+
+

Plugins for libreǝvent

+ +
+
+ Currently, libreevent has two plugins that come with it by default, newsletters and polls. + Here is a list of all available plugins: + +
+ + + + + + \ No newline at end of file diff --git a/website/dist/plugins/newsletter/index.html b/website/dist/plugins/newsletter/index.html new file mode 100644 index 0000000..0642c8d --- /dev/null +++ b/website/dist/plugins/newsletter/index.html @@ -0,0 +1,49 @@ + + + + + + + + + About :: libreǝvent + + + + +
+
+

Newsletter

+ +
+
+ Use this plugin to keep people updated about what you do and drive up revenue by doing so. This plugin features a WYSIWYG (What you see is what you get) newsletter editor to create the newsletter. +
+ + + + + + \ No newline at end of file diff --git a/website/dist/plugins/polls/index.html b/website/dist/plugins/polls/index.html new file mode 100644 index 0000000..3ecaa86 --- /dev/null +++ b/website/dist/plugins/polls/index.html @@ -0,0 +1,49 @@ + + + + + + + + + About :: libreǝvent + + + + +
+
+

Polls plugin

+ +
+
+ The polls plugin allows you to ask users about their ideas for e.g. what DJ to hire or what drinks to order. They can make suggestions and vote on suggestions. +
+ + + + + + \ No newline at end of file diff --git a/website/src/admin-panel/plugins.md b/website/src/admin-panel/plugins.md index 611c514..114b68d 100644 --- a/website/src/admin-panel/plugins.md +++ b/website/src/admin-panel/plugins.md @@ -4,4 +4,4 @@ libreevent can be extended easily with plugins. Plugins add additional features **Please only install plugins from sources you trust!** -You may read on about plugins [here](&/plugins/) and you can find an installation guide [here](&/plugins/installation). \ No newline at end of file +You may read on about plugins and how to install them [here](&/plugins/). \ No newline at end of file diff --git a/website/src/plugins.md b/website/src/plugins.md index b1e0142..71b9067 100644 --- a/website/src/plugins.md +++ b/website/src/plugins.md @@ -1,3 +1,16 @@ # Plugins -libreevent features exensive plugin support, with all internal libreevent libraries also working together with plugins. This though poses a potential risk if the user is installing harmful plugins. This is why there is a curated list of secure plugins that the users might use. \ No newline at end of file +libreevent features exensive plugin support, with all internal libreevent libraries also working together with plugins. This though poses a potential risk if the user is installing harmful plugins. This is why there is a curated list of secure plugins that the users might use [here](/plugins) + +# Plugin installation + +**Installing plugins currently isn't easy. We expect you to know how to upload files to a server. If you don't know, a guide on how to upload things can be found in the setup guide which is meant for beginners** + +## Acquiring the plugins +You can find a list of plugins that libreevent supports [here](/plugins). Choose one and click it to be directed to the download page. + +## Installing payment gateway plugins +You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to */backend/plugins/payments* and uploading the plugin folder into there. Now, restart libreevent. + +## Installing other plugins +You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to */backend/plugins/others* and uploading the plugin folder into there. Now, restart libreevent. \ No newline at end of file diff --git a/website/src/plugins/installation.md b/website/src/plugins/installation.md deleted file mode 100644 index 09d5cdc..0000000 --- a/website/src/plugins/installation.md +++ /dev/null @@ -1,12 +0,0 @@ -# Plugin installation - -**Installing plugins currently isn't easy. We expect you to know how to upload files to a server. If you don't know, a guide on how to upload things can be found in the setup guide which is meant for beginners** - -## Acquiring the plugins -You can find a list of plugins that libreevent supports [here](/plugins). Choose one and click it to be directed to the download page. - -## Installing payment gateway plugins -You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to */backend/plugins/payments* and uploading the plugin folder into there. Now, restart libreevent. - -## Installing other plugins -You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to */backend/plugins/others* and uploading the plugin folder into there. Now, restart libreevent. \ No newline at end of file diff --git a/website/src/plugins/newsletter.md b/website/src/plugins/newsletter.md new file mode 100644 index 0000000..bcbd0cf --- /dev/null +++ b/website/src/plugins/newsletter.md @@ -0,0 +1,3 @@ +# Newsletter plugin + +Use this plugin to keep people updated about what you do and drive up revenue by doing so. This plugin features a WYSIWYG (What you see is what you get) newsletter editor to create the newsletter. \ No newline at end of file diff --git a/website/src/plugins/polls.md b/website/src/plugins/polls.md new file mode 100644 index 0000000..5c4fee7 --- /dev/null +++ b/website/src/plugins/polls.md @@ -0,0 +1,3 @@ +# Polls plugin + +The polls plugin allows you to ask users about their ideas for e.g. what DJ to hire or what drinks to order. They can make suggestions and vote on suggestions. \ No newline at end of file