From a8075a7bdc41c6ad32114569753d1b1964565a5c Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Sat, 11 Feb 2023 23:57:28 +0100 Subject: [PATCH] init --- .env | 4 ++ .woodpecker.yml | 18 +++++ Makefile | 8 +++ docs/_static/css/extra.css | 1 + docs/_static/img/logo.svg | 140 +++++++++++++++++++++++++++++++++++++ docs/contrib.md | 24 +++++++ docs/index.md | 34 +++++++++ docs/requirements.md | 19 +++++ docs/screenshots.md | 58 +++++++++++++++ docs/settings.md | 1 + docs/setup.md | 36 ++++++++++ mkdocs.yml | 46 ++++++++++++ 12 files changed, 389 insertions(+) create mode 100644 .env create mode 100644 .woodpecker.yml create mode 100644 Makefile create mode 100644 docs/_static/css/extra.css create mode 100644 docs/_static/img/logo.svg create mode 100644 docs/contrib.md create mode 100644 docs/index.md create mode 100644 docs/requirements.md create mode 100644 docs/screenshots.md create mode 100644 docs/settings.md create mode 100644 docs/setup.md create mode 100644 mkdocs.yml diff --git a/.env b/.env new file mode 100644 index 0000000..c56e56a --- /dev/null +++ b/.env @@ -0,0 +1,4 @@ +LIVE_RELOAD_SUPPORT=true +ADD_MODULES= +DOCS_DIRECTORY=/app +FAST_MODE=false diff --git a/.woodpecker.yml b/.woodpecker.yml new file mode 100644 index 0000000..b01b5c6 --- /dev/null +++ b/.woodpecker.yml @@ -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}" diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ff837c4 --- /dev/null +++ b/Makefile @@ -0,0 +1,8 @@ +serve: + docker run \ + -it --rm \ + -v $$(pwd):/app \ + --env-file ./.env \ + -p 8000:8000 \ + -w /app \ + gitnet.fr/deblan/mkdocs diff --git a/docs/_static/css/extra.css b/docs/_static/css/extra.css new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/docs/_static/css/extra.css @@ -0,0 +1 @@ + diff --git a/docs/_static/img/logo.svg b/docs/_static/img/logo.svg new file mode 100644 index 0000000..c2dd0f9 --- /dev/null +++ b/docs/_static/img/logo.svg @@ -0,0 +1,140 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + diff --git a/docs/contrib.md b/docs/contrib.md new file mode 100644 index 0000000..90c5925 --- /dev/null +++ b/docs/contrib.md @@ -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. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d522116 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,34 @@ +--- +hide: + - navigation + - toc +--- + +🤙 Nextcloud app / Custom menu 🎨 +=============================== + +[![Build Status](https://ci.gitnet.fr/api/badges/deblan/side_menu/status.svg)](https://ci.gitnet.fr/deblan/side_menu) +[![Translations](https://translate.codeberg.org/widgets/custom-menu/-/application/svg-badge.svg)](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/ diff --git a/docs/requirements.md b/docs/requirements.md new file mode 100644 index 0000000..5560c45 --- /dev/null +++ b/docs/requirements.md @@ -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 diff --git a/docs/screenshots.md b/docs/screenshots.md new file mode 100644 index 0000000..4f36116 --- /dev/null +++ b/docs/screenshots.md @@ -0,0 +1,58 @@ +--- +hide: + - navigation + - toc +--- + +# Screenshots + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + + +
+ + + + + + + +
+ + + + + + + +
diff --git a/docs/settings.md b/docs/settings.md new file mode 100644 index 0000000..ad55585 --- /dev/null +++ b/docs/settings.md @@ -0,0 +1 @@ +# Coming soon... diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 0000000..13c7b6a --- /dev/null +++ b/docs/setup.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..bd9fa57 --- /dev/null +++ b/mkdocs.yml @@ -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