Skip to main content

FiveOrbs MkDocs Theme

This is a theme for MkDocs which is mainly used for the documentation of FiveOrbs projects

Installation

Install the package from PyPi using pip:

pip install mkdocs-fiveorbs

Add the theme to your mkdocs.yml file:

theme:
    name: fiveorbs

Development server

mkdocs serve -w theme   

Styles

Install Dart Sass via npm install -g sass. During develompment:

sass --watch styles:theme

Deploy to PyPi

Install uv if not already done. Bump version number in setup.py, then:

git tag -a X.X.X -m "Release Version X.X.X"
git push origin vX.X.X
sass --style=compressed --no-source-map styles:theme
uv build
uv publish --username <user> --token <token> # or uv-publish with .pypirc

Metadata

Release files for mkdocs-fiveorbs 0.1.14

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-fiveorbs 0.1.14
File Size Uploaded Provenance Actions
mkdocs_fiveorbs-0.1.14.tar.gz 105.1 kB Without provenance Details for mkdocs_fiveorbs-0.1.14.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-fiveorbs 0.1.14
File Interpreter ABI Platform Actions
mkdocs_fiveorbs-0.1.14-py3-none-any.whl Python 3 none any Details for mkdocs_fiveorbs-0.1.14-py3-none-any.whl

Total release size: 209.2 kB

Release files / mkdocs_fiveorbs-0.1.14.tar.gz

Download URL mkdocs_fiveorbs-0.1.14.tar.gz
Size 105.1 kB
Tags Source
SHA-256 checksum
How to use checksums
9c16c2a85efcb020bd4ba135f6616ec792f0d9355846f7fa68547fb0460941d5
BLAKE2b-256 checksum
How to use checksums
687bf959aeda90d2ca165bd120e43a7934cc0996cd1b63062ddb764589e4a616
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.0

Release files / mkdocs_fiveorbs-0.1.14-py3-none-any.whl

Download URL mkdocs_fiveorbs-0.1.14-py3-none-any.whl
Size 104.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c03678375155ea26e976b2ef23c9f82dc29ae51423553c025728eca8f19d487a
BLAKE2b-256 checksum
How to use checksums
8127db2265d02c7e97a24e0ec75d00eb400a619c2917b36a650e2e7b668a2e43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.0

Security for mkdocs-fiveorbs 0.1.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.14 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page