Skip to content

Commit

Permalink
Testing differen header level formats to see how they render on github.
Browse files Browse the repository at this point in the history
  • Loading branch information
aaker committed Aug 7, 2013
1 parent bf42469 commit 6a14ca3
Showing 1 changed file with 9 additions and 16 deletions.
25 changes: 9 additions & 16 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ facility in Emacs:

![screenshot](https://github.com/alpaker/Fill-Column-Indicator/raw/master/FciScreenshot.png)

Please Note
-----------
## Please Note

There is a small incompatibility between this package and the current stable
Emacs relase (v24.3). See [issue #31](https://github.com/alpaker/Fill-Column-Indicator/issues/31) for more
information.

Installation and Usage
----------------------
## Installation and Usage


Put the package file in your load path and put

Expand All @@ -24,8 +23,7 @@ in your .emacs.
To toggle graphical indication of the fill column in a buffer, use the
command `fci-mode`.

Configuration
-------------
## Configuration

* By default fci-mode draws a vertical line at the fill column. If you'd
like it to be drawn at a different location, set `fci-rule-column` to the
Expand Down Expand Up @@ -66,8 +64,7 @@ These variables (as well as those in the next section) can be given
buffer-local bindings.


Other Options
-------------
## Other Options

When `truncate-lines` is nil, the effect of drawing a fill-column rule is
very odd looking. Indeed, it makes little sense to use a rule to indicate
Expand All @@ -94,8 +91,7 @@ Use Area of the Unicode BMP, viz. U+E000 and U+E001. If you need to use
those characters for some other purpose, set `fci-eol-char` and
`fci-blank-char` to different values.

Troubleshooting
---------------
# Troubleshooting

* Fci-mode is intended to be used with monospaced fonts. If you're using
a monospaced font and the fill-column rule is missing or misaligned on a
Expand All @@ -114,8 +110,7 @@ Troubleshooting

(setq whitespace-style '(face trailing))

Known Issues
------------
## Known Issues

* The indicator extends only to end of the buffer contents (as opposed to
running the full length of the editing window).
Expand All @@ -140,8 +135,7 @@ Known Issues
which can be downloaded from this page. Directions for its use are given
in the file header.

Todo
----
### Todo

* Accommodate non-nil values of `hl-line-sticky-flag` and similar cases.

Expand All @@ -150,8 +144,7 @@ Todo
* Compatibility with non-nil `show-trailing-whitespace`.


Acknowledgements
----------------
#### Acknowledgements

Thanks to Ami Fischman, Christopher Genovese, Michael Hoffman, José Alfredo
Romero L., R. Lange, Joe Lisee, José Lombera, Frank Meffert, Mitchell
Expand Down

0 comments on commit 6a14ca3

Please sign in to comment.