mirror of https://github.com/CrimsonTome/tldr.git
style-guide: recommend keith.github.io for osx pages (#12097)
* style-guide: recommend keith.github.io for osx pages --------- Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>pull/23/head
parent
6151a1500e
commit
c7868a7c9c
|
@ -373,6 +373,8 @@ This can be resolved by inserting a comma before the "and" or "or" in the final
|
||||||
|
|
||||||
- On the `More information` link line, we prefer linking to the author's provided documentation of the command line reference or the man page. When not available, use <https://manned.org> as the default fallback for all platforms (except `osx` and BSD platforms other than FreeBSD). Alternatively, you can link to the author's website or a tutorial page if the command doesn't have a documentation page.
|
- On the `More information` link line, we prefer linking to the author's provided documentation of the command line reference or the man page. When not available, use <https://manned.org> as the default fallback for all platforms (except `osx` and BSD platforms other than FreeBSD). Alternatively, you can link to the author's website or a tutorial page if the command doesn't have a documentation page.
|
||||||
|
|
||||||
|
- For `osx`: Apple distributes the built-in man pages [in Xcode](https://developer.apple.com/documentation/os/reading_unix_manual_pages). For commands documented there, we recommend using https://keith.github.io/xcode-man-pages/, an HTML export of all Apple's man pages bundled with Xcode.
|
||||||
|
|
||||||
- **All links must be enclosed inside angular brackets (`<` and `>`) for proper rendering in clients.**
|
- **All links must be enclosed inside angular brackets (`<` and `>`) for proper rendering in clients.**
|
||||||
|
|
||||||
- We prefer translations to use the more information link of the English page by default.
|
- We prefer translations to use the more information link of the English page by default.
|
||||||
|
|
Loading…
Reference in New Issue