Skip to content

Commit

Permalink
Update readme.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
nk-o committed Apr 5, 2024
1 parent 46cad62 commit 20170a2
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,57 @@ Manage 301 & 302 redirects easily. No posts creation bloat, just a simple list.

== Description ==

Provide a simple list of URLs and their destinations, and Redirect.txt will take care of the rest.
With Redirect.txt, you can provide a simple list of URLs and their destinations with no post-creation bloat, no limitations, and just a simple editor.

There are many good redirect plugins that have been developed for years and have a strong code base. But we don't like the idea of creating separate posts/entries for each redirection rule. We simply need to add, remove, and manage redirects in a simple and bulk way.

.htaccess and nginx configs are OK, but we don't want to edit configs placed somewhere in server directories; we want to open our admin panel and add redirects easily. We also don't care about wrong config configurations, which will stop your server.

=== Features ===

- Path redirects
- Full URL redirects
- Post ID redirects
- RegEx redirects
- Redirect logs
- 404 logs

=== Usage ===

Open `Tools → Redirect.txt` and provide a list of URLs here. Here is an example of available syntax:

```yaml
# The links below will automatically use 301 redirects.
/hello: /new-hello

# Support for custom status
# To make 301, 302, 303, 307, or 308 redirects, use a code like this:
308: # All redirections below will use 308 redirect status.

# Support for post ID's
# Redirect from post with ID 1 to post with ID 8:
1: 8

# Support for external redirects:
/external: https://google.com/

# Support for RegEx redirects (automatically detected when the string starts with ^):
^/news/(.*): /blog/$1

# You can use as many comments as you want to categorize your links better.
```

The same rules without comments:

```yaml
/hello: /new-hello

308:

1: 8
/external: https://google.com/
^/news/(.*): /blog/$1
```

== Installation ==

Expand Down

0 comments on commit 20170a2

Please sign in to comment.