Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

McDic/mkdocs-material-palette-bug-report-2024-01

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bug reproducing repository for mkdocs-material

This repository is used to introduce users to reproduce mkdocs-material bug discussed here.

Steps to reproduce in local

  1. Clone this repository.
  2. Make a virtual environment (Python 3.11) for this repository.
  3. Run pip install --upgrade --force-reinstall mkdocs-material to install mkdocs-material.
  4. Checkout to commit ff4d4cf.
  5. Run mkdocs serve in your terminal to turn on local server.
  6. Access 127.0.0.1:8000 from your browser.
  7. Press button on the website to make palette to the dark mode.
  8. Checkout to commit a0d3b0b and refresh your build (mkdocs serve will refresh automatically).
  9. Enjoy the bug. Javascript stuffs like searching, side navigations wouldn't work.

reproduced

Steps to reproduce .zip files

Since mkdocs-material encourages people to use .zip files made by info plugin instead of making a repository, I am going to make 2 .zip files.

  1. Run echo 2_palettes | mkdocs build -f mkdocs_2_palettes.yml
  2. Run echo 3_palettes | mkdocs build -f mkdocs_3_palettes.yml

Proposal to resolve this

I suggest to insert a validation JS code for invalid values in cache.

About

Bug reproducing repository for mkdocs-material

Resources

Stars

Watchers

Forks