Giter Club home page Giter Club logo

markdown-buildpack's Introduction

Cloud Foundry Markdown Buildpack

This buildpack allows you to seamlessly publish Markdown pages to a Cloud Foundry platform: these files are automatically converted to HTML pages.

Just include this buildpack in your app manifest:

---
applications:
  - name: appname
    memory: 64MB
    disk_quota: 100MB
    buildpacks:
      - https://github.com/alexandreroman/markdown-buildpack.git

Use environment variable MARKDOWN_STYLESHEET to specify which CSS stylesheet to include:

---
applications:
  - name: appname
    memory: 64MB
    disk_quota: 100MB
    env:
      MARKDOWN_STYLESHEET: "https://raw.githubusercontent.com/sindresorhus/github-markdown-css/gh-pages/github-markdown.css"
    buildpacks:
      - https://github.com/alexandreroman/markdown-buildpack.git

Add environment variable MARKDOWN_TOC with value set to 1 to generate a table of contents.

---
applications:
  - name: appname
    env:
      MARKDOWN_TOC: 1
    buildpacks:
      - https://github.com/alexandreroman/markdown-buildpack.git

This project is using Pandoc to convert Markdown to HTML.

Feel free to contribute!

Copyright (c) 2018 Pivotal Software, Inc. Licensed under the Apache License, Version 2.0.

markdown-buildpack's People

Contributors

alexandreroman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.