tealdeer/docs
Danilo Bargen 72d753c52b
Add "macos" alias for "osx" (#215)
The Apple computer operating system was renamed from "OS X" to "macOS"
in 2016. We should accept "macos" instead of "osx" in all our CLI APIs,
and the docs should also mention this alias instead of "osx".

For backwards compatibility and for compatibility with the tldr client
specification, we should still accept "osx" though.
2021-12-05 16:38:35 +01:00
..
src Add "macos" alias for "osx" (#215) 2021-12-05 16:38:35 +01:00
.gitignore Add mdbook documentation 2020-11-01 01:39:47 +01:00
book.toml Add mdbook documentation 2020-11-01 01:39:47 +01:00
README.md Docs: Add README 2020-11-14 23:55:49 +01:00

Tealdeer Docs

To build the docs, install mdbook.

You can build the HTML with mdbook build.

To serve the docs on localhost:3000 and watch for changes, use mdbook serve.