janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2025-11-25 05:14:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

add more docs

Browse Source
This commit is contained in:
Janis Hutz
2023-10-12 15:28:34 +02:00
parent 71a6cc6de3
commit debe7b8147
15 changed files with 220 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/dist/docs/admin-panel/plugins/index.html vendored
View File

@@ -20,7 +20,7 @@
<h1>Plugins</h1>
<p>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.</p>
<p><strong>Please only install plugins from sources you trust!</strong></p>
<p>You may read on about plugins <a href="/docs/plugins/">here</a> and you can find an installation guide <a href="/docs/plugins/installation">here</a>.</p>
<p>You may read on about plugins and how to install them <a href="/docs/plugins/">here</a>.</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>

4
website/dist/docs/contributing/packaging/index.html vendored
View File

@@ -19,6 +19,10 @@
<div id="doc-container">
<h1>Packaging</h1>
<p>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!</p>
<p>You can just run the script in a terminal by typing</p>
<pre><code>./package.sh
</code></pre>
<p>when in the main directory (Linux and MacOS only, requires installed Node.js and npm).</p>
<h1>Setting up the development environment</h1>
<p>To be able to work on libreevent, you need to have node.js and npm installed on your computer.</p>
<p>Then, to set up the development environment, run</p>

10
website/dist/docs/plugins/index.html vendored
View File

@@ -18,7 +18,15 @@
<div id="docPage">
<div id="doc-container">
<h1>Plugins</h1>
<p>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.</p>
<p>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 <a href="/plugins">here</a></p>
<h1>Plugin installation</h1>
<p><strong>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</strong></p>
<h2>Acquiring the plugins</h2>
<p>You can find a list of plugins that libreevent supports <a href="/plugins">here</a>. Choose one and click it to be directed to the download page.</p>
<h2>Installing payment gateway plugins</h2>
<p>You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to <em>/backend/plugins/payments</em> and uploading the plugin folder into there. Now, restart libreevent.</p>
<h2>Installing other plugins</h2>
<p>You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to <em>/backend/plugins/others</em> and uploading the plugin folder into there. Now, restart libreevent.</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>

12
website/dist/docs/plugins/installation/index.html → website/dist/docs/plugins/newsletter/index.html vendored
View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Plugin installation :: docs - libreevent</title>
<title>Newsletter plugin :: docs - libreevent</title>
<link rel="stylesheet" href="/docs/css/style.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
@@ -17,14 +17,8 @@
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Plugin installation</h1>
<p><strong>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</strong></p>
<h2>Acquiring the plugins</h2>
<p>You can find a list of plugins that libreevent supports <a href="/plugins">here</a>. Choose one and click it to be directed to the download page.</p>
<h2>Installing payment gateway plugins</h2>
<p>You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to <em>/backend/plugins/payments</em> and uploading the plugin folder into there. Now, restart libreevent.</p>
<h2>Installing other plugins</h2>
<p>You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to <em>/backend/plugins/others</em> and uploading the plugin folder into there. Now, restart libreevent.</p>
<h1>Newsletter plugin</h1>
<p>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.</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>

27
website/dist/docs/plugins/polls/index.html vendored Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Polls plugin :: docs - libreevent</title>
<link rel="stylesheet" href="/docs/css/style.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? libreevent is a project that does exactly that.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Polls plugin</h1>
<p>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.</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
</body>
</html>

3
website/dist/docs/side-bar.html vendored
View File

@@ -31,7 +31,8 @@
<a class="side-nav-item" id="pluginsNav" onclick="toggleList( 'plugins' );">Plugins</a>
<div class="side-dropdown" id="plugins-dropdown">
<a class="side-nav-subitem" id="plugins" href="/docs/plugins">Plugins</a>
<a class="side-nav-subitem" id="plugins-installation" href="/docs/plugins/installation">Plugin installation</a>
<a class="side-nav-subitem" id="plugins-newsletter" href="/docs/plugins/newsletter">Newsletter plugin</a>
<a class="side-nav-subitem" id="plugins-polls" href="/docs/plugins/polls">Polls plugin</a>
</div>
<a class="side-nav-item" id="setupNav" onclick="toggleList( 'setup' );">Setup</a>
<div class="side-dropdown" id="setup-dropdown">