Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix mkdocs build warnings/relative links #2015

Merged
merged 1 commit into from
Aug 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/md/Community-and-related-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ please get in touch with us to help us find a way to adapt your work to our fork
## Related software

### REST API clients
See [REST API](REST-API) for a list of official and community clients.
See [REST API](REST-API.md) for a list of official and community clients.


### Third party plugins
Expand All @@ -34,7 +34,7 @@ See [REST API](REST-API) for a list of official and community clients.

### Third-party themes

See [Theming](Theming) for a list of community-contributed themes, and an installation guide.
See [Theming](dev/Theming.md) for a list of community-contributed themes, and an installation guide.


### Integration with other platforms
Expand Down
2 changes: 1 addition & 1 deletion doc/md/Plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This is important in case plugins depend on each other. Read plugins READMEs for

## Configuration file

Enabled plugins are stored in your [Configuration file](Shaarli-configuration).
Enabled plugins are stored in your [Configuration file](Shaarli-configuration.md).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion doc/md/REST-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

See the **[REST API documentation](http://shaarli.github.io/api-documentation/)** for a list of available endpoints and parameters.

Please ensure that your server meets the requirements and is properly [configured](Server-configuration):
Please ensure that your server meets the requirements and is properly [configured](Server-configuration.md):

- URL rewriting is enabled (see specific Apache and Nginx sections)
- the server's timezone is properly defined
Expand Down
2 changes: 1 addition & 1 deletion doc/md/Reverse-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If Shaarli is hosted on a server behind a [reverse proxy](https://en.wikipedia.o
- Shaarli's Fully Qualified Domain Name (FQDN) is `shaarli.mydomain.org`.
- No HTTPS is setup on the application server, SSL termination is done at the reverse proxy.

In your [Shaarli configuration](Shaarli-configuration) `data/config.json.php`, add the public IP of your proxy under `security.trusted_proxies`.
In your [Shaarli configuration](Shaarli-configuration.md) `data/config.json.php`, add the public IP of your proxy under `security.trusted_proxies`.

See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues.

Expand Down
2 changes: 1 addition & 1 deletion doc/md/Server-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ The following examples assume a Debian-based operating system is installed. On o
sudo mkdir -p /var/www/shaarli.mydomain.org/
```

You can install Shaarli at the root of your virtualhost, or in a subdirectory as well. See [Directory structure](Directory-structure)
You can install Shaarli at the root of your virtualhost, or in a subdirectory as well. See [Directory structure](dev/Development.md#directory-structure)


### Apache
Expand Down
2 changes: 1 addition & 1 deletion doc/md/Shaarli-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ Additional settings applied to formatters.

### Translation

- **language**: translation language (also see [Translations](Translations))
- **language**: translation language (also see [Translations](dev/Translations.md))
- **auto** (default): The translation language is chosen from the browser locale.
It means that the language can be different for 2 different visitors depending on their locale.
- **en**: Use the English translation.
Expand Down
4 changes: 2 additions & 2 deletions doc/md/dev/Development.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Please read [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/ma
## Guidelines


- [Unit tests](Unit-tests)
- [Unit tests](Unit-tests.md)
- Javascript linting - Shaarli uses [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
Run `make eslint` to check JS style.
- [GnuPG signature](GnuPG-signature) for tags/releases
- [GnuPG signature](GnuPG-signature.md) for tags/releases


## Third-party libraries
Expand Down
2 changes: 1 addition & 1 deletion doc/md/dev/GnuPG-signature.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ gpg: sending key A9D53A3E to hkp server pgp.mit.edu

## Create and push a GPG-signed tag

See [Release Shaarli](Release Shaarli).
See [Release Shaarli](Release-Shaarli.md).
2 changes: 1 addition & 1 deletion doc/md/dev/Theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Get config written:
- fill the install form
- log in to Shaarli

Edit Shaarli's [configuration](Shaarli-configuration):
Edit Shaarli's [configuration](../Shaarli-configuration.md):
```bash
# the file should be owned by Apache, thus not writeable => sudo
$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php
Expand Down
2 changes: 1 addition & 1 deletion doc/md/dev/Translations.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Save when you're done, then you can submit a pull request containing the new `sh

### Theme translations

[Theme](Theming) translation extensions are loaded automatically if they're present.
[Theme](Theming.md) translation extensions are loaded automatically if they're present.

As a theme developer, all you have to do is to add the `.po` and `.mo` compiled file like this:

Expand Down
6 changes: 3 additions & 3 deletions doc/md/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Shaarli can be used:
- [Search](Usage.md#search) in all fields
- Unique [permalinks](Usage.md#permalinks) for easy reference
- Paginated Shaares list view (with image and video thumbnails)
- [Tag cloud/list](Usage#tag-cloud) views
- [Picture wall](Usage#picture-wall)/thumbnails view (with lazy loading)
- [Tag cloud/list](Usage.md#tag-cloud) views
- [Picture wall](Usage.md#picture-wall)/thumbnails view (with lazy loading)
- [ATOM and RSS feeds](Usage.md#rss-feeds) (can also be filtered using tags or text search)
- [Daily](Usage.md#daily): newspaper-like daily digest (and daily RSS feed)
- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` tracking parameters
Expand Down Expand Up @@ -80,7 +80,7 @@ Shaarli can be used:
### Self-hosted

- Shaarli is an alternative to commercial services such as StumbleUpon, Delicio.us, Diigo...
- The data is yours, [import and export](Usage#import-export) it to HTML bookmarksformat compatible with most web browser, and from a variety of formats
- The data is yours, [import and export](Usage.md#import-export) it to HTML bookmarksformat compatible with most web browser, and from a variety of formats
- Shaarli does not send any telemetry/metrics/private information to developers
- Shaarli is Free and Open-Source software, inspect and change how the program works in the [source code](https://github.com/shaarli/Shaarli)
- Built-in [Security](dev/Development.md#security) features to help you protect your Shaarli instance
Expand Down