You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

30 lines
1.3 KiB
Markdown

## RemarkPortable
A simple and portable way of using **[Remark](https://github.com/gnab/remark)**, that doesn't require an internet connection. Decluttered `index.html` to make it easier to get an overview.
Also included all necessary files in the repo for easy setup after downloading / cloning.
---
### Getting Started
1. Download or clone this repo (you can also use the **[releases](https://github.com/BenTearzz/RemarkPortable/releases)** page).
2. Write your markdown in the `<textarea>` in `index.html` or in a local file.
3. That's it... now you just open `index.html` in a browser, click `load` and it should work.
---
When opening `index.html`, there'll be two buttons. One to load the HTML content currently in `textarea` and one to open up a local file and use that for presentations. Both buttons will dissappear when entering fullscreen.
---
For customization you can customize `style.css` to your needs. More customization options can be found on the **[Remark Wiki](https://github.com/gnab/remark/wiki/Formatting)**.
---
### Fonts
The fonts included (Ubuntu Mono, Yanone Kaffeesatz and Droid Serif) are all from Google Fonts, which are free to use, as stated **[here](https://fonts.google.com/about)**
>All the fonts in our catalog are free and open source, making beautiful type accessible to anyone for **any** project.