Git Product home page Git Product logo

goldmark-pikchr's Introduction

Go Reference Go

goldmark-pikchr is an extension for the goldmark Markdown parser that adds support for pikchr diagrams.

Usage

To use goldmark-pikchr, import the pikchr package.

import pikchr "github.com/jchenry/goldmark-pikchr"

Then include the pikchr.Extender in the list of extensions you build your goldmark.Markdown with.

goldmark.New(
  &pikchr.Extender{}
  // ...
).Convert(src, out)

The package supports pikchr diagrams inside fenced code blocks with the language pikchr. For example,

```pikchr
arrow right 200% "Markdown" "Source"
box rad 10px "Markdown" "Formatter" "(markdown.c)" fit
arrow right 200% "HTML+SVG" "Output"
arrow <-> down 70% from last box.s
box same "Pikchr" "Formatter" "(pikchr.c)" fit
```

When you render the Markdown as HTML, these will be replaced with SVG blocks. pikchr will render these into diagrams client-side.

Code is based on github.com/abhinav/goldmark-mermaid and licensed under the same terms.

goldmark-pikchr's People

Contributors

abhinav avatar jchenry avatar outofbedlam avatar

Stargazers

 avatar  avatar  avatar  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.