Saltar al contenido

Markdown en la terminal

Lea READMEs, runbooks y notas Markdown con encabezados con estilo, paneles de código, tablas y una salida adaptada a la terminal.

Leer sin conexiónelide help --lang es terminal-markdown

En esta página

Abra un archivo .md o .markdown con Elide para leerlo como un documento formateado en la terminal. Úselo para el README de un repositorio, un runbook operativo por SSH o notas de desarrollo sin salir de la shell. No se necesita ningún proyecto de Elide.

Leer un README o un runbook

Terminal
shell
elide README.md
elide docs/runbook.md
elide run notes.markdown

Los encabezados establecen una jerarquía visual; las listas, citas, tablas y paneles de código facilitan la lectura de documentos largos. La prosa se ajusta al ancho de la terminal, y los bloques de código delimitados reciben resaltado de sintaxis para los lenguajes reconocidos. Los bloques de código se muestran, no se ejecutan.

Se admite la sintaxis CommonMark junto con las tablas, el tachado y las listas de tareas al estilo de GitHub. Por ejemplo, guarde esto como runbook.md:

markdown
# Check the service

- [x] Generate configuration
- [ ] Verify the health endpoint

```shell
curl http://localhost:8080/health
```

| Response | Next step |
| --- | --- |
| 200 | Continue deployment |
| 503 | Check application logs |
utf-8 · markdown · Líneas: 13

Después ejecute elide runbook.md. Los enlaces conservan sus destinos, y el HTML sin procesar se muestra como texto.

Recorrer un documento largo

Elide imprime el documento renderizado en stdout. Rediríjalo a un paginador como less cuando quiera desplazarse:

Terminal
shell
elide docs/runbook.md | less

La salida redirigida es texto plano por defecto. Para conservar los colores de la terminal con un paginador que entienda los escapes ANSI:

Terminal
shell
elide --color docs/runbook.md | less -R

--no-color y la variable de entorno NO_COLOR tienen prioridad sobre el color forzado. Si NO_COLOR está definida, elimínela del entorno antes de usar el ejemplo con color.

Guardar una copia de texto legible

Desactive los colores de forma explícita al guardar notas renderizadas para un registro o un artefacto:

Terminal
shell
elide --no-color notes.markdown > notes.txt

Esto escribe la representación de la terminal, incluida su disposición, en lugar de convertir Markdown a otro formato de documento. El archivo fuente no cambia. --quiet también conserva la salida renderizada.

--format es para la salida Pkl y PCF y se rechaza con archivos Markdown. La representación de documentos también rechaza --sandbox y --limit. Consulte la referencia de la CLI para ver las opciones del comando.

¿Te resultó útil esta página?