Giter VIP home page Giter VIP logo

godoc2md's Introduction

godoc2md

import "github.com/WillAbides/godoc2md"

Package godoc2md creates a markdown representation of a package's godoc.

This is forked from https://github.com/davecheney/godoc2md. The primary difference being that this version is a library that can be used by other packages.

commandline.go comment.go godoc2md.go template.go

func Godoc2md(args []string, out io.Writer, config *Config)

Godoc2md turns your godoc into markdown

type Config struct {
    AltPkgTemplate    string
    SrcLinkHashFormat string
    SrcLinkFormat     string
    Goroot            string
    TabWidth          int
    ShowTimestamps    bool
    ShowPlayground    bool
    ShowExamples      bool
    DeclLinks         bool
    Verbose           bool
}

Config contains config options for Godoc2md

godoc2md's People

Contributors

davecheney avatar dsymonds avatar kenjones-cisco avatar kimor79 avatar lordnynex avatar melekes avatar willabides avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

jaicewizard miekg

godoc2md's Issues

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.