elastic / elastic/stack-docs

[Docs] modify CSS to show "parser options" in italic in the Elastic Docs, similar to Github

Offen
#2,263 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
105
Forks
249
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

In our documentation in Github at https://github.com/elastic/beats/blob/8.5/filebeat/docs/inputs/input-filestream-reader-options.asciidoc#ndjson. we can see that the parser (e.g., `ndjson`) is formatted in a **bold mono** font.

The parser options (e.g., `target`) are formatted as a **_bold italic mono_** font.

This makes it easy to distinguish between the Parser and the Parser options.

Looking at the resulting document in our docs at https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-filestream.html#_ndjson, we can see that the Parser and the Parser Options have the same formatting. They are both bold mono font with the parser options missing the italic formatting.

This makes it harder to read the official document compared to the GitHub document. A customer complained and asked if we can make the Parser Options in our doc italic, too, for easy readability.

GitHub (good formatting):
![2022-11-14 13_49_48-github](https://user-images.githubusercontent.com/55087308/201930442-71a31585-160c-439f-bc6e-ad377342759d.png)

Elastic Docs (bad formatting):
![2022-11-14 13_47_58-Program Manager](https://user-images.githubusercontent.com/55087308/201930406-d7386c88-6f96-4092-8fcd-598aaaf06bd3.png)

Originally filed at https://github.com/elastic/website-requests/issues/840

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.