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.0.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.0-py3-none-any.whl (317.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_doubleslash_theme-1.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 a819e36ed963e2193c78f283ae3c9d1c184260ba8a78b564950685accf08a3bd
MD5 2fa7e9c33defc56c45fa816415753cc5
BLAKE2b-256 834dd359ea901c39c700bae21a6ef9782f3b8bf8f66436a699bd620bb171b3cf

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for mkdocs_doubleslash_theme-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21d15c1f593b34173d3210e1bd996a7b7a98502e842be9d8f7635992836d0178
MD5 123910b2413c0cb5edca141770eb34f3
BLAKE2b-256 3d982239a0e17c609ed4eb5c15854da5f57ca4446441302eb55c75109ae0c2e2

See more details on using hashes here.

Provenance

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