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.1.1.tar.gz (315.9 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.1.1-py3-none-any.whl (315.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_doubleslash_theme-1.1.1.tar.gz
Algorithm Hash digest
SHA256 12f0f849bb78443ce8874cc3a614af34c13aea7cc7e3892f55e4f0c85d0dbb87
MD5 2d3afa964819a270d623ee640b1a2820
BLAKE2b-256 72db18fe79184b4892e91e2fd056a9b1741fdc1bb39570c0ef869010b5c47dd3

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_doubleslash_theme-1.1.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.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_doubleslash_theme-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d9bea336bd8843da8155071664e8bc8e7394d64b67a1440419c57b21e1778d8
MD5 7367c79c42d48ca91134553d8749ca14
BLAKE2b-256 22c04276ed1f6d2fb37ee49760f13cfb8b8419675f6d9d5b111b54d76bb46a75

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_doubleslash_theme-1.1.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