Git Product home page Git Product logo

wing's Introduction

Wing

Convert github markdown with mermaid diagrams to beautiful PDF

Requirements

  • PhantomJS

Installation

gem install wing

Usage

Creating new project

mkdir my-doc
cd my-doc
wing init

Generating PDF

wing gen

Embedding diagrams

```diagram
graph LR
    A[Square Rect] -- Link text --> B((Circle))
    A --> C(Round Rect)
    B --> D{Rhombus}
    C --> D
```

Contributing

  1. Fork it ( https://github.com/monterail/wing/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

wing's People

Contributors

teamon avatar

Stargazers

Henry Zheng avatar

Watchers

Szymon Boniecki avatar Jan Dudulski avatar Grzegorz Hajdukiewicz avatar Kasia Tatomir-Rebeś avatar Michał Lipski avatar James Cloos avatar Karol Szolz avatar Jakub Cieślar avatar Michał Pawelski avatar Kamil Górski avatar Monterail avatar Konrad Korżel avatar Tomasz Jaworski avatar Peter Blackson avatar Adam Hodowany avatar Wojciech Stępniak avatar  avatar Kamil Nogala avatar Mateusz Pietrzyk avatar Robert M. Wysocki avatar Igor Leonenko avatar Szymon Lankauf avatar Tomasz Jamka avatar DT avatar Łukasz Potępa avatar Mateusz Karbowiak avatar Marta Gajowczyk avatar Szymon Korzeniowski avatar Adrian Lehmann avatar Alina Melnyk avatar Jacek Buczek avatar Marzena Kawa avatar Rafał Rybicki avatar Patrycja Margasińska avatar Paweł Hawrylak avatar Marcin Piwek avatar Paweł Licznar avatar  avatar  avatar Piotr Czarny avatar Lidia Karpińska avatar Paweł Kociubiński avatar Paweł Rosa avatar Mateusz Adamczyk avatar Hubert Jaruzal avatar Damian Rogulski avatar Patryk Waśko avatar Agnieszka Brzycka avatar Alicja Kujawa avatar Karolka avatar Rafał Skorupa avatar  avatar gkm avatar Katarzyna Kimel avatar  avatar  avatar  avatar Rafał Dzięgielewski avatar Ania Szoszkiewicz avatar Zura Iashvili avatar Jakub Zbąski avatar Janusz Kupras avatar Karol Mąkowski avatar Krzysztof Len avatar Michał Stachura avatar  avatar Paulina Nogala avatar Elżbieta Berger avatar Dawid Żukowski avatar Alice avatar  avatar

Forkers

rlugojr bvolders

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.