Skip to content

Installation

pacman and PKGBUILDs

sudo pacman -S mkdocs mkdocs-material python-pymdown-extensions
paru -S mkdocs-gen-files
lftp -c "mirror --parallel=100 https://configs.vectorspace.xyz/mkdocs"
cd mkdocs
paru -Bi ./python-mkdocs-awesome-nav
paru -Bi ./python-mkdocs-minify
paru -Bi ./python-paginate
python-paginate PKGBUILD
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
pkgname=python-paginate
pkgver=0.1
pkgrel=1
pkgdesc='This module helps dividing large lists of items into pages. '
arch=('any')
url='https://github.com/Pylons/paginate'
license=('MIT')
depends=('python' 'python-click')
makedepends=('python-setuptools-scm' 'python-wheel' 'python-installer' 'python-build')
source=("${pkgname}.zip"::"https://github.com/Pylons/paginate/archive/refs/heads/master.zip")
sha256sums=('SKIP')

build() {
  cd "paginate-master"
  python -m build --wheel --no-isolation
}

package() {
  cd "paginate-master"
  python -m installer --destdir="$pkgdir" dist/*.whl
  install -Dvm644 'README.md' -t "${pkgdir}/usr/share/doc/${pkgname}"
  install -Dvm644 'LICENSE' -t "${pkgdir}/usr/share/licenses/${pkgname}"
}
mkdocs-awesome-nav PKGBUILD
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Maintainer: Sreejith <vector@vectorspace.xyz>
pkgname=mkdocs-awesome-nav
pkgver=0.1
pkgrel=1
pkgdesc='An MkDocs plugin that simplifies configuring page titles and their order'
arch=('any')
url='https://github.com/lukasgeiter/mkdocs-awesome-nav'
license=('MIT')
depends=('python' 'mkdocs' 'python-wcmatch' 'python-natsort' 'python-pydantic')
makedepends=('python-flit-core' 'python-build')
source=("${pkgname}.zip"::"https://github.com/lukasgeiter/mkdocs-awesome-nav/archive/refs/heads/main.zip")
sha256sums=('SKIP')

build() {
  cd "mkdocs-awesome-nav-main"
  python -m build --wheel --no-isolation
}

package() {
  cd "mkdocs-awesome-nav-main"
  python -m installer --destdir="$pkgdir" dist/*.whl
  install -Dvm644 'README.md' -t "${pkgdir}/usr/share/doc/${pkgname}"
  install -Dvm644 'LICENSE.md' -t "${pkgdir}/usr/share/licenses/${pkgname}"
}
mkdocs-minify PKGBUILD
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
pkgname=python-mkdocs-minify-plugin
pkgver=0.1
pkgrel=1
pkgdesc='An MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk.'
arch=('any')
url='https://github.com/byrnereese/mkdocs-minify-plugin'
license=('MIT')
depends=('python' 'mkdocs' 'python-htmlmin2' 'python-csscompressor' 'python-jsmin')
makedepends=('python-setuptools-scm' 'python-wheel' 'python-installer' 'python-build')
source=("${pkgname}.zip"::"https://github.com/byrnereese/mkdocs-minify-plugin/archive/refs/heads/main.zip")
sha256sums=('SKIP')

build() {
  cd "mkdocs-minify-plugin-main"
  python -m build --wheel --no-isolation
}

package() {
  cd "mkdocs-minify-plugin-main"
  python -m installer --destdir="$pkgdir" dist/*.whl
  install -Dvm644 'README.md' -t "${pkgdir}/usr/share/doc/${pkgname}"
  install -Dvm644 'LICENSE' -t "${pkgdir}/usr/share/licenses/${pkgname}"
}

systemd service

~/.config/systemd/user/mkdocs.service
1
2
3
4
5
6
7
8
9
[Unit]
Description=Start the mkdocs server

[Service]
WorkingDirectory=%h/vectorspace.xyz
ExecStart=mkdocs serve

[Install]
WantedBy=default.target

Note

It is %h/vectorspace.xyz because its the root of my mkdocs site.

systemctl --user daemon-reload
systemctl --user start mkdocs.service
systemctl --user enable mkdocs.service

Comments