Add site metadata
This commit is contained in:
parent
624f47911d
commit
32d4479bac
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
build
|
50
Makefile
Normal file
50
Makefile
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
appname := md2vim
|
||||||
|
sources := $(wildcard *.go)
|
||||||
|
|
||||||
|
build = GOOS=$(1) GOARCH=$(2) go build -o build/$(appname)$(3)
|
||||||
|
tar = cd build && tar -cvzf $(appname)_$(1)_$(2).tar.gz $(appname)$(3) && rm $(appname)$(3)
|
||||||
|
zip = cd build && zip $(appname)_$(1)_$(2).zip $(appname)$(3) && rm $(appname)$(3)
|
||||||
|
|
||||||
|
.PHONY: all windows darwin linux clean
|
||||||
|
|
||||||
|
all: windows darwin linux
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -rf build/
|
||||||
|
|
||||||
|
# linux builds
|
||||||
|
linux: build/$(appname)_linux_arm.tar.gz build/$(appname)_linux_arm64.tar.gz build/$(appname)_linux_386.tar.gz build/$(appname)_linux_amd64.tar.gz
|
||||||
|
|
||||||
|
build/$(appname)_linux_386.tar.gz: $(sources)
|
||||||
|
$(call build,linux,386,)
|
||||||
|
$(call tar,linux,386)
|
||||||
|
|
||||||
|
build/$(appname)_linux_amd64.tar.gz: $(sources)
|
||||||
|
$(call build,linux,amd64,)
|
||||||
|
$(call tar,linux,amd64)
|
||||||
|
|
||||||
|
build/$(appname)_linux_arm.tar.gz: $(sources)
|
||||||
|
$(call build,linux,arm,)
|
||||||
|
$(call tar,linux,arm)
|
||||||
|
|
||||||
|
build/$(appname)_linux_arm64.tar.gz: $(sources)
|
||||||
|
$(call build,linux,arm64,)
|
||||||
|
$(call tar,linux,arm64)
|
||||||
|
|
||||||
|
# darwin builds
|
||||||
|
darwin: build/$(appname)_darwin_amd64.tar.gz
|
||||||
|
|
||||||
|
build/$(appname)_darwin_amd64.tar.gz: $(sources)
|
||||||
|
$(call build,darwin,amd64,)
|
||||||
|
$(call tar,darwin,amd64)
|
||||||
|
|
||||||
|
# windows builds
|
||||||
|
windows: build/$(appname)_windows_386.zip build/$(appname)_windows_amd64.zip
|
||||||
|
|
||||||
|
build/$(appname)_windows_386.zip: $(sources)
|
||||||
|
$(call build,windows,386,.exe)
|
||||||
|
$(call zip,windows,386,.exe)
|
||||||
|
|
||||||
|
build/$(appname)_windows_amd64.zip: $(sources)
|
||||||
|
$(call build,windows,amd64,.exe)
|
||||||
|
$(call zip,windows,amd64,.exe)
|
23
README.md
23
README.md
@ -1,3 +1,12 @@
|
|||||||
|
<!-- +++
|
||||||
|
Area = "projects"
|
||||||
|
GitHub = "md2vim"
|
||||||
|
Layout = "page"
|
||||||
|
Tags = ["blackfriday", "golang", "markdown", "md2vim", "vim", "mit license"]
|
||||||
|
Description = "Tool for automatically converting markdown to vimdoc format."
|
||||||
|
Collection = "ProjectsComplete"
|
||||||
|
+++ -->
|
||||||
|
|
||||||
# Md2Vim
|
# Md2Vim
|
||||||
|
|
||||||
Writing technical documentation for Vim extensions is not exciting; manually converting what you've just written in
|
Writing technical documentation for Vim extensions is not exciting; manually converting what you've just written in
|
||||||
@ -7,8 +16,8 @@ repeatedly for my [Vim-ArgWrap](https://foosoft.net/projects/vim-argwrap/) exten
|
|||||||
problem with a purpose-built tool. Maintainability, ease of use, and beautiful vimdoc output were primary considerations
|
problem with a purpose-built tool. Maintainability, ease of use, and beautiful vimdoc output were primary considerations
|
||||||
in Md2Vim's design.
|
in Md2Vim's design.
|
||||||
|
|
||||||
[![Markdown source file](https://foosoft.net/projects/md2vim/img/markdown-thumb.png)](https://foosoft.net/projects/md2vim/img/markdown.png)
|
[![Markdown source file](img/markdown-thumb.png)](img/markdown.png)
|
||||||
[![VimDoc target file](https://foosoft.net/projects/md2vim/img/vimdoc-thumb.png)](https://foosoft.net/projects/md2vim/img/vimdoc.png)
|
[![VimDoc target file](img/vimdoc-thumb.png)](img/vimdoc.png)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -18,15 +27,7 @@ If you already have the Go environment and toolchain set up, you can get the lat
|
|||||||
$ go get github.com/FooSoft/md2vim
|
$ go get github.com/FooSoft/md2vim
|
||||||
```
|
```
|
||||||
|
|
||||||
Otherwise, you can use the pre-built binaries for the platforms below:
|
Otherwise, you can use the [pre-built binaries](https://github.com/FooSoft/md2vim/releases) from the project page.
|
||||||
|
|
||||||
* [md2vim\_darwin\_386.tar.gz](https://foosoft.net/projects/md2vim/dl/md2vim_darwin_386.tar.gz)
|
|
||||||
* [md2vim\_darwin\_amd64.tar.gz](https://foosoft.net/projects/md2vim/dl/md2vim_darwin_amd64.tar.gz)
|
|
||||||
* [md2vim\_linux\_386.tar.gz](https://foosoft.net/projects/md2vim/dl/md2vim_linux_386.tar.gz)
|
|
||||||
* [md2vim\_linux\_amd64.tar.gz](https://foosoft.net/projects/md2vim/dl/md2vim_linux_amd64.tar.gz)
|
|
||||||
* [md2vim\_linux\_arm.tar.gz](https://foosoft.net/projects/md2vim/dl/md2vim_linux_arm.tar.gz)
|
|
||||||
* [md2vim\_windows\_386.tar.gz](https://foosoft.net/projects/md2vim/dl/md2vim_windows_386.tar.gz)
|
|
||||||
* [md2vim\_windows\_amd64.tar.gz](https://foosoft.net/projects/md2vim/dl/md2vim_windows_amd64.tar.gz)
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
BIN
img/markdown-thumb.png
Normal file
BIN
img/markdown-thumb.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 12 KiB |
BIN
img/markdown.png
Normal file
BIN
img/markdown.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 39 KiB |
BIN
img/vimdoc-thumb.png
Normal file
BIN
img/vimdoc-thumb.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
BIN
img/vimdoc.png
Normal file
BIN
img/vimdoc.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 37 KiB |
Loading…
Reference in New Issue
Block a user