OHP is Hacker's Presentation writer with Markdown and CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
flow-typed
packages
.babelrc
.eslintignore
.eslintrc.yml
.flowconfig
.gitignore
.jestrc.json
.travis.yml
CHANGELOG.md
LICENSE
README.md
lerna.json
package.json
yarn.lock

README.md

OHP - OHP is Hacker's Presentation writer with Markdown and CSS

OHP

Build Status MIT 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

---
fontSize: 32
page:
  className: page
pageNumber:
  enable: true
---

# Title

Comment directives

<!-- newpage -->

Example
# Page 1

<!-- newpage -->

# Page 2

<!-- page [options] -->

options
  • className (string?) - Class(es) of the page element

Example

<!-- page className="title" -->
# Title

<!-- newpage -->
<!-- page className="toc" -->
# Table of Contents

<!-- pageNumber [options] -->

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
<!-- pageNumber enable=false -->
# Title

<!-- newpage -->
<!-- pageNumber number=1 className="toc__pageNumber" -->
# Table of Contents

Keyboard Shortcuts

Windows/Linux Mac Action
Ctrl+Enter Cmd+Enter Insert <!-- newpage -->

Sample

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.