Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-09-20 14:32:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/tutorial: Replace coloring markup

Browse source 
This used to use doxygen's html blocks, which don't have a *direct*
equivalent in sphinx in code blocks.

Instead of adding this to the pygments highlighter, let's just use
some roles.

It's a teensy bit awkward as we then use block styling, but we want to
add more of our own styling anyway, so we can presumably get this
somehow, and these html tags look awkward and confuse people.

Fix #6640

[ci skip]
This commit is contained in:
Fabian Homborg 2020-02-22 18:01:05 +01:00
parent f036d01961
commit b5cbdc623d
2 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc_src/_static/pygments.css
View file

@ -79,3 +79,6 @@
.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */
.purple { color: #551a8b }
.yellow { color: #FFFF00 }
.red { color: #FF0000 }
.gray { color: #555555 }
.underline { text-decoration: underline }

34
doc_src/tutorial.rst
View file

@ -82,19 +82,23 @@ Getting Help
Syntax Highlighting
-------------------
You'll quickly notice that ``fish`` performs syntax highlighting as you type. Invalid commands are colored red by default::
.. role:: red
.. role:: gray
.. role:: underline
> <red>/bin/mkd</red>
You'll quickly notice that ``fish`` performs syntax highlighting as you type. Invalid commands are colored red by default
> :red:`/bin/mkd`
A command may be invalid because it does not exist, or refers to a file that you cannot execute. When the command becomes valid, it is shown in a different color::
> /bin/mkdir
``fish`` will underline valid file paths as you type them::
``fish`` will underline valid file paths as you type them
> cat <underline>~/somefi</underline>
> cat :underline:`~/somefi`
This tells you that there exists a file that starts with '``somefi``', which is useful feedback as you type.
@ -156,19 +160,19 @@ To redirect stdout and stderr into one file, you need to first redirect stdout,
Autosuggestions
---------------
``fish`` suggests commands as you type, and shows the suggestion to the right of the cursor, in gray. For example::
``fish`` suggests commands as you type, and shows the suggestion to the right of the cursor, in gray. For example
> <red>/bin/h</red><gray>ostname</gray>
> :red:`/bin/h`:gray:`ostname`
It knows about paths and options::
It knows about paths and options
> grep --i<gray>gnore-case</gray>
`> grep --i`:gray:`gnore-case`
And history too. Type a command once, and you can re-summon it by just typing a few letters::
And history too. Type a command once, and you can re-summon it by just typing a few letters
> <red>r</red><gray>sync -avze ssh . myname@somelonghost.com:/some/long/path/doo/dee/doo/dee/doo</gray>
> :red:`r`:gray:`sync -avze ssh . myname@somelonghost.com:/some/long/path/doo/dee/doo/dee/doo`
To accept the autosuggestion, hit :kbd:`→` (right arrow) or :kbd:`Control+F`. To accept a single word of the autosuggestion, :kbd:`Alt+→` (right arrow). If the autosuggestion is not what you want, just ignore it.
@ -178,15 +182,15 @@ Tab Completions
``fish`` comes with a rich set of tab completions, that work "out of the box."
Press :kbd:`Tab`, and ``fish`` will attempt to complete the command, argument, or path::
Press :kbd:`Tab`, and ``fish`` will attempt to complete the command, argument, or path
> <red>/pri</red> :kbd:`Tab` => /private/
> :red:`/pri` :kbd:`Tab` => /private/
If there's more than one possibility, it will list them::
If there's more than one possibility, it will list them
> <red>~/stuff/s</red> :kbd:`Tab`
~/stuff/script.sh (Executable, 4.8kB) ~/stuff/sources/ (Directory)
> :red:`~/stuff/s` :kbd:`Tab`
~/stuff/script.sh (Executable, 4.8kB) ~/stuff/sources/ (Directory)
Hit tab again to cycle through the possibilities.