Home

Awesome

<p align="center"> <img src="docsify.svg" alt="Docsify Logo" height="128"> </p> <h1 align="center">Docsify Plugins</h1> <h3 align="center">Page History</h3> <p align="center">by <a href="https://github.com/simochee">simochee</a></p>

jsDelivr npm version License Release

Page-by-page history for Docsify.

📀 Installation

Insert a script tag to load the plugin script file after loading the Docsify script.

<script>
  window.$docsify = {};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@v4/lib/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@v4/lib/plugins/front-matter.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-plugin-page-history/lib/docsify-plugin-page-history.min.js"></script>

🔰 Usage

Add page history

Add history field to page front-matter.

---
history:
  - date: 2023-10-15 # recommended YYYY-MM-DD
    message: |
      Add **awesome section**.
  - date: 2023-10-10
    message: |
      Initial release
---

## Page Title

...

Display all page history

Add @[page-history] to your markdown file

# History

@[page-history]

💻 Development

  1. Clone this repository
  2. Enable Corepack using corepack enable
  3. Install dependencies using pnpm install
  4. Run watch mode using pnpm run watch
  5. Start server using Live Server
  6. Insert a script tag to load the plugin script file after loading the Docsify script.
<script src="http://localhost:5500"></script>

🛡️ License

MIT