migrated Github wiki links to readthedocs
This commit is contained in:
parent
de901736a6
commit
cc8f572bc0
10 changed files with 14 additions and 14 deletions
|
@ -61,7 +61,7 @@ The documentation has been migrated to ReadTheDocs:
|
||||||
This release introduces the REST API, and requires updating HTTP server
|
This release introduces the REST API, and requires updating HTTP server
|
||||||
configuration to enable URL rewriting, see:
|
configuration to enable URL rewriting, see:
|
||||||
- https://shaarli.github.io/api-documentation/
|
- https://shaarli.github.io/api-documentation/
|
||||||
- https://github.com/shaarli/Shaarli/wiki/Server-configuration
|
- https://shaarli.readthedocs.io/en/master/Server-configuration/
|
||||||
|
|
||||||
**WARNING**: Shaarli now requires PHP 5.5+.
|
**WARNING**: Shaarli now requires PHP 5.5+.
|
||||||
|
|
||||||
|
|
|
@ -54,7 +54,7 @@ Please report any problem you might find.
|
||||||
* starting from branch ` master`, switch to a new branch (eg. `git checkout -b my-awesome-feature`)
|
* starting from branch ` master`, switch to a new branch (eg. `git checkout -b my-awesome-feature`)
|
||||||
* edit the required files (from the Github web interface or your text editor)
|
* edit the required files (from the Github web interface or your text editor)
|
||||||
* add and commit your changes with a meaningful commit message (eg `Cool new feature, fixes issue #1001`)
|
* add and commit your changes with a meaningful commit message (eg `Cool new feature, fixes issue #1001`)
|
||||||
* run unit tests against your patched version, see [Running unit tests](https://github.com/shaarli/Shaarli/wiki/Running-unit-tests)
|
* run unit tests against your patched version, see [Running unit tests](https://shaarli.readthedocs.io/en/master/Unit-tests/#run-unit-tests)
|
||||||
* Open your fork in the Github web interface and click the "Compare and Pull Request" button, enter required info and submit your Pull Request.
|
* Open your fork in the Github web interface and click the "Compare and Pull Request" button, enter required info and submit your Pull Request.
|
||||||
|
|
||||||
All changes you will do on the `my-awesome-feature` in the future will be added to your Pull Request. Don't work directly on the master branch, don't do unrelated work on your `my-awesome-feature` branch.
|
All changes you will do on the `my-awesome-feature` in the future will be added to your Pull Request. Don't work directly on the master branch, don't do unrelated work on your `my-awesome-feature` branch.
|
||||||
|
|
|
@ -249,7 +249,7 @@ private function check()
|
||||||
$link = array(
|
$link = array(
|
||||||
'id' => 1,
|
'id' => 1,
|
||||||
'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone',
|
'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone',
|
||||||
'url'=>'https://github.com/shaarli/Shaarli/wiki',
|
'url'=>'https://shaarli.readthedocs.io',
|
||||||
'description'=>'Welcome to Shaarli! This is your first public bookmark. To edit or delete me, you must first login.
|
'description'=>'Welcome to Shaarli! This is your first public bookmark. To edit or delete me, you must first login.
|
||||||
|
|
||||||
To learn how to use Shaarli, consult the link "Help/documentation" at the bottom of this page.
|
To learn how to use Shaarli, consult the link "Help/documentation" at the bottom of this page.
|
||||||
|
|
|
@ -9,8 +9,8 @@
|
||||||
*
|
*
|
||||||
* Manages all Shaarli's settings.
|
* Manages all Shaarli's settings.
|
||||||
* See the documentation for more information on settings:
|
* See the documentation for more information on settings:
|
||||||
* - doc/Shaarli-configuration.html
|
* - doc/md/Shaarli-configuration.md
|
||||||
* - https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration
|
* - https://shaarli.readthedocs.io/en/master/Shaarli-configuration/#configuration
|
||||||
*/
|
*/
|
||||||
class ConfigManager
|
class ConfigManager
|
||||||
{
|
{
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
"homepage": "https://github.com/shaarli/Shaarli",
|
"homepage": "https://github.com/shaarli/Shaarli",
|
||||||
"support": {
|
"support": {
|
||||||
"issues": "https://github.com/shaarli/Shaarli/issues",
|
"issues": "https://github.com/shaarli/Shaarli/issues",
|
||||||
"wiki": "https://github.com/shaarli/Shaarli/wiki"
|
"wiki": "https://shaarli.readthedocs.io"
|
||||||
},
|
},
|
||||||
"keywords": ["bookmark", "link", "share", "web"],
|
"keywords": ["bookmark", "link", "share", "web"],
|
||||||
"config": {
|
"config": {
|
||||||
|
|
|
@ -49,10 +49,10 @@ hook_<plugin_name>_<hook_name>($data, $conf)
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data)
|
- data: see [$data section](https://shaarli.readthedocs.io/en/master/Plugin-System/#plugins-data)
|
||||||
- conf: the `ConfigManager` instance.
|
- conf: the `ConfigManager` instance.
|
||||||
|
|
||||||
For exemple, if my plugin want to add data to the header, this function is needed:
|
For example, if my plugin want to add data to the header, this function is needed:
|
||||||
|
|
||||||
hook_demo_plugin_render_header
|
hook_demo_plugin_render_header
|
||||||
|
|
||||||
|
|
|
@ -72,4 +72,4 @@ Usage of each plugin is documented in it's README file:
|
||||||
|
|
||||||
#### Third party plugins
|
#### Third party plugins
|
||||||
|
|
||||||
See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins)
|
See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-&-Related-software/)
|
||||||
|
|
|
@ -37,7 +37,7 @@ Login: `demo`; Password: `demo`
|
||||||
- daily RSS feed
|
- daily RSS feed
|
||||||
- permalinks for easy reference
|
- permalinks for easy reference
|
||||||
- links can be public or private
|
- links can be public or private
|
||||||
- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage)
|
- extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
|
||||||
|
|
||||||
### Tag, view and search your links!
|
### Tag, view and search your links!
|
||||||
- add a custom title and description to archived links
|
- add a custom title and description to archived links
|
||||||
|
|
|
@ -48,8 +48,8 @@
|
||||||
."If you installed Shaarli through Git or using the development branch,\n"
|
."If you installed Shaarli through Git or using the development branch,\n"
|
||||||
."please refer to the installation documentation to install PHP"
|
."please refer to the installation documentation to install PHP"
|
||||||
." dependencies using Composer:\n"
|
." dependencies using Composer:\n"
|
||||||
."- https://github.com/shaarli/Shaarli/wiki/Server-requirements\n"
|
."- https://shaarli.readthedocs.io/en/master/Server-requirements/\n"
|
||||||
."- https://github.com/shaarli/Shaarli/wiki/Download-and-Installation";
|
."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
|
||||||
exit;
|
exit;
|
||||||
}
|
}
|
||||||
require_once 'inc/rain.tpl.class.php';
|
require_once 'inc/rain.tpl.class.php';
|
||||||
|
@ -1233,7 +1233,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history)
|
||||||
// Linkdate is kept here to:
|
// Linkdate is kept here to:
|
||||||
// - use the same permalink for notes as they're displayed when creating them
|
// - use the same permalink for notes as they're displayed when creating them
|
||||||
// - let users hack creation date of their posts
|
// - let users hack creation date of their posts
|
||||||
// See: https://github.com/shaarli/Shaarli/wiki/Datastore-hacks#changing-the-timestamp-for-a-link
|
// See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare
|
||||||
$linkdate = escape($_POST['lf_linkdate']);
|
$linkdate = escape($_POST['lf_linkdate']);
|
||||||
if (isset($LINKSDB[$id])) {
|
if (isset($LINKSDB[$id])) {
|
||||||
// Edit
|
// Edit
|
||||||
|
|
|
@ -8,7 +8,7 @@ This uses code from https://zaius.github.io/youtube_playlist/ and is currently o
|
||||||
|
|
||||||
#### Installation and setup
|
#### Installation and setup
|
||||||
|
|
||||||
This is a default Shaarli plugin, you just have to enable it. See https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration/
|
This is a default Shaarli plugin, you just have to enable it. See https://shaarli.readthedocs.io/en/master/Shaarli-configuration/
|
||||||
|
|
||||||
|
|
||||||
#### Troubleshooting
|
#### Troubleshooting
|
||||||
|
|
Loading…
Reference in a new issue