finish the first release

vipzhicheng · Jul 14, 2022 · 2f915f1 · 2f915f1
1 parent 2611c54
commit 2f915f1
Show file tree

Hide file tree

Showing 17 changed files with 306 additions and 810 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -7,7 +7,7 @@ on:
       - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
 
 env:
-  PLUGIN_NAME: logseq-plugin-starter-vite-publish
+  PLUGIN_NAME: logseq-plugin-block-calendar
 
 jobs:
   build:

diff --git a/README.md b/README.md
@@ -1,22 +1,31 @@
-# Logseq Plugin Starter
+# Logseq Block Calendar
 
-[![Github All Releases](https://img.shields.io/github/downloads/vipzhicheng-starter/logseq-plugin-starter-vite/total.svg)](https://github.com/vipzhicheng-starter/logseq-plugin-starter-vite/releases)
+[![Github All Releases](https://img.shields.io/github/downloads/vipzhicheng/logseq-plugin-block-calendar/total.svg)](https://github.com/vipzhicheng/logseq-plugin-block-calendar/releases)
 
-A Logseq plugin starter based on vite and tailwindcss.
+A plugin to render a calendar in block, so you can put it onto right side bar.
 
-## What's in it.
+![screencast](./screencast.gif)
 
-* Just a hello world for now.
-* No vue/react included.
+## Features
 
-## How to use it.
+* Click date to jump to journal page.
+* Switch month back and forth.
+* Set back to today's month.
+* Show if journal page exist by showing a red dot.
+* Support setting first day of week.
 
-1. Clone
-2. Run `npm install`
-3. Run `npm run build`
-4. In logseq, click `Plugins` which is in right top dropdown menu
-5. Click `Load unpacked plugin` button and select the `dist` sub directory.
-6. If plugin not work, you can try to disable and enable the plugin by clicking the switch button on Plugins page.
+## Usage
+
+- Slash command `/Insert Block Calendar`  to insert a calendar
+- `{{renderer block-calender:RandomID, [2022], [7], [en], [nohead|nonav]}}`
+  - `[2022]`, `[7]`, `[en]` is optional.
+  - Only support `zh-CN` and `en` language, PR is welcome.
+  - `nohead` means do not have table head, so no month and year and month switcher.
+  - `nonav` means still have month and year, but no month switcher.
+
+## ❤️ Buy me a coffee
+
+If you like this plugin and you will, you can choose to buy me a coffee via [this](https://www.buymeacoffee.com/vipzhicheng) and [this](https://afdian.net/@vipzhicheng), that means a lot to me.
 
 ## Licence
 MIT
diff --git a/icon.png b/icon.png
diff --git a/index.html b/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Starter</title>
+    <title>Block Calendar</title>
   </head>
   <body class="w-full h-screen bg-red-200 flex justify-center items-center">
     <div id="app"></div>

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "logseq-plugin-block-calendar",
   "version": "0.0.1",
-  "description": "",
+  "description": "A plugin to render a calendar in block, so you can put it onto right side bar.",
   "main": "index.html",
   "scripts": {
     "dev": "vite dev",
@@ -11,19 +11,15 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@vitejs/plugin-vue": "^2.3.3",
-    "autoprefixer": "^10.4.7",
-    "postcss": "^8.4.14",
-    "tailwindcss": "^3.1.3",
     "typescript": "^4.7.4",
     "vite": "^2.9.12",
-    "vite-plugin-logseq": "^1.1.2",
-    "vue-tsc": "^0.38.1"
+    "vite-plugin-logseq": "^1.1.2"
   },
   "dependencies": {
     "@logseq/libs": "^0.0.6",
     "date-fns": "^2.28.0",
-    "vue": "^3.2.37"
+    "dayjs": "^1.11.3",
+    "uuid": "^8.3.2"
   },
   "logseq": {
     "id": "logseq-plugin-block-calendar",
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ on: @@
           - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
     env:
-      PLUGIN_NAME: logseq-plugin-starter-vite-publish
+      PLUGIN_NAME: logseq-plugin-block-calendar
     jobs:
       build:
@@ Expand Down @@