This commit is contained in:
Simon Vieille
commit
a8075a7bdc
GPG key ID:
579388D585F70417
4
.env
Normal file
4
.env
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
LIVE_RELOAD_SUPPORT=true
|
||||
ADD_MODULES=
|
||||
DOCS_DIRECTORY=/app
|
||||
FAST_MODE=false
|
||||
18
.woodpecker.yml
Normal file
18
.woodpecker.yml
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
pipeline:
|
||||
build:
|
||||
image: gitnet.fr/deblan/mkdocs
|
||||
commands:
|
||||
- mkdocs build
|
||||
|
||||
update:
|
||||
image: alpine/git
|
||||
commands:
|
||||
- git fetch --no-tags origin +refs/heads/pages
|
||||
- git switch pages
|
||||
- git config --global user.email ci@gitnet.fr
|
||||
- git config --global user.name CI
|
||||
- mv site /tmp/
|
||||
- rm * -fr
|
||||
- mv /tmp/site/* .
|
||||
- git add .
|
||||
- git commit -m "Build ${CI_BUILD_NUMBER}"
|
||||
8
Makefile
Normal file
8
Makefile
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
serve:
|
||||
docker run \
|
||||
-it --rm \
|
||||
-v $$(pwd):/app \
|
||||
--env-file ./.env \
|
||||
-p 8000:8000 \
|
||||
-w /app \
|
||||
gitnet.fr/deblan/mkdocs
|
||||
1
docs/_static/css/extra.css
vendored
Normal file
1
docs/_static/css/extra.css
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
|
||||
140
docs/_static/img/logo.svg
vendored
Normal file
140
docs/_static/img/logo.svg
vendored
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
width="57.044163mm"
|
||||
height="57.044163mm"
|
||||
viewBox="0 0 57.044163 57.044163"
|
||||
version="1.1"
|
||||
id="svg1433"
|
||||
inkscape:version="1.0.2 (e86c870879, 2021-01-15)"
|
||||
sodipodi:docname="logo.svg">
|
||||
<defs
|
||||
id="defs1427" />
|
||||
<sodipodi:namedview
|
||||
id="base"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1.0"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:zoom="1.979899"
|
||||
inkscape:cx="321.98969"
|
||||
inkscape:cy="157.98647"
|
||||
inkscape:document-units="mm"
|
||||
inkscape:current-layer="layer1"
|
||||
inkscape:document-rotation="0"
|
||||
showgrid="false"
|
||||
fit-margin-top="0"
|
||||
fit-margin-left="0"
|
||||
fit-margin-right="0"
|
||||
fit-margin-bottom="0"
|
||||
inkscape:window-width="1918"
|
||||
inkscape:window-height="1021"
|
||||
inkscape:window-x="0"
|
||||
inkscape:window-y="38"
|
||||
inkscape:window-maximized="1" />
|
||||
<metadata
|
||||
id="metadata1430">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title></dc:title>
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<g
|
||||
inkscape:label="Calque 1"
|
||||
inkscape:groupmode="layer"
|
||||
id="layer1"
|
||||
transform="translate(28.522081,-55.38863)">
|
||||
<rect
|
||||
inkscape:export-ydpi="39.689999"
|
||||
inkscape:export-xdpi="39.689999"
|
||||
y="56.07637"
|
||||
x="-27.834341"
|
||||
height="55.668682"
|
||||
width="55.668682"
|
||||
id="rect4634-3"
|
||||
style="color:#000000;display:inline;overflow:visible;visibility:visible;vector-effect:none;fill:#e7e7e9;fill-opacity:1;fill-rule:nonzero;stroke:#cacaca;stroke-width:1.37548;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:0.23561995;marker:none;enable-background:accumulate"
|
||||
rx="13.495078"
|
||||
ry="13.495078" />
|
||||
<g
|
||||
id="g1407"
|
||||
transform="matrix(2.0273259,0,0,2.0273259,-27.344561,-1105.4865)">
|
||||
<g
|
||||
transform="matrix(4.4401232,0,0,4.4401232,-808.26617,111.24909)"
|
||||
style="fill:#333333;stroke-width:0.36558"
|
||||
id="g6075-3-5-5-5">
|
||||
<rect
|
||||
style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#333333;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.0106793;marker:none;enable-background:accumulate"
|
||||
id="rect22527-2-9-55-1-9-8-6-6-6"
|
||||
width="1.1607833"
|
||||
height="1.1635288"
|
||||
x="183.11276"
|
||||
y="107.87968"
|
||||
rx="0.19624296"
|
||||
ry="0.1967071"
|
||||
inkscape:export-filename="/home/simon/obs/img/title.png"
|
||||
inkscape:export-xdpi="90"
|
||||
inkscape:export-ydpi="90" />
|
||||
<rect
|
||||
style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#333333;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.0106793;marker:none;enable-background:accumulate"
|
||||
id="rect22527-2-9-5-2-6-2-0-2-2-2"
|
||||
width="1.1607833"
|
||||
height="1.1635288"
|
||||
x="184.49425"
|
||||
y="107.87968"
|
||||
rx="0.19624296"
|
||||
ry="0.1967071"
|
||||
inkscape:export-filename="/home/simon/obs/img/title.png"
|
||||
inkscape:export-xdpi="90"
|
||||
inkscape:export-ydpi="90" />
|
||||
<rect
|
||||
style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#333333;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.0106793;marker:none;enable-background:accumulate"
|
||||
id="rect22527-2-9-9-8-7-2-4-9-9-9"
|
||||
width="1.1607833"
|
||||
height="1.1635288"
|
||||
x="185.87572"
|
||||
y="107.87968"
|
||||
rx="0.19624296"
|
||||
ry="0.1967071"
|
||||
inkscape:export-filename="/home/simon/obs/img/title.png"
|
||||
inkscape:export-xdpi="90"
|
||||
inkscape:export-ydpi="90" />
|
||||
<rect
|
||||
style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#333333;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.0106793;marker:none;enable-background:accumulate"
|
||||
id="rect22527-2-9-8-6-4-8-7-1-1-1"
|
||||
width="1.1607833"
|
||||
height="1.1635288"
|
||||
x="185.87572"
|
||||
y="106.49491"
|
||||
rx="0.19624296"
|
||||
ry="0.1967071"
|
||||
inkscape:export-filename="/home/simon/obs/img/title.png"
|
||||
inkscape:export-xdpi="90"
|
||||
inkscape:export-ydpi="90" />
|
||||
<rect
|
||||
style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#333333;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.0106793;marker:none;enable-background:accumulate"
|
||||
id="rect22527-2-7-7-9-68-27-2-2"
|
||||
width="1.1607833"
|
||||
height="1.1635288"
|
||||
x="184.49425"
|
||||
y="105.11017"
|
||||
rx="0.19624296"
|
||||
ry="0.1967071"
|
||||
inkscape:export-filename="/home/simon/obs/img/title.png"
|
||||
inkscape:export-xdpi="90"
|
||||
inkscape:export-ydpi="90" />
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 5.4 KiB |
24
docs/contrib.md
Normal file
24
docs/contrib.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
hide:
|
||||
- navigation
|
||||
- toc
|
||||
---
|
||||
|
||||
# How to contribute?
|
||||
|
||||
You can report a bug or request a feature by opening an issue: https://gitnet.fr/deblan/side_menu/issues
|
||||
|
||||
## You are a translator
|
||||
|
||||
Translations are managed from [translate.codeberg.org](https://translate.codeberg.org/projects/custom-menu/application/).
|
||||
|
||||
## You are a developer
|
||||
|
||||
* fork the repository
|
||||
* install an instance of Nextcloud
|
||||
* go to `apps/` and clone your repository
|
||||
* go to `apps/side_menu` and run `make dep`
|
||||
|
||||
Build javascripts using `make build` (or `make watch` to build them in real time).
|
||||
|
||||
Then commit and create a pull request.
|
||||
34
docs/index.md
Normal file
34
docs/index.md
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
hide:
|
||||
- navigation
|
||||
- toc
|
||||
---
|
||||
|
||||
🤙 Nextcloud app / Custom menu 🎨
|
||||
===============================
|
||||
|
||||
[](https://ci.gitnet.fr/deblan/side_menu)
|
||||
[](https://translate.codeberg.org/engage/custom-menu/)
|
||||
|
||||
Allows you to modify the position of the main menu by creating a panel on the left of the interface or with a big menu on the top.
|
||||
You can also add and sort custom categories, define apps that must be displayed in the top menu, etc. Fully customisable.
|
||||
|
||||
This application is rather suitable for instances that activate a lot of applications.
|
||||
|
||||
You can customize colors depending of the theme (Dark theme and Breeze Dark).
|
||||
|
||||
* [Installation and upgrade](#installation-and-upgrade)
|
||||
* [How to contribute?](#how-to-contribute)
|
||||
* [Support](#support)
|
||||
* [Screenshots](https://gitnet.fr/deblan/side_menu/src/branch/master/screenshots/)
|
||||
|
||||
You like this app and you want to support me? ☕ [Buy me a coffee](https://www.buymeacoffee.com/deblan) or [Donate with liberapay](https://liberapay.com/deblan)
|
||||
|
||||
## Support
|
||||
|
||||
You can join the official room on Matrix: [#custommenu:neutralnetwork.org](https://matrix.to/#/#custommenu:neutralnetwork.org).
|
||||
|
||||
## Notice
|
||||
|
||||
Because I believe in a free and decentralized Internet, [Gitnet](https://gitnet.fr) is **self-hosted at home**.
|
||||
In case of downtime, you can download **Custom Menu** from [here](https://kim.deblan.fr/~side_menu/
|
||||
19
docs/requirements.md
Normal file
19
docs/requirements.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
hide:
|
||||
- navigation
|
||||
- toc
|
||||
---
|
||||
|
||||
Requirements
|
||||
============
|
||||
|
||||
## Versions greater or equal than 3.0
|
||||
|
||||
* PHP >= 8.0
|
||||
* App `theming` enabled
|
||||
|
||||
## Version less than 3.0
|
||||
|
||||
* Nextcloud <= 24
|
||||
* PHP >= 7.1
|
||||
* App `theming` enabled
|
||||
58
docs/screenshots.md
Normal file
58
docs/screenshots.md
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
hide:
|
||||
- navigation
|
||||
- toc
|
||||
---
|
||||
|
||||
# Screenshots
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/n19_big_menu.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/n19_big_menu.png">
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc18_menu_always_displayed.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc18_menu_always_displayed.png">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc19_default_menu.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc19_default_menu.png">
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc20_big_menu_responsive.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc20_big_menu_responsive.png">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc25_big_menu.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc25_big_menu.png">
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc25_default_menu.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/nc25_default_menu.png">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/personal_settings.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/personal_settings.png">
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a target="_blank" href="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/admin_settings.png">
|
||||
<img src="https://gitnet.fr/deblan/side_menu/raw/branch/master/screenshots/admin_settings.png">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
1
docs/settings.md
Normal file
1
docs/settings.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Coming soon...
|
||||
36
docs/setup.md
Normal file
36
docs/setup.md
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
hide:
|
||||
- navigation
|
||||
- toc
|
||||
---
|
||||
|
||||
Installation and upgrade
|
||||
========================
|
||||
|
||||
Custom menu is available from the [app store](https://apps.nextcloud.com/apps/side_menu).
|
||||
|
||||
```bash
|
||||
cd /path/to/nextcloud
|
||||
php occ app:install side_menu
|
||||
```
|
||||
|
||||
If you want to install it from source, go to https://gitnet.fr/deblan/side_menu/releases and copy the link to the last release (side_menu_vX.Y.Z.tar.gz). Then:
|
||||
|
||||
```
|
||||
cd /path/to/nextcloud/apps
|
||||
curl -sS https://gitnet.fr/attachments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | tar xvfz -
|
||||
```
|
||||
|
||||
Administrators can edit many settings using the administration page.
|
||||
|
||||
Users can disable the menu using the page of personal settings.
|
||||
|
||||
### Use first top menu app as default app
|
||||
|
||||
You can easily let Custom Menu redirect to the first app in the top menu by changing the following parameter in your `config/config.php`:
|
||||
|
||||
```php-inline
|
||||
'defaultapp' => 'side_menu',
|
||||
```
|
||||
|
||||
If the top menu is empty then it redirects to files.
|
||||
46
mkdocs.yml
Normal file
46
mkdocs.yml
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
site_name: Custom menu
|
||||
|
||||
# extra_css:
|
||||
# - /_static/css/extra.css
|
||||
|
||||
plugins:
|
||||
- search
|
||||
|
||||
extra:
|
||||
generator: false
|
||||
|
||||
theme:
|
||||
name: material
|
||||
logo: /_static/img/logo.svg
|
||||
favicon: /_static/img/logo.svg
|
||||
features:
|
||||
- content.code.copy
|
||||
- navigation.tabs
|
||||
- navigation.footer
|
||||
palette:
|
||||
primary: "light blue"
|
||||
scheme: slate
|
||||
|
||||
markdown_extensions:
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
extend_pygments_lang:
|
||||
- name: php-inline
|
||||
lang: php
|
||||
options:
|
||||
startinline: true
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences
|
||||
- pymdownx.highlight
|
||||
- pymdownx.inlinehilite
|
||||
|
||||
nav:
|
||||
- Overview: index.md
|
||||
- Screenshots: screenshots.md
|
||||
- Requirements: requirements.md
|
||||
- Install and update: setup.md
|
||||
- Settings: settings.md
|
||||
- Contribute: contrib.md
|
||||
Loading…
Reference in a new issue