From 152e065c00e19263e31770f8569caa1ce46f6722 Mon Sep 17 00:00:00 2001 From: Jannis Baum Date: Tue, 25 Jul 2023 16:42:03 +0200 Subject: [PATCH 1/4] change(#5): adjust archive name --- .github/workflows/ci.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 01185d92..a111ba41 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -28,8 +28,8 @@ jobs: - name: package if: startsWith(github.ref, 'refs/tags/v') run: | - zip -r vivify-macos-${{ github.ref_name }}.zip bin/macos/* - zip -r vivify-linux-${{ github.ref_name }}.zip bin/linux/* + zip -r vivify-macos.zip bin/macos/* + zip -r vivify-linux.zip bin/linux/* - name: release if: startsWith(github.ref, 'refs/tags/v') uses: softprops/action-gh-release@v1 From acbc345e5cc5c1cd86a4fe72d0e1497a3108c737 Mon Sep 17 00:00:00 2001 From: Jannis Baum Date: Tue, 25 Jul 2023 22:29:41 +0200 Subject: [PATCH 2/4] dev(#5): start versioning at 0.0.1 --- release.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release.sh b/release.sh index d5230170..fed70399 100755 --- a/release.sh +++ b/release.sh @@ -5,7 +5,7 @@ if [ "$1" != "minor" -a "$1" != "major" ]; then exit 1 fi -version="v0.0.0" +version="v0.0.1" prev=$(git tag --sort=version:refname | tail -1) if [ -n "$prev" ]; then From b34371b8b41943d5b0477e2a32cb638ea3761879 Mon Sep 17 00:00:00 2001 From: Jannis Baum <85999315+jannis-baum@users.noreply.github.com> Date: Fri, 4 Aug 2023 10:44:21 +0200 Subject: [PATCH 3/4] docs(#5): issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 10 ++++++++ .github/ISSUE_TEMPLATE/question.md | 10 ++++++++ 3 files changed, 51 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..5a860c01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,31 @@ +--- +name: "🪲 Bug report" +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +### Describe the bug + +A clear and concise description of what the bug is. + +### To Reproduce + +Steps to reproduce the behavior: + +1. Use version ... +2. + +### Expected behavior + +A clear and concise description of what you expected to happen. + +### Screenshots + +If applicable, add screenshots to help explain your problem. + +### Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..e3c955b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,10 @@ +--- +name: "✨ Feature request" +about: Suggest an idea for this project +title: '' +labels: feature +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..d1619a7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: "👀 Question" +about: Ask something +title: '' +labels: question +assignees: '' + +--- + + From cbcb3a723075cdc56d05d81da15dd4bc8a75d45f Mon Sep 17 00:00:00 2001 From: Jannis Baum Date: Fri, 4 Aug 2023 11:00:59 +0200 Subject: [PATCH 4/4] docs(#5): minimal readme & contributing --- CONTRIBUTING.md | 10 ++++++++ README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7636d9b4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing to Vivify + +Contributions are very welcome! If you would like to contribute, please make +sure you follow the steps below: + +- Make sure there is an issue corresponding to what you are working on +- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) + with `#` as the context for all commits +- Make sure you are not adding any merge commits to your branch +- Open a pull request & wait for a review!🩵 diff --git a/README.md b/README.md new file mode 100644 index 00000000..85ee6656 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +# Vivify + +Vivify brings your (Markdown) files to life in the browser! + +## Features + +- various [Markdown features](#markdown) +- links to other files: [relative links like in + GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#relative-links) + as well as absolute file links +- view non-markdown files with code syntax highlighting +- view & navigate directories, hidden "back to parent directory" button at the + top-left of the file viewer +- easy to integrate with any editor for live synchronization (see [editor + support](#editor-support)) +- Vivify server starts lazily and automatically shuts down when no more viewers + are connected + +### Markdown + +- heading/anchor links +- GitHub emojis `:smile:` +- full Katex math support +- GitHub task-lists +- syntax highlighting for code + +If you need any additional features, feel free to [open an +issue](https://github.com/jannis-baum/vivify/issues/new/choose) or +[contribute](CONTRIBUTING.md)! + +## Usage + +- download & unpack the latest release for your system (macOS or Linux) +- add the two executables to your `$PATH` +- run `viv ` to view `` + +## Editor Support + +Vivify has a simple API to integrate your favorite editor so the viewer live +updates to any changes as you are typing and the scrolling is smoothly +synchronized! + +See below for a list of existing editor plugins. In case your favorite editor is +not yet supported, use these as an example to write your own and add it to the +list! + +### Existing integration + +- for Vim: [vivify.vim](https://github.com/jannis-baum/vivify.vim) + +## Get help + +Is something not working or do you have any questions? [Open an +issue](https://github.com/jannis-baum/vivify/issues/new/choose)! + +## Acknowledgments + +I have been using +[iamcco/markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim) +for the longest time and started this project because + +1. I wanted a Markdown viewer that works without Vim and +2. I wanted a Markdown viewer that supports file links like in GitHub. + +Looking at +[iamcco/markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim) +helped in development, particularly with regard to which `npm` packages to use.