Extend your YOURLS instance with note-sharing capabilities. All standard URL shortening keeps working as usual — this plugin simply adds the ability to create short URLs that display text or Markdown notes instead of redirecting.

Keep shortening URLs and share notes, all from the same YOURLS admin panel.

• YOURLS 1.7.3 or later
• PHP 7.4+
• MySQL / MariaDB with InnoDB support

Clone or download this repository into your YOURLS plugins directory:

cd /path/to/yourls/user/plugins
git clone https://github.com/pedrazadixon/yourls-notes yourls-notes

Or download the ZIP and extract it so the directory structure looks like:

yourls/
└── user/
    └── plugins/
        └── yourls-notes/
            ├── assets/
            │   ├── note-page.css
            │   ├── notes.css
            │   └── notes.js
            ├── includes/
            │   ├── admin.php
            │   ├── ajax.php
            │   ├── display.php
            │   ├── helpers.php
            │   ├── settings.php
            │   └── stats.php
            ├── plugin.php
            └── uninstall.php

1. Log in to your YOURLS admin panel.
2. Navigate to Manage Plugins.
3. Find "Notes" in the list and click Activate.

On activation the plugin will automatically create a {prefix}_notes table in your database.

After activation you should see a 📝 Create a Note button on the admin home page, right below the standard "Shorten URL" form.

1. Click the 📝 Create a Note button in the admin panel.
2. Write your note content in the textarea.
3. (Optional) Enter a custom keyword for the short URL.
4. Check or uncheck Render Markdown depending on whether you want the note displayed as formatted Markdown or raw text.
5. Click Create Note.

The resulting short URL (e.g. https://sho.rt/myNote) will display the note content instead of redirecting.

1. In the admin link table, click the Edit button on any note row.
2. Modify the note content, the keyword, or the Markdown toggle.
3. Click Save.

When Render Markdown is enabled, the note is rendered client-side using marked.js. You can use standard Markdown syntax:

# Heading

**Bold text**, *italic text*, and `inline code`.

- List item 1
- List item 2

> Blockquote

[Link](https://example.com)

When disabled, the note content is displayed as plain pre-formatted text.

Navigate to Manage Plugins → Notes Settings to access the settings page. From there you can:

• View the notes table name and total note count.
• Truncate all notes and their associated short URLs (with confirmation prompt).

yourls-notes/
├── plugin.php            # Bootstrap: constants, module loading, activation & cleanup hooks
├── uninstall.php         # Deactivation guard (data preserved by design)
├── includes/
│   ├── helpers.php       # DB helper functions (get table, check note, get content)
│   ├── admin.php         # Admin UI: form, table row badge, edit row, search filter, assets
│   ├── ajax.php          # AJAX endpoints: create note, save edited note
│   ├── display.php       # Public rendering: intercept redirect, render HTML page
│   ├── settings.php      # Settings page: table info, truncate action
│   └── stats.php         # Stats page tweaks: preview instead of internal URL
└── assets/
    ├── notes.js          # Admin JS: form toggle, AJAX create/edit
    ├── notes.css         # Admin styles: form, badges, feedback
    └── note-page.css     # Public note page styles (minimalist)

The plugin creates a single table {prefix}_notes:

The plugin preserves note data when deactivated, so you can safely reactivate it later without losing content.

To remove all note data you have two options:

1. Go to Manage Plugins → Notes Settings.
2. Click Truncate Notes Table (this removes all notes and their short URLs).
3. Deactivate the plugin.

1. Deactivate the plugin from the YOURLS admin panel.
2. Delete the yourls-notes folder from user/plugins/.
3. Drop the notes table manually:

DROP TABLE IF EXISTS `yourls_notes`;

(Replace yourls_ with your actual YOURLS table prefix.)

MIT

pedrazadixon — GitHub