Giter VIP home page Giter VIP logo

cutedoc's Introduction

cutedoc

cutedoc

Cutedoc is a simple command line tool that allows you to generate beautiful static documentation using simple markdown files. You can learn more about the project at https://nickthedev.github.io/cutedoc.

Getting Started

If you already have Go installed, you can easily grab the latest version of Cutedoc by using the go get command in the console. If your GOPATH/bin env variable is set, the cutedoc command will be accessible without having to specify the executable path.

$ go get github.com/NickTheDev/cutedoc/cmd/cutedoc

If you do not have or wish to install Go, you can grab a pre-built binary from Github. However, with this method you will have to optionally add the executable to your env variables yourself.

Demo

Cutedoc's documentation was created with Cutedoc, and can be found at https://nickthedev.github.io/cutedoc/docs.

cutedoc's People

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.