Skip to content

Commit 6745bd6

Browse files
committed
docs(readme): update links to clean URLs for dirhtml builder
why: Switched to dirhtml builder which generates clean URLs (/quickstart/ instead of /quickstart.html). README links need to match since they render on GitHub/PyPI where redirects don't apply. what: - Convert all .html doc links to trailing-slash format - Covers: cli/, configuration/, topics/, quickstart, history, about_tmux
1 parent 03a559b commit 6745bd6

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ Name a session:
132132
tmuxp load -s session_name ./mysession.yaml
133133
```
134134

135-
[simple](https://tmuxp.git-pull.com/configuration/examples.html#short-hand-inline-style) and
135+
[simple](https://tmuxp.git-pull.com/configuration/examples/#short-hand-inline-style) and
136136
[very
137-
elaborate](https://tmuxp.git-pull.com/configuration/examples.html#super-advanced-dev-environment)
137+
elaborate](https://tmuxp.git-pull.com/configuration/examples/#super-advanced-dev-environment)
138138
config examples
139139

140140
# User-level configurations
@@ -197,14 +197,14 @@ $ tmuxp shell -c 'print(window.name.upper())'
197197
MY_WINDOW
198198
```
199199

200-
Read more on [tmuxp shell](https://tmuxp.git-pull.com/cli/shell.html) in
200+
Read more on [tmuxp shell](https://tmuxp.git-pull.com/cli/shell/) in
201201
the CLI docs.
202202

203203
# Pre-load hook
204204

205205
Run custom startup scripts (such as installing project dependencies)
206206
before loading tmux. See the
207-
[before_script](https://tmuxp.git-pull.com/configuration/examples.html#bootstrap-project-before-launch)
207+
[before_script](https://tmuxp.git-pull.com/configuration/examples/#bootstrap-project-before-launch)
208208
example
209209

210210
# Load in detached state
@@ -224,7 +224,7 @@ $ tmuxp freeze session-name
224224
```
225225

226226
See more about [freezing
227-
tmux](https://tmuxp.git-pull.com/cli/freeze.html) sessions.
227+
tmux](https://tmuxp.git-pull.com/cli/freeze/) sessions.
228228

229229
# Convert a session file
230230

@@ -247,7 +247,7 @@ $ tmuxp convert --yes filename
247247
# Plugin System
248248

249249
tmuxp has a plugin system to allow for custom behavior. See more about
250-
the [Plugin System](https://tmuxp.git-pull.com/topics/plugins.html).
250+
the [Plugin System](https://tmuxp.git-pull.com/topics/plugins/).
251251

252252
# Debugging Helpers
253253

@@ -272,13 +272,13 @@ environment:
272272

273273
# Docs / Reading material
274274

275-
See the [Quickstart](https://tmuxp.git-pull.com/quickstart.html).
275+
See the [Quickstart](https://tmuxp.git-pull.com/quickstart/).
276276

277277
[Documentation](https://tmuxp.git-pull.com) homepage (also in
278278
[中文](http://tmuxp-zh.rtfd.org/))
279279

280280
Want to learn more about tmux itself? [Read The Tao of Tmux
281-
online](https://tmuxp.git-pull.com/about_tmux.html).
281+
online](https://tmuxp.git-pull.com/about_tmux/).
282282

283283
# Donations
284284

@@ -295,8 +295,8 @@ See donation options at <https://tony.sh/support.html>.
295295
- python support: >= 3.10, pypy, pypy3
296296
- Source: <https://github.com/tmux-python/tmuxp>
297297
- Docs: <https://tmuxp.git-pull.com>
298-
- API: <https://tmuxp.git-pull.com/internals/api/index.html>
299-
- Changelog: <https://tmuxp.git-pull.com/history.html>
298+
- API: <https://tmuxp.git-pull.com/internals/api/>
299+
- Changelog: <https://tmuxp.git-pull.com/history/>
300300
- Issues: <https://github.com/tmux-python/tmuxp/issues>
301301
- Test Coverage: <https://codecov.io/gh/tmux-python/tmuxp>
302302
- pypi: <https://pypi.python.org/pypi/tmuxp>

0 commit comments

Comments
 (0)