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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_doubleslash_theme-1.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 8e18ded263590f986a468be91fdfcb8e5f3a11940708c55645c2d4fe6ba2a401
MD5 3ac331fabda09f96d3a22e1504eb4bb0
BLAKE2b-256 589db6121bbef55850d66d2444e8b71140b6dda54af978e7e981baaf066d7fd1

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for mkdocs_doubleslash_theme-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b274ac4ef18e82aca9ccf9d756a9bdc7b70ea33c414a8aec862cf9c6da87c754
MD5 da3252c4540f083eeee8d58e309acaff
BLAKE2b-256 b9966b535fafc2593ed2e0eed5ee48b164587de2364bc3182aacb1f4553862bc

See more details on using hashes here.

Provenance

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