Skip to content

Commit

Permalink
First release
Browse files Browse the repository at this point in the history
  • Loading branch information
Quorafind committed Jul 12, 2022
1 parent 0235190 commit ac79efd
Show file tree
Hide file tree
Showing 16 changed files with 1,185 additions and 264 deletions.
674 changes: 674 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

51 changes: 22 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,36 @@
# obsidian-react-starter
# Obsidian Table Generator

A starter template for creating an Obsidian plugin with SvelteJS.
A plugin for generate markdown table quickly like Typora.

![example](https://raw.githubusercontent.com/quorafind/obsidian-table-generator/master/media/example.mp4)

# Features

This project comes preconfigured with [Typescript](https://www.typescriptlang.org/), [vite](https://vitejs.dev), and
[Rollup.js](https://rollupjs.org).
- You can use `obsidian-table-generator` to generate markdown table quickly.

# Settings

- You can set the default table rows/columns.

## How to Install

# Getting Started
### From Plugin Market in Obsidian

Click "use this template" to create your own fork of this repo. Make sure to reference the official sample plugin for
information about how to get started with the Obsidian API and how to submit your plugin to the Community Plugin
Gallery.
💜: [Not available now] Directly install from Obsidian Market.

```bash
# for local development
npm install
npm run dev
// Or yarn dev
### From BRAT

# for a production bundle
npm install
npm run build
// Or yarn build
🚗: Add `Quorafind/Obsidian-Table-Generator` to BRAT.

# change version
npm bumpversion
// Or yarn bumpversion
```
### Download Manually

# Stats
🚚: Download the latest release. Extract and put the three files (main.js, manifest.json, styles.css) to
folder `{{obsidian_vault}}/.obsidian/plugins/Obsidian-Table-Generator`.

The production output of this sample plugin is ~10 KB.
## Say Thank You

```
./styles.css 0.44 KiB / gzip: 0.19 KiB
./main.js 12.63 KiB / gzip: 3.70 KiB
```
If you are enjoy using Obsidian-Table-Generator then please support my work and enthusiasm by buying me a coffee
on [https://www.buymeacoffee.com/boninall](https://www.buymeacoffee.com/boninall).

## API Documentation
<a href="https://www.buymeacoffee.com/boninall"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=boninall&button_colour=6495ED&font_colour=ffffff&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00"></a>

See https://github.com/obsidianmd/obsidian-api
10 changes: 5 additions & 5 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"id": "obsidian-svelte-starter",
"name": "Svelte Starter",
"version": "1.0.3",
"id": "obsidian-table-generator",
"name": "Table Generator",
"version": "1.1.0",
"minAppVersion": "0.12.0",
"description": "A plugin development template for devs who want to use svelte in Obsidian.",
"description": "A plugin for generate markdown table quickly like Typora.",
"author": "Quorafind",
"authorUrl": "https://obsidian.md",
"authorUrl": "https://github.com/Quorafind",
"isDesktopOnly": false
}
Binary file added media/example.mp4
Binary file not shown.
9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
{
"name": "obsidian-svelte-starter",
"version": "1.0.3",
"description": "A plugin development template for devs who want to use svelte in Obsidian.",
"name": "obsidian-table-generator",
"version": "1.1.0",
"description": "A plugin for generate markdown table quickly like Typora.",
"main": "main.js",
"scripts": {
"lint": "eslint . --ext .ts",
"dev": "npm run lint && vite build --watch ",
"build": "npx svelte-check && vite build",
"build": "npx svelte-check && vite build --mode=production",
"bumpversion": "node version-bump.mjs && git add manifest.json versions.json"
},
"keywords": [],
"License": "GPL-3.0-or-later",
"author": "Quorafind",
"devDependencies": {
"@sveltejs/vite-plugin-svelte": "^1.0.0-next.49",
Expand Down
129 changes: 0 additions & 129 deletions src/starterIndex.ts

This file was deleted.

Loading

0 comments on commit ac79efd

Please sign in to comment.