Skip to content

Commit

Permalink
Use full lenght underline including the fold markers.
Browse files Browse the repository at this point in the history
Ref: debops/docs#156 (comment)

One thing that @drybjed changed was to go from

  ```YAML
  # Main configuration [[[
  # ------------------
  ```

to:

  ```YAML
  # Main configuration [[[
  # ----------------------
  ```

This has the advantage that in case we ever manage to get syntax highlighting for the embedded RST syntax working in Vim, it will not complain about sections being to short. I tried it but I am not sure if that is possible as the `# ` in the input for the syntax highlighting in Vim would need to be stipped out and then passed to the `rst` syntax highlighting. Ref: http://vim.wikia.com/wiki/Different_syntax_highlighting_within_regions_of_a_file#Extended_version
  • Loading branch information
ypid committed Jul 12, 2016
1 parent 95c87b5 commit 8c1a660
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/fold-markers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ So to use folds in your files, you basally have two options:
# :local:
# First heading [[[
# -------------
# -----------------
# .. envvar:: example__list
#
Expand All @@ -63,7 +63,7 @@ So to use folds in your files, you basally have two options:
# .. ]]]
# Second heading [[[1
# --------------
# -------------------
#
Both variants have their pros and cons and both are supported by `yaml2rst`, so
Expand Down

0 comments on commit 8c1a660

Please sign in to comment.