Skip to main content

doubleSlash Theme for MkDocs

Project description

mkdocs-doubleslash-theme

A MkDocs plugin that applies doubleSlash style to your documentation.

Quick Start

  1. Install the plugin via pip:
pip install mkdocs-doubleslash-theme
  1. Add the plugin to your mkdocs.yml and enable the mkdocs-material theme:
theme: material

plugins:
  - search
  - mkdocs-doubleslash-theme
  1. Thats it! The doubleSlash theme is now applied to your documentation.

Documentation

For detailed instructions and a demo, please read the documentation.

Development

Local setup

Run ./local-preview in your terminal to build and run a MkDocs server with the plugin installed, serving on http://127.0.0.1:8000/.

Releasing

Manually trigger the release workflow via GitHub Actions, which will auto-bump the plugin version and perform the release process. PyPi publishing is set up via trusted publishing.

License

mkdocs-doubleslash-theme is licensed under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_doubleslash_theme-1.2.1.tar.gz (316.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_doubleslash_theme-1.2.1-py3-none-any.whl (317.0 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_doubleslash_theme-1.2.1.tar.gz.

File metadata

  • Download URL: mkdocs_doubleslash_theme-1.2.1.tar.gz
  • Upload date:
  • Size: 316.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mkdocs_doubleslash_theme-1.2.1.tar.gz
Algorithm Hash digest
SHA256 5e16bcb18e0e66df05315ca4f0b8e93a4a03fb0689b0422544321f2f0ab0a08e
MD5 73c7a30ab3f1aaf58f55b91b89592b26
BLAKE2b-256 2606b085b88c6bfaf35cd10a9df6fc55bb48962c46861970bbd26edc757cc673

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_doubleslash_theme-1.2.1.tar.gz:

Publisher: release.yml on doubleSlashde/mkdocs-doubleslash-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_doubleslash_theme-1.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_doubleslash_theme-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 effc2455d1dce4a2df9711cf3f3e73f3aa9c7b131d088647257b8ae6e1e431f4
MD5 98c18f015724ef552900177bfa784eb0
BLAKE2b-256 7a9383cf6557b76f278e1a3369d2b4256d78b6f0b84355cb55e671b26988e798

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_doubleslash_theme-1.2.1-py3-none-any.whl:

Publisher: release.yml on doubleSlashde/mkdocs-doubleslash-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page