|
1 | | -## Obsidian Sample Plugin |
| 1 | +# Obsidian Excel to Markdown Table |
2 | 2 |
|
3 | | -This is a sample plugin for Obsidian (https://obsidian.md). |
| 3 | +An Obsidian plugin to paste Excel tables as Markdown tables in Obsidian editor. |
4 | 4 |
|
5 | | -This project uses Typescript to provide type checking and documentation. |
6 | | -The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does. |
| 5 | +## Demo |
7 | 6 |
|
8 | | -**Note:** The Obsidian API is still in early alpha and is subject to change at any time! |
| 7 | +You can paste the copied Excel date from the clipboard by using either |
9 | 8 |
|
10 | | -This sample plugin demonstrates some of the basic functionality the plugin API can do. |
11 | | -- Changes the default font color to red using `styles.css`. |
12 | | -- Adds a ribbon icon, which shows a Notice when clicked. |
13 | | -- Adds a command "Open Sample Modal" which opens a Modal. |
14 | | -- Adds a plugin setting tab to the settings page. |
15 | | -- Registers a global click event and output 'click' to the console. |
16 | | -- Registers a global interval which logs 'setInterval' to the console. |
| 9 | +1. Hotkey - `Crtl/Cmd + Shift + V` or |
| 10 | +2. Command Palette: `Ctrl/Cmd + P` > `Excel to Markdown` command |
17 | 11 |
|
18 | | -### First time developing plugins? |
| 12 | +## License |
| 13 | +[MIT](LICENSE) |
19 | 14 |
|
20 | | -Quick starting guide for new plugin devs: |
| 15 | +## Acknowledgements |
21 | 16 |
|
22 | | -- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). |
23 | | -- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. |
24 | | -- Install NodeJS, then run `npm i` in the command line under your repo folder. |
25 | | -- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. |
26 | | -- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. |
27 | | -- Reload Obsidian to load the new version of your plugin. |
28 | | -- Enable plugin in settings window. |
29 | | -- For updates to the Obsidian API run `npm update` in the command line under your repo folder. |
| 17 | + - [vscode-excel-to-markdown-table](https://github.com/csholmq/vscode-excel-to-markdown-table) |
| 18 | + - [copy-excel-paste-markdown](https://github.com/thisdavej/copy-excel-paste-markdown) |
30 | 19 |
|
31 | | -### Releasing new releases |
32 | | - |
33 | | -- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release. |
34 | | -- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible. |
35 | | -- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases |
36 | | -- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release. |
37 | | -- Publish the release. |
38 | | - |
39 | | -> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`. |
40 | | -> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json` |
41 | | -
|
42 | | -### Adding your plugin to the community plugin list |
43 | | - |
44 | | -- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md |
45 | | -- Publish an initial version. |
46 | | -- Make sure you have a `README.md` file in the root of your repo. |
47 | | -- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. |
48 | | - |
49 | | -### How to use |
50 | | - |
51 | | -- Clone this repo. |
52 | | -- `npm i` or `yarn` to install dependencies |
53 | | -- `npm run dev` to start compilation in watch mode. |
54 | | - |
55 | | -### Manually installing the plugin |
56 | | - |
57 | | -- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. |
58 | | - |
59 | | -### Improve code quality with eslint (optional) |
60 | | -- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. |
61 | | -- To use eslint with this project, make sure to install eslint from terminal: |
62 | | - - `npm install -g eslint` |
63 | | -- To use eslint to analyze this project use this command: |
64 | | - - `eslint main.ts` |
65 | | - - eslint will then create a report with suggestions for code improvement by file and line number. |
66 | | -- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder: |
67 | | - - `eslint .\src\` |
68 | | - |
69 | | - |
70 | | -### API Documentation |
71 | | - |
72 | | -See https://github.com/obsidianmd/obsidian-api |
0 commit comments