Configuration
The GFM viewer plugin should work adequately without further configuration, however its operation may be customized via menu Window -> Preferences -> GFM Viewer. On that dialog page, properties may be set as follows:
- Use Temp dir: by default formatted HTML files are stored in the original markdown file's directory, thus enabling relative local links to images to work properly; select this option to instead have them in the user's temporary directory
- API URL: specifies an alternate URL for GitHub API calls (typically for corporate users only)
- Username/Password: a limit of 60 updates per hour is imposed by GitHub for unauthenticated usage of their markdown rendering API, so provide GitHub credentials in these fields to have this limit raised, see here for background
- Template File: an alternate HTML template file to the default may be provided
- CSS URL 1-3: an alternate CSS presentation to the default may be provided
- JS URL 1-3: an alternate JS implementation to the default may be provided
Regarding the temporary formatted HTML files, when stored in the original markdown file directory note:
- You may wish to add the exclusion pattern
.*.md.html to your projects .gitignore file, which will prevent their inclusion in version control operations
- You can manage the visibility of these files in Eclipse tree views via the View menu (small triangle icon in top right of view), then select the Filters... entry, and then set or clear the .* resources check box