Use new README style
This commit is contained in:
parent
0e389ad6b4
commit
39df98dcd8
1 changed files with 21 additions and 25 deletions
46
README.md
46
README.md
|
@ -1,25 +1,22 @@
|
||||||
# README
|
# README
|
||||||
|
|
||||||
[![Release](https://img.shields.io/badge/release-1.9-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/alias/releases)
|
[![Release](https://img.shields.io/badge/release-1.9-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/alias/releases)
|
||||||
[![Date](https://img.shields.io/badge/date-2023.08.06-c44d58.svg)](https://git.dotclear.watch/JcDenis/alias/releases)
|
![Date](https://img.shields.io/badge/date-2023.08.07-c44d58.svg)]
|
||||||
[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
|
[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
|
||||||
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/alias)
|
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/alias)
|
||||||
[![License](https://img.shields.io/github/license/JcDenis/alias)](https://git.dotclear.watch/JcDenis/alias/blob/master/LICENSE)
|
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/alias/blob/master/LICENSE)
|
||||||
|
|
||||||
## WHAT IS ALIAS ?
|
## ABOUT
|
||||||
|
|
||||||
_alias_ is a plugin for the open-source
|
_alias_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
|
||||||
web publishing software called Dotclear.
|
|
||||||
|
|
||||||
This plugin creates public aliases of your blog's URLs.
|
> Create aliases of your blog's URLs.
|
||||||
|
|
||||||
## REQUIREMENTS
|
## REQUIREMENTS
|
||||||
|
|
||||||
_alias_ requires:
|
* Dotclear 2.27
|
||||||
|
* PHP 7.4+
|
||||||
* admin permissions for management
|
* Dotclear admin permission for management
|
||||||
* Dotclear 2.27
|
|
||||||
* PHP 7.4+
|
|
||||||
|
|
||||||
## USAGE
|
## USAGE
|
||||||
|
|
||||||
|
@ -30,27 +27,26 @@ You can manage your aliases from menu ''Alias'' on admin dashboard sidebar.
|
||||||
|
|
||||||
## RULES
|
## RULES
|
||||||
|
|
||||||
- Only blog URLs can be redirected.
|
* Only blog URLs can be redirected.
|
||||||
- It can redirect a specific URL "plop" to another one "post/2023/04/24/my-post".
|
* It can redirect a specific URL "plop" to another one "post/2023/04/24/my-post".
|
||||||
- It can redirect all URLs that content "plop" using alias "/plop/"
|
* It can redirect all URLs that content "plop" using alias "/plop/" by replacing it by destination "post" into requesting URL. (Even if it's not at the begining of the URL!)
|
||||||
by replacing it by destination "post" into requesting URL. (Even if it's not at the begining of the URL!)
|
* It can not redirect an alias to another alias.
|
||||||
- It can not redirect an alias to another alias.
|
* It has priority on all ohters URLs handlers, so if you create an alias of an existing page, the destination from plugin _alias_ will be used.
|
||||||
- It has priority on all ohters URLs handlers, so if you create an alias of an existing page,
|
|
||||||
the destination from plugin _alias_ will be used.
|
|
||||||
|
|
||||||
Keep in mind, plugin _alias_ loads all registered aliases to test them on each page load,
|
Keep in mind, plugin _alias_ loads all registered aliases to test them on each page load,
|
||||||
so more there are aliases, more page load is slow.
|
so more there are aliases, more page load is slow.
|
||||||
|
|
||||||
## LINKS
|
## LINKS
|
||||||
|
|
||||||
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
|
* [License](https://git.dotclear.watch/JcDenis/alias/blob/master/LICENSE)
|
||||||
* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/alias) or [GitHub Page](https://github.com/JcDenis/alias)
|
* [Packages & details](https://git.dotclear.watch/JcDenis/alias/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/alias))
|
||||||
* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/alias/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/alias)
|
* [Sources & contributions](https://git.dotclear.watch/JcDenis/alias) (or on [GitHub](https://github.com/JcDenis/alias))
|
||||||
|
* [Issues & security](https://git.dotclear.watch/JcDenis/alias/issues) (or on [GitHub](https://github.com/JcDenis/alias/issues))
|
||||||
|
|
||||||
## CONTRIBUTORS
|
## CONTRIBUTORS
|
||||||
|
|
||||||
* Olivier Meunier
|
* Olivier Meunier (author)
|
||||||
* Franck-paul
|
* Franck-paul
|
||||||
* Jean-Christian Denis
|
* Jean-Christian Denis
|
||||||
|
|
||||||
You are welcome to contribute to this code.
|
You are welcome to contribute to this code.
|
||||||
|
|
Loading…
Reference in a new issue