Viewer is a simple Electron-based application for viewing rendered output of Markdown files within a given directory structure, with strong emphasis on security, content and context isolation, and a consistent user experience.
- Standardized Markdown Rendering: Renders Markdown into easily readable HTML using Remarkable, a fast Markdown parser.
- Dynamic File Browser: The custom dynamic recursive file browser handles complex directory structures with an intuitive tree hierarchy identifier.
- System Theme Support: Auto-detects system theme (light / dark) for a consistent user experience.
- Security: Utilizes optimal security practices to isolate content from all external sources. All links are by default opened by the operating system's default browser.
- Configurable: Can be configured to load a default directory at start-up.
- Consistent UI: Uses publicly available high-quality typography for exceptional readability in all conditions.
- Installation from Source
- Download the git repository
git clone https://github.com/pratikmullick/Viewer.git - Install dependencies
npm install - Run
npm start
- Download the git repository
Viewer can be configured to load a default directory when the application starts. Given below are the steps to pre-configure the application:
- Create a directory named
.viewerin your home directory- Windows:
%USERPROFILE%\.viewer - UNIX:
~/.viewer
- Windows:
- Create a file named
config.jsoninside the user directory. - Add the following JSON structure to
config.json, replacing the path value to the path of an actual directory containing Markdown files:{ "default_directory": "<path/to/default/directory>" }
Further contributions are welcome from other users. Please submit a pull request with your contributions. If you detect issues, you are more than welcome to submit them on the Issues tracker.
This software is licensed under the GNU GENERAL PUBLIC LICENSE Version 3. For more information, refer to the LICENSE file attached herewith.