Skip to content

Commit

Permalink
Edit README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xiota committed Dec 14, 2016
1 parent 49a52fa commit 179a289
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
Binary file modified geanypy-preview/README-config-gui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified geanypy-preview/README-geany.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified geanypy-preview/README-plugins.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 14 additions & 2 deletions geanypy-preview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ Additionally:
* The generated HTML can be saved to file. Right click in the Preview window and select "Save As...".


## Usage

* Once installed, operation should be automatic with reasonable defaults. The Preview tab will be available in the sidebar.

* The preview panel can be used as a rudimentary web browser. Previews are suspended while browsing. To resume previews, clear the location bar.

* For convenience, the Preview window can be scrolled to the approximate caret location in the source document by right clicking the preview window and selecting "Sync Position". At this time, positioning is not precise and the Preview may need to be further scrolled up or down to find the desired text.

* The generated Preview may be saved as an HTML document by right clicking the preview window and selecting "Save As..."


## Installation

* Copy `preview.py` to the geany plugins directory (`~/.config/geany/plugins/`).
Expand All @@ -42,13 +53,13 @@ Additionally:

![][img-plugins]

* Once enabled, operation is automatic. Settings may be changed, though defaults should be reasonable.

[img-plugins]: README-plugins.png


## Configuration

In the menubar, select Edit | Plugin Preferences | Preview:

![][img-config-gui]

[img-config-gui]: README-config-gui.png
Expand Down Expand Up @@ -113,6 +124,7 @@ Additionally:
- This tends to occur if default_filetype is set to something other than `plain`.
- This is more likely to occur with slow processors, like `asciidoc`. Use `asciidoctor` instead.

* "Sync Position" is not exact. The Preview may need to be further scrolled up or down to find the desired text.

## Requirements

Expand Down

0 comments on commit 179a289

Please sign in to comment.