kouhais-mirrors
/
safer-indie-wiki-buddy
mirror of https://github.com/KevinPayravi/indie-wiki-buddy.git
1
0
Fork 0
Code

Destination API path has been replaced with destination content path

pull/14/head
Kevin Payravi 2022-11-26 05:11:40 -05:00 committed by GitHub
parent a59545a43d
commit 25823d2d9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -30,7 +30,7 @@ Entries are formatted as follows:
"origin_content_path": "/wiki/", "origin_content_path": "/wiki/",
"destination": "Example Wiki", "destination": "Example Wiki",
"destination_base_url": "example.com", "destination_base_url": "example.com",
"destination_api_path": "/w/", "destination_content_path": "/w/",
"destination_platform": "mediawiki", "destination_platform": "mediawiki",
"destination_icon": "example.png" "destination_icon": "example.png"
} }
@ -38,10 +38,10 @@ Entries are formatted as follows:
* `origin`: Name of the wiki being redirected. * `origin`: Name of the wiki being redirected.
* `origin_base_url`: Fully qualified domain name of the wiki being redirected. * `origin_base_url`: Fully qualified domain name of the wiki being redirected.
* `origin_content_path`: The URL path for article links. On MediaWiki wikis, it can be found at Special:Version. Fandom wikis are usually `/wiki/`. * `origin_content_path`: The URL path prefix for article links on the wiki being redirected. On MediaWiki wikis, it can be found at Special:Version. Fandom wikis are usually `/wiki/`.
* `destination`: Name of the wiki being redirected to. * `destination`: Name of the wiki being redirected to.
* `destination_base_url`: Fully qualified domain name of the wiki being redirected to. * `destination_base_url`: Fully qualified domain name of the wiki being redirected to.
* `destination_api_path`: The URL path for the wiki's API endpoints. This is different from `origin_content_path`. On MediaWiki wikis, it can be found at Special:Version. It is usually `/` or `/w/`. * `destination_content_path`: The URL path prefix for article links on the wiki being redirected to. On MediaWiki wikis, it can be found at Special:Version. It is typically `/wiki/` or `/`.
* `destination_platform`: The wiki's software. The current supported options are `mediawiki` and `doku`. If you are contributing a wiki that is on another wiki platform, please open an issue so that support for the platform can be added. * `destination_platform`: The wiki's software. The current supported options are `mediawiki` and `doku`. If you are contributing a wiki that is on another wiki platform, please open an issue so that support for the platform can be added.
* `destination_icon`: The name of the wiki's favicon in the [favicons](favicons) folder. * `destination_icon`: The name of the wiki's favicon in the [favicons](favicons) folder.