aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/FORMATTING.md
diff options
context:
space:
mode:
authorGravatar Mark Griffiths <mark@thebespokepixel.com>2016-04-04 13:43:37 +0100
committerGravatar Kurtis Rader <krader@skepticism.us>2016-04-04 15:23:56 -0700
commitcb6d5d76c8232264f66c9a1db895d9dd69d77bc3 (patch)
treed92b384942073d335c288744fb70dacbfc8ff0d2 /doc_src/FORMATTING.md
parent47f1a92cc4c3c7056f4172974f10a8dd402cf55c (diff)
update lexicon for latest docs
Closes #2699 Fixes issues with: * 'string' function synopsis * Redirection display issues * Better file & path detection * Rendering of % & @ chars in both html and man * @ symbol in tutorial Improves robustness by implementing an @EOL marker to prevent hold buffer dumping extra chars after the end of an expression. Added new '{{' and '}}' meta-chars for when you want curly braces in a regexp that was previously tripping up the lexicon. Improve man/html presentation consistency for * string * printf * prompt_pwd * type Use cli-styling for 'practical' examples. Add <bs> tag for presenting content with preceding backslash. Signed-off-by: Mark Griffiths <mark@thebespokepixel.com>
Diffstat (limited to 'doc_src/FORMATTING.md')
-rw-r--r--doc_src/FORMATTING.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc_src/FORMATTING.md b/doc_src/FORMATTING.md
index 0ae1c81e..df6de6f8 100644
--- a/doc_src/FORMATTING.md
+++ b/doc_src/FORMATTING.md
@@ -160,6 +160,8 @@ The following can be used in \\fish blocks to render some fish scenarios. These
- `<error>`: \<error\>This would be shown as an error.\</error\>
- `<asis>`: \<asis\>This test will not be parsed for fish markup.\</asis\>
- `<outp>`: \<outp\>This would be rendered as command/script output.\</outp\>
+- `<bs>`: Render the contents with a preceding backslash. Useful when presenting output.
+- `{{` and `}}`: Required when wanting curly braces in regular expression example.
### Prompts and cursors