https://github.com/izumin5210/ohp
OHP is Hacker's Presentation writer with Markdown and CSS
https://github.com/izumin5210/ohp
electron presentation presentation-tools react redux remark-plugin slideshow slideshow-maker
Last synced: about 1 month ago
JSON representation
OHP is Hacker's Presentation writer with Markdown and CSS
- Host: GitHub
- URL: https://github.com/izumin5210/ohp
- Owner: izumin5210
- License: mit
- Created: 2017-05-03T09:45:14.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-11T00:26:35.000Z (almost 8 years ago)
- Last Synced: 2025-04-09T05:38:15.332Z (about 1 month ago)
- Topics: electron, presentation, presentation-tools, react, redux, remark-plugin, slideshow, slideshow-maker
- Language: JavaScript
- Homepage: https://github.com/izumin5210/OHP
- Size: 1.36 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# OHP
[](https://travis-ci.org/izumin5210/OHP)
[][license]
OHP is Hacker's Presentation writer with Markdown and CSS
## Usage
### Frontmatter
- `fontSize` (`number?`) - Font size (default: `36`)
- `page` - Default configuration for each pages
- `className` (`string?`) - Default class(es)
- `pageNumber` - Default configuration for page numbers
- `enable` (`boolean?`) - Whether to render the page numbers (default: `false`)
- `className` (`string?`) - Class(es) of page number elements (default: `pageNumber`)
- `number` (`number?`) - Pgae number for the first page (default: `1`)
#### Example
```markdown
---
fontSize: 32
page:
className: page
pageNumber:
enable: true
---
# Title
```
### Comment directives
#### ``
##### Example
```markdown
# Page 1
# Page 2
```
#### ``
##### `options`
- `className` (`string?`) - Class(es) of the page element
#### Example
```markdown
# Title
# Table of Contents
```
#### ``
##### `options`
- `enable` (`boolean?`) - Whether to render the page number to the current page
- `className` (`string?`) - Class(es) of the page number element
- `number` (`number?`) - Number to render to this page
##### Example
```markdown
# Title
# Table of Contents
```
### Keyboard Shortcuts
| Windows/Linux | Mac | Action |
| --- | --- | --- |
| Ctrl+Enter | Cmd+Enter | Insert `` |
## Sample
- [[source](https://gist.github.com/izumin5210/b4a61ed5003b1666dfe8ecd5baf683f1)] [Performance of rendering over 10k items using React // Speaker Deck](https://speakerdeck.com/izumin5210/performance-of-rendering-over-10k-items-using-react)
## Development
```
# Run `yarn install` and `lerna bootstrap`
$ yarn bootstrap
# Start webpack-dev-server and electron
$ yarn start:dev
# Or, run `yarn start:dev:app` and `yarn start:dev:server`
```
## License
Licensed under [MIT License][license].
[license]: ./LICENSE