Skip to content

dev: install & update zensical #8

@practicalli-johnny

Description

@practicalli-johnny

What is the simplest and most efficient way to install and update Zensical.

Zensical is a replacement for MkDocs and Material for MkDocs projects.

Zensical has created a rust language alternative to MkDocs, to overcome constraints they couldn't easily work around. This includes a redesign of the plugin mechanism.

Zensical install is still managed by a Python plugin manager, e.g. pip or uv.

Virtual environment

It is assumed that a Python virtual environment is the most effective approach for installation.

Should a venv be specific to each project or is it useful & more effective to have a shared venv when there are many zensical projects locally.

e.g. a shared venv location

~/.local/share/zensical/venv

NOTE: Practicalli Material for MkDocs projects all used the same shared venv without issue

Install Zensical

uv is described as a faster alternative to the pip Python package manager. uv also has a single command that covers many related tools.

Try uvx as a potentially simpler way to install zensical

uvx zensical new

Update Zensical

They way that seems to work with uv is to update the zensical dependency version in the pypython.toml config file and run zensical install

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

Status
No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions