3 votos

¿Cuál es un buen estilo para documentar las teclas de acceso rápido de OS X en la web con markdown?

A menudo tengo que dar instrucciones sobre el uso de las teclas de acceso rápido de OS X en la documentación. La escribo en markdown, normalmente en páginas de GitHub y a veces en StackExchange. Las teclas están formateadas con key = key .

En las interfaces de OS X las teclas suelen aparecer juntas, sin espacios entre ellas. Pero OS X utiliza un tipo de letra bien legible, por lo que la cadena tiene un aspecto bonito.

enter image description here

Pero cuando se representan en un sitio web, los símbolos no siempre se ven bien. Así que hay dos opciones: escribir todas las claves en una sola etiqueta, o cada una en una etiqueta separada

Opción 1.

* \ = `«`
* \ = `»`

Resultando en

  • \ = «
  • \ = »

Opción 2

* \ = `«`
* \ = `»`

Resultando en

  • \ = «
  • \ = »

¿Cuál es el mejor? ¿Debería añadir + ¿símbolos en el medio? (Lo que me parece un estilo de Windows).

Opción 2a

  • + \ = «
  • + + \ = »

5voto

Tetsujin Puntos 23061

No estoy seguro de que esté grabado en piedra en ningún sitio, pero la convención para Ask Different parece estar en la línea de

Cmd ⌘ Ctrl ⌃ Opt ⌥ Shift ⇧ T
Cmd ⌘ Ctrl ⌃ Opt ⌥ Shift ⇧ T

dando el nombre abreviado y el símbolo de la llave, sin + entre

Hay que reconocer que no es tan ordenado como el de Apple.

No estoy seguro de los "equivalentes clave", pero tal vez
Opt ⌥ Shift ⇧ \ \= »
como su opción 2.

Por cierto, yo utilizo Preferencias del Sistema > Teclado > Texto para generar esto rápidamente en Stack Exchange
(que aparentemente sólo funciona en Safari, no en Firefox o Chrome, véase Sustituir el texto por un valor predefinido en el navegador )

enter image description here

AppleAyuda.com

AppleAyuda es una comunidad de usuarios de los productos de Apple en la que puedes resolver tus problemas y dudas.
Puedes consultar las preguntas de otros usuarios, hacer tus propias preguntas o resolver las de los demás.

Powered by:

X