/harp-github-markdown

Harp Boilerplate for Github Flavored Markdown

Primary LanguageCSSMIT LicenseMIT

Overview

If you enjoy my Google Workspace Apps Script work, please consider buying me a cup of coffee!


Harp Boilerplate which uses the css styling from the github-markdown-css project.

Helpful for viewing/testing Github Flavored Markdown.

Getting Started

Read the Harp Quick Start Guide to install and get started with Harp.

To use this project as a boilerplate see the docs.

Example:

harp init docs --boilerplate techstreams/harp-github-markdown
harp server docs

Edit the markdown in the public/index.md file and save. Edit the harp.json file to change the title.

Visit localhost:9000 in your browser to view.

Note

This boilerplate uses ejs for the layout template. To use jade, substitute the following code in public/_layout.ejs and rename it to _layout.jade

_layout.jade

doctype
html
  head
    meta(charset='utf-8')
    meta(name='viewport', content='width=device-width, initial-scale=1, minimal-ui')
    title
    link(rel='stylesheet', href='css/github-markdown.css')
    style.
      body {
      min-width: 200px;
      max-width: 790px;
      margin: 0 auto;
      padding: 30px;
      }
  body
    article.markdown-body
      != yield

Credits

License

CSS is licensed MIT © Sindre Sorhus

Project is licensed MIT © Laura Taylor