diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml new file mode 100644 index 00000000..9c397394 --- /dev/null +++ b/.github/workflows/mkdocs.yml @@ -0,0 +1,20 @@ +name: Documentation + +on: + push: + branches: + - 'main' + +jobs: + mkdocs: + name: Build & Deploy Documentation + runs-on: ubuntu-22.04 + steps: + - name: Checkout + uses: actions/checkout@v4.1.1 + + - name: Deploy Documentation + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CONFIG_FILE: mkdocs.yml diff --git a/.gitignore b/.gitignore index 722e6f52..10030fff 100644 --- a/.gitignore +++ b/.gitignore @@ -31,8 +31,6 @@ translations/ /vendor/ ###< symfony/framework-bundle ### -hugo/public/ - ###> friends-of-behat/symfony-extension ### /behat.yml ###< friends-of-behat/symfony-extension ### diff --git a/.gitmodules b/.gitmodules index edbfd7c4..bb9d2461 100644 --- a/.gitmodules +++ b/.gitmodules @@ -13,9 +13,6 @@ [submodule "ansible/roles/systemli.dovecot"] path = ansible/roles/systemli.dovecot url = https://github.com/systemli/ansible-role-dovecot.git -[submodule "hugo/themes/docdock"] - path = hugo/themes/docdock - url = https://github.com/vjeantet/hugo-theme-docdock.git [submodule "ansible/roles/geerlingguy.php"] path = ansible/roles/geerlingguy.php url = https://github.com/geerlingguy/ansible-role-php.git diff --git a/README.md b/README.md index a691f05a..df7b9bc7 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Web application to (self-) manage e-mail users and encrypt their mailboxes. -![index](hugo/static/images/index.png) +![index](docs/assets/images/index.png) ## Features @@ -39,7 +39,7 @@ If you're looking for things to work on, take a look in the ["good first issues"](https://github.com/systemli/userli/labels/good%20first%20issue). There, you can also [report a bug or suggest an enhancement](https://github.com/systemli/userli/issues/new). -You could also [improve our documentation](https://github.com/systemli/userli/blob/main/hugo/content/_index.md) or [provide new +You could also [improve our documentation](https://github.com/systemli/userli/blob/main/docs/index.md) or [provide new translations](https://hosted.weblate.org/engage/userli/). If you want to do something else - it's totally fine. Any contribution is very welcome. diff --git a/docs b/docs deleted file mode 120000 index 4a18acc0..00000000 --- a/docs +++ /dev/null @@ -1 +0,0 @@ -hugo/content \ No newline at end of file diff --git a/hugo/static/images/account.png b/docs/assets/images/account.png similarity index 100% rename from hugo/static/images/account.png rename to docs/assets/images/account.png diff --git a/hugo/static/images/admin.png b/docs/assets/images/admin.png similarity index 100% rename from hugo/static/images/admin.png rename to docs/assets/images/admin.png diff --git a/hugo/static/images/alias.png b/docs/assets/images/alias.png similarity index 100% rename from hugo/static/images/alias.png rename to docs/assets/images/alias.png diff --git a/hugo/static/images/index.png b/docs/assets/images/index.png similarity index 100% rename from hugo/static/images/index.png rename to docs/assets/images/index.png diff --git a/hugo/static/images/manage_recovery_token.png b/docs/assets/images/manage_recovery_token.png similarity index 100% rename from hugo/static/images/manage_recovery_token.png rename to docs/assets/images/manage_recovery_token.png diff --git a/hugo/static/images/new_recovery_token.png b/docs/assets/images/new_recovery_token.png similarity index 100% rename from hugo/static/images/new_recovery_token.png rename to docs/assets/images/new_recovery_token.png diff --git a/hugo/static/images/recovery.png b/docs/assets/images/recovery.png similarity index 100% rename from hugo/static/images/recovery.png rename to docs/assets/images/recovery.png diff --git a/hugo/static/images/voucher.png b/docs/assets/images/voucher.png similarity index 100% rename from hugo/static/images/voucher.png rename to docs/assets/images/voucher.png diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 00000000..a7646c22 Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/hugo/content/development/code_of_conduct.md b/docs/development/code_of_conduct.md similarity index 97% rename from hugo/content/development/code_of_conduct.md rename to docs/development/code_of_conduct.md index 261bdec0..ba42997a 100644 --- a/hugo/content/development/code_of_conduct.md +++ b/docs/development/code_of_conduct.md @@ -1,8 +1,4 @@ -+++ -title = "Code of Conduct" -description = "Everyone welcome" -weight = 2 -+++ +# Code of Conduct ## Our Pledge diff --git a/hugo/content/development/coding_style.md b/docs/development/coding_style.md similarity index 62% rename from hugo/content/development/coding_style.md rename to docs/development/coding_style.md index 49704c65..c28607bf 100644 --- a/hugo/content/development/coding_style.md +++ b/docs/development/coding_style.md @@ -1,11 +1,6 @@ -+++ -title = "Coding style" -description = "" -weight = 4 -+++ +# Coding style We use the default Symfony coding style. - Check and adjust coding style by running `php-cs-fixer`: diff --git a/hugo/content/development/icons.md b/docs/development/icons.md similarity index 80% rename from hugo/content/development/icons.md rename to docs/development/icons.md index 06b6aabe..e9ebed76 100644 --- a/hugo/content/development/icons.md +++ b/docs/development/icons.md @@ -1,8 +1,4 @@ -+++ -title = "Icons" -description = "Where to get icons" -weight = 6 -+++ +# Icons We're using [Githubs Octicons v9](https://github.com/primer/octicons/releases/tag/v9.6.0) for icons on the index page. Icons from V10 onwards look a bit different and don't allign with earlier ones. diff --git a/hugo/content/development/_index.md b/docs/development/index.md similarity index 94% rename from hugo/content/development/_index.md rename to docs/development/index.md index ecfdc551..2edda810 100644 --- a/hugo/content/development/_index.md +++ b/docs/development/index.md @@ -1,9 +1,4 @@ -+++ -title = "Development" -description = "" -weight = 3 -alwaysopen = false -+++ +# Development ## Development with Vagrant diff --git a/hugo/content/development/release.md b/docs/development/release.md similarity index 87% rename from hugo/content/development/release.md rename to docs/development/release.md index 68bc000f..7e6ffa34 100644 --- a/hugo/content/development/release.md +++ b/docs/development/release.md @@ -1,8 +1,4 @@ -+++ -title = "Creating release tarballs" -description = "" -weight = 3 -+++ +# Creating release tarballs Release tarballs are the preferred way to install Userli. This page explains how to create them. diff --git a/hugo/content/development/tests.md b/docs/development/tests.md similarity index 79% rename from hugo/content/development/tests.md rename to docs/development/tests.md index ddc0d54f..b48ee0aa 100644 --- a/hugo/content/development/tests.md +++ b/docs/development/tests.md @@ -1,8 +1,4 @@ -+++ -title = "Tests" -description = "How to test during development" -weight = 5 -+++ +# Tests ## Linting, unit tests and functional tests diff --git a/hugo/content/getting-started/_index.md b/docs/getting-started/index.md similarity index 85% rename from hugo/content/getting-started/_index.md rename to docs/getting-started/index.md index f1db2aac..159a58e8 100644 --- a/hugo/content/getting-started/_index.md +++ b/docs/getting-started/index.md @@ -1,9 +1,4 @@ -+++ -title = "Getting Started" -description = "" -weight = 1 -alwaysopen = true -+++ +# Getting Started The easiest way to install Userli on a fresh Debian Buster is running these commands: @@ -23,7 +18,8 @@ This installs all dependencies, creates a database and database user It is accessible via [http://localhost:8080](http://localhost:8080). There, you can create the first domain and user for your instance. -{{% alert theme="danger" %}}Do not run this configuration in production.{{% /alert %}} +!!! warning + Do not run this configuration in production. Next, you would have to change the password of the database user, [configure your instance](../installation/configuration), diff --git a/hugo/content/_index.md b/docs/index.md similarity index 82% rename from hugo/content/_index.md rename to docs/index.md index 74888bf1..89478242 100644 --- a/hugo/content/_index.md +++ b/docs/index.md @@ -1,13 +1,8 @@ -+++ -title = "Userli Documentation" -description = "Web application to (self-) manage e-mail users and encrypt their mailboxes." -+++ - # Userli Web application to (self-) manage e-mail users and encrypt their mailboxes. -![index](./images/index.png) +![index](./assets/images/index.png) ## Features @@ -33,4 +28,4 @@ Userli supports a role system to help you run your mail server. ## Contribute -This is a start. Please help to [improve the documentation](https://github.com/systemli/userli/edit/main/hugo/content/_index.md). +This is a start. Please help to [improve the documentation](https://github.com/systemli/userli/edit/main/docsindex.md). diff --git a/hugo/content/installation/checkpassword.md b/docs/installation/checkpassword.md similarity index 94% rename from hugo/content/installation/checkpassword.md rename to docs/installation/checkpassword.md index af3f3cff..4297f69b 100644 --- a/hugo/content/installation/checkpassword.md +++ b/docs/installation/checkpassword.md @@ -1,8 +1,4 @@ -+++ -title = "Checkpassword" -description = "" -weight = 7 -+++ +# Checkpassword The PHP console command `bin/console app:users:checkpassword` provides a checkpassword command to be used for authentication (userdb and passdb diff --git a/hugo/content/installation/code.md b/docs/installation/code.md similarity index 82% rename from hugo/content/installation/code.md rename to docs/installation/code.md index e1126b79..08301394 100644 --- a/hugo/content/installation/code.md +++ b/docs/installation/code.md @@ -1,11 +1,7 @@ -+++ -title = "Get the code" -description = "" -weight = 2 -+++ +# Get the code Install the [latest release](https://github.com/systemli/userli/releases/latest). - + Download and unpack the actual source code. mkdir userli && cd userli diff --git a/hugo/content/installation/commands.md b/docs/installation/commands.md similarity index 93% rename from hugo/content/installation/commands.md rename to docs/installation/commands.md index 26028a85..2828b8be 100644 --- a/hugo/content/installation/commands.md +++ b/docs/installation/commands.md @@ -1,11 +1,7 @@ -+++ -title = "Commands" -description = "" -weight = 8 -+++ +# Commands This app brings custom commands: - + ``` app:munin:account # Return number of account to munin app:munin:alias # Return number of aliases to munin diff --git a/hugo/content/installation/configuration.md b/docs/installation/configuration.md similarity index 90% rename from hugo/content/installation/configuration.md rename to docs/installation/configuration.md index 490ba870..01bfa070 100644 --- a/hugo/content/installation/configuration.md +++ b/docs/installation/configuration.md @@ -1,8 +1,4 @@ -+++ -title = "Configuration" -description = "" -weight = 3 -+++ +# Configuration You can personalize your Userli instance by creating `.env.local`, which overrides some values from `.env`. You should at least configure diff --git a/hugo/content/installation/customize.md b/docs/installation/customize.md similarity index 79% rename from hugo/content/installation/customize.md rename to docs/installation/customize.md index 7789331c..bb3df605 100644 --- a/hugo/content/installation/customize.md +++ b/docs/installation/customize.md @@ -1,8 +1,4 @@ -+++ -title = "Customize" -description = "" -weight = 6 -+++ +# Customize You can override translation strings individually by putting them into override localization files at `translations//messages..yml`. diff --git a/hugo/content/installation/database.md b/docs/installation/database.md similarity index 83% rename from hugo/content/installation/database.md rename to docs/installation/database.md index bd9b145d..072ca533 100644 --- a/hugo/content/installation/database.md +++ b/docs/installation/database.md @@ -1,8 +1,4 @@ -+++ -title = "Create database" -description = "" -weight = 1 -+++ +# Create database Create Userli database and database user. diff --git a/hugo/content/installation/finalize.md b/docs/installation/finalize.md similarity index 94% rename from hugo/content/installation/finalize.md rename to docs/installation/finalize.md index 891aae9e..514ffec5 100644 --- a/hugo/content/installation/finalize.md +++ b/docs/installation/finalize.md @@ -1,11 +1,6 @@ -+++ -title = "Finalize the setup" -description = "" -weight = 4 -+++ +# Finalize the setup Last steps to make Userli work properly. - ## Create database scheme diff --git a/hugo/content/installation/_index.md b/docs/installation/index.md similarity index 78% rename from hugo/content/installation/_index.md rename to docs/installation/index.md index 506d897a..c7141b6b 100644 --- a/hugo/content/installation/_index.md +++ b/docs/installation/index.md @@ -1,8 +1,4 @@ -+++ -title = "Installation" -description = "" -weight = 2 -+++ +# Installation ## Requirements @@ -13,5 +9,3 @@ weight = 2 * [GnuPG](https://gnupg.org/) version 2.1.14 or newer You can also run this application with PostgreSQL oder SQLite. - -{{%children style="h2" description="true"%}} diff --git a/hugo/content/installation/webserver.md b/docs/installation/webserver.md similarity index 96% rename from hugo/content/installation/webserver.md rename to docs/installation/webserver.md index 445aa43d..082e30ea 100644 --- a/hugo/content/installation/webserver.md +++ b/docs/installation/webserver.md @@ -1,16 +1,11 @@ -+++ -title = "Webserver configuration" -description = "" -weight = 5 -+++ +# Webserver configuration Userli has to be installed like any other [Symfony application](https://symfony.com/doc/current/setup/web_server_configuration.html). - Below, you'll find some example configurations for webservers. Don't blindly copy them, but adjust them to your needs. -Caddy +## Caddy :8080 gzip @@ -21,7 +16,7 @@ Caddy to {path} /index.php?{query} } -Nginx +## Nginx server { listen 80; @@ -49,7 +44,7 @@ Nginx } } -Apache2 +## Apache2 diff --git a/hugo/content/mail_crypt/details.md b/docs/mail_crypt/details.md similarity index 78% rename from hugo/content/mail_crypt/details.md rename to docs/mail_crypt/details.md index b3401a46..3917a30f 100644 --- a/hugo/content/mail_crypt/details.md +++ b/docs/mail_crypt/details.md @@ -1,8 +1,4 @@ -+++ -title = "Implementation details" -description = "Cryptographic primitives" -weight = 2 -+++ +# Implementation details We use elliptic curve keys with curve secp521r1. The private key is encrypted with a libargon2i hash of the users' password, stored in a libsodium secret diff --git a/hugo/content/mail_crypt/_index.md b/docs/mail_crypt/index.md similarity index 94% rename from hugo/content/mail_crypt/_index.md rename to docs/mail_crypt/index.md index 4141d5b6..efc90caa 100644 --- a/hugo/content/mail_crypt/_index.md +++ b/docs/mail_crypt/index.md @@ -1,8 +1,4 @@ -+++ -title = "MailCrypt" -description = "" -weight = 4 -+++ +# MailCrypt The software has builtin support for [Dovecot's mailbox encryption](https://wiki.dovecot.org/Plugins/MailCrypt), using the @@ -38,5 +34,3 @@ MailCrypt can be turned on/off for individual users by setting the `mail_crypt` switch in the `virtual_users` database table. This switch is mainly meant to provide a migration path from legacy users without MailCrypt keys. On new setups, it's recommended to keep MailCrypt enabled for all users. - -{{%children style="h2" description="true"%}} diff --git a/hugo/content/mail_crypt/legacy.md b/docs/mail_crypt/legacy.md similarity index 97% rename from hugo/content/mail_crypt/legacy.md rename to docs/mail_crypt/legacy.md index 44dd4281..423b58ec 100644 --- a/hugo/content/mail_crypt/legacy.md +++ b/docs/mail_crypt/legacy.md @@ -1,8 +1,4 @@ -+++ -title = "Migrating legacy users" -description = "" -weight = 1 -+++ +# Migrating legacy users Legacy users (without MailCrypt keys) continue to work without mailbox encryption. If they generate a recovery token manually in the account settings, diff --git a/docs/screenshots/index.md b/docs/screenshots/index.md new file mode 100644 index 00000000..bcf929e2 --- /dev/null +++ b/docs/screenshots/index.md @@ -0,0 +1,42 @@ +# Screenshots + +Some screenshots of Userli features + +## Account management + +Change password and delete account + +![account](../assets/images/account.png) + + +## Admin Frontend + +Manage domains, users, aliases and more + +![admin](../assets/images/admin.png) + +## Invite friends + +Invite codes + +![voucher](../assets/images/voucher.png) + +## Alias addresses + +Manage alias addresses + +![alias](../assets/images/alias.png) + +## Recover lost password + +Manage recovery token + +![manage_recovery_token](../assets/images/manage_recovery_token.png) + +Add recovery token + +![new_recovery_token](../assets/images/new_recovery_token.png) + +Use recovery token + +![use_recovery_token](../assets/images/recovery.png) diff --git a/hugo/content/update/_index.md b/docs/update/index.md similarity index 87% rename from hugo/content/update/_index.md rename to docs/update/index.md index dd0c5833..f95a2afe 100644 --- a/hugo/content/update/_index.md +++ b/docs/update/index.md @@ -1,8 +1,4 @@ -+++ -title = "Update" -description = "" -alwaysopen = true -+++ +# Update When updating to a new userli version, please take a look at `UPGRADE.md` to see whether manual steps are required. diff --git a/hugo/content/wkd/_index.md b/docs/wkd/index.md similarity index 89% rename from hugo/content/wkd/_index.md rename to docs/wkd/index.md index 0ba116a5..e7dcd1f4 100644 --- a/hugo/content/wkd/_index.md +++ b/docs/wkd/index.md @@ -1,8 +1,4 @@ -+++ -title = "Web Key Directory" -description = "" -weight = 5 -+++ +# Web Key Directory Userli brings support for [OpenPGP Web Key Directory](https://gnupg.org/faq/wkd.html), a OpenPGP key discovery system. @@ -25,5 +21,3 @@ The WKD directory can be regenerated at any time by running the console command: bin/console app:wkd:export-keys - -{{%children style="h2" description="true"%}} diff --git a/hugo/archetypes/default.md b/hugo/archetypes/default.md deleted file mode 100644 index 00e77bd7..00000000 --- a/hugo/archetypes/default.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "{{ replace .Name "-" " " | title }}" -date: {{ .Date }} -draft: true ---- - diff --git a/hugo/config.toml b/hugo/config.toml deleted file mode 100644 index 890316d5..00000000 --- a/hugo/config.toml +++ /dev/null @@ -1,69 +0,0 @@ -#baseURL = "/userli" -# publishDir = "../docs" - -languageCode = "en-us" -DefaultContentLanguage = "en" -title = "Userli Documentation" -theme = "docdock" -# themesdir = "themes" -pygmentsCodeFences = true -pygmentsStyle = "monokailight" - -defaultContentLanguage = "en" -defaultContentLanguageInSubdir= false -enableMissingTranslationPlaceholders = false - - -# [Languages] -# [Languages.en] -# title = "Documentation for Hugo docDock" -# weight = 1 -# languageName = "English" -# -# [Languages.fr] -# title = "Documentation du thème docDock" -# weight = 2 -# languageName = "Français" - - - - -[params] -editURL = "https://github.com/systemli/userli/edit/master/hugo/content/" -showVisitedLinks = true # default is false -themeStyle = "original" # "original" or "flex" # default "flex" -themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default) -ordersectionsby = "weight" # ordersectionsby = "title" -disableHomeIcon = true # default is false -disableSearch = false # default is false -disableNavChevron = false # set true to hide next/prev chevron, default is false -highlightClientSide = false # set true to use highlight.pack.js instead of the default hugo chroma highlighter -menushortcutsnewtab = false # set true to open shortcuts links to a new tab/window -enableGitInfo = true - -[outputs] -home = [ "HTML", "RSS", "JSON"] - - -[[menu.shortcuts]] -pre = "

More

" -name = " " -identifier = "ds" -url = "https://github.com/systemli/userli/" -weight = 10 - -[[menu.shortcuts]] -name = " " -url = "https://github.com/systemli/userli/releases/latest" -weight = 11 - -# [[menu.shortcuts]] -# name = " " -# identifier = "hugodoc" -# url = "https://gohugo.io/" -# weight = 20 -# -# [[menu.shortcuts]] -# name = " " -# url = "/credits" -# weight = 30 diff --git a/hugo/content/development/documentation.md b/hugo/content/development/documentation.md deleted file mode 100644 index c66a2627..00000000 --- a/hugo/content/development/documentation.md +++ /dev/null @@ -1,46 +0,0 @@ -+++ -title = "Documentation" -description = "Built with Hugo and hosted on Github Pages" -weight = 1 -+++ - -This page describes how to edit the documentation you're currently reading. -The whole documentation is located in the directory `hugo`. Change into this directory. -All following commands are supposed to be run from here. - -``` -cd hugo -``` - -## Requirements - -Download [Hugo binary](https://gohugo.io/overview/installing/) for your OS (Windows, Linux, Mac). - -## Editing - -Change files in `hugo/content` to edit the documentation. -See the [DocDock documentation](https://docdock.netlify.com/original/content-organisation/) for more information on how to organize content. -Afterwards, commit your work to your repository. - -``` -git commit -a -``` - -## Testing - -Run `hugo` locally to see if your content looks like you imagined. - -``` -hugo server -``` -Open [http://localhost:1313/](http://localhost:1313/) in your local browser. - -## Publishing - -Run the following script to commit to the branch `gh-pages`. -From there, github auto-deploys the documentation. - -``` -./publish_docs.sh -``` -See [Hugo documentation](https://gohugo.io/hosting-and-deployment/hosting-on-github/#deployment-of-project-pages-from-your-gh-pages-branch) for more details. diff --git a/hugo/content/screenshots/_index.md b/hugo/content/screenshots/_index.md deleted file mode 100644 index 0f99c0d5..00000000 --- a/hugo/content/screenshots/_index.md +++ /dev/null @@ -1,9 +0,0 @@ -+++ -title = "Screenshots" -description = "" -+++ - -Some screenshots of Userli features - -{{% children style="h2" description="true" %}} - diff --git a/hugo/content/screenshots/account.md b/hugo/content/screenshots/account.md deleted file mode 100644 index a439e70e..00000000 --- a/hugo/content/screenshots/account.md +++ /dev/null @@ -1,7 +0,0 @@ -+++ -title = "Account management" -description = "Change password and delete account" -weight = 2 -+++ - -![account](../../images/account.png) diff --git a/hugo/content/screenshots/admin.md b/hugo/content/screenshots/admin.md deleted file mode 100644 index 588bfbbb..00000000 --- a/hugo/content/screenshots/admin.md +++ /dev/null @@ -1,10 +0,0 @@ -+++ -title = "Admin Frontend" -description = "" -weight = 4 -+++ - -Manage domains, users, aliases and more - - -![admin](../../images/admin.png) diff --git a/hugo/content/screenshots/alias.md b/hugo/content/screenshots/alias.md deleted file mode 100644 index aeecfad8..00000000 --- a/hugo/content/screenshots/alias.md +++ /dev/null @@ -1,7 +0,0 @@ -+++ -title = "Alias addresses" -description = "Manage alias addresses" -weight = 3 -+++ - -![alias](../../images/alias.png) diff --git a/hugo/content/screenshots/recovery.md b/hugo/content/screenshots/recovery.md deleted file mode 100644 index f2d7a920..00000000 --- a/hugo/content/screenshots/recovery.md +++ /dev/null @@ -1,18 +0,0 @@ -+++ -title = "Recover lost password" -description = "" -weight = 1 -+++ - -Manage recovery token - - -![manage_recovery_token](../../images/manage_recovery_token.png) - -Add recovery token - -![new_recovery_token](../../images/new_recovery_token.png) - -Use recovery token - -![use_recovery_token](../../images/recovery.png) diff --git a/hugo/content/screenshots/voucher.md b/hugo/content/screenshots/voucher.md deleted file mode 100644 index 362bbde0..00000000 --- a/hugo/content/screenshots/voucher.md +++ /dev/null @@ -1,7 +0,0 @@ -+++ -title = "Invite friends" -description = "Invite codes" -weight = 4 -+++ - -![voucher](../../images/voucher.png) diff --git a/hugo/publish_docs.sh b/hugo/publish_docs.sh deleted file mode 100755 index 80a862e3..00000000 --- a/hugo/publish_docs.sh +++ /dev/null @@ -1,29 +0,0 @@ -#!/bin/sh - -DIR=$(dirname "$0") - -cd $DIR/ - -if [ $(git status -s) ] -then - echo "The working directory is dirty. Please commit any pending changes." - exit 1; -fi - -echo "Deleting old publication" -rm -rf public -mkdir public -git worktree prune -rm -rf .git/worktrees/public/ - -echo "Checking out gh-pages branch into public" -git worktree add -B gh-pages public origin/gh-pages - -echo "Removing existing files" -rm -rf public/* - -echo "Generating site" -hugo -b "/userli" - -echo "Updating gh-pages branch" -cd public && git add --all && git commit -m "Publishing to gh-pages" && git push diff --git a/hugo/themes/docdock b/hugo/themes/docdock deleted file mode 160000 index d15e520b..00000000 --- a/hugo/themes/docdock +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d15e520b5d86757a78b6d1c4bdf551d117695ce0 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..60279de3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,53 @@ +--- +site_name: Userli +site_author: Systemli +repo_url: https://github.com/systemli/userli + +nav: + - Home: index.md + - Development: + - Development: development/index.md + - "Code of Conduct": development/code_of_conduct.md + - Icons: development/icons.md + - Release: development/release.md + - Tests: development/tests.md + - "Getting started": getting-started/index.md + - Installation: + - Installation: installation/index.md + - Checkpassword: installation/checkpassword.md + - Commands: installation/commands.md + - Configuration: installation/configuration.md + - Customize: installation/customize.md + - Database: installation/database.md + - Finalize: installation/finalize.md + - Webserver: installation/webserver.md + - MailCrypt: + - MailCrypt: mail_crypt/index.md + - Details: mail_crypt/details.md + - Legacy: mail_crypt/legacy.md + - Screenshots: screenshots/index.md + - Update: update/index.md + - "Web Key Directory": wkd/index.md + +theme: + name: material + features: + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + logo: assets/logo.png + favicon: assets/logo.png + palette: + primary: "blue" + accent: "blue" + +extra: + generator: false + social: + - icon: fontawesome/solid/globe + link: https://www.systemli.org + - icon: fontawesome/brands/github + link: https://github.com/systemli + +markdown_extensions: + - admonition