https://github.com/artyom/docr

Serve markdown documentation directly from git repository (no git needed).
https://github.com/artyom/docr

Last synced: about 11 hours ago
JSON representation

Serve markdown documentation directly from git repository (no git needed).

• Host: GitHub
• URL: https://github.com/artyom/docr
• Owner: artyom
• Created: 2014-07-25T18:43:15.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-08-27T19:58:41.000Z (about 10 years ago)
• Last Synced: 2024-06-20T17:54:14.564Z (5 months ago)
• Language: Go
• Size: 145 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**docr** renders markdown documentation found in given git repository directly from git blob store (works even on bare repositories without working copy).

	Usage of docr:

	  -bind="127.0.0.1:8080": address to listen

	  -ref="HEAD": reference (HEAD, refs/heads/develop, etc.)

	  -repo="./.git": path to repository root (.git directory)

To install, run:

	go install -u -v github.com/artyom/docr

then start by running command:

	docr -repo $GOPATH/src/github.com/artyom/docr/.git

and open this link:  in your browser, you'll

see this file.

Files with `.md` or `.markdown` suffixes are rendered to html, other files served unmodified.

**Note**: to make docr work on bare git repositories, you have to set `core.logAllRefUpdates = true` in your bare git repository and have at least one commit pushed after this change.