https://github.com/berk-karaal/mkdocs-material-mark-as-read

A mkdocs-material plugin to mark pages as read
https://github.com/berk-karaal/mkdocs-material-mark-as-read

mkdocs mkdocs-material mkdocs-plugin

Last synced: about 1 year ago
JSON representation

A mkdocs-material plugin to mark pages as read

• Host: GitHub
• URL: https://github.com/berk-karaal/mkdocs-material-mark-as-read
• Owner: berk-karaal
• License: mit
• Created: 2024-03-23T18:01:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T07:53:05.000Z (almost 2 years ago)
• Last Synced: 2025-03-04T09:24:57.471Z (over 1 year ago)
• Topics: mkdocs, mkdocs-material, mkdocs-plugin
• Language: Python
• Homepage: https://berkkaraal.com/mkdocs-material-mark-as-read/
• Size: 225 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Mark as Read Plugin for Mkdocs Material

[![Material for

MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

This plugin allows users to keep track of their reading progress by marking pages as read.

Preview gif:

![Preview gif](https://raw.githubusercontent.com/berk-karaal/mkdocs-material-mark-as-read/main/docs/mark-as-read-demo.gif)

Try it on [documentation website](https://berk-karaal.github.io/mkdocs-material-mark-as-read/).

Setup this plugin easily with [quickstart

docs](https://berk-karaal.github.io/mkdocs-material-mark-as-read/quickstart/).