mirror of
https://github.com/ycnmhd/obsidian-lineage.git
synced 2026-07-22 05:12:21 +00:00
docs: add readme
This commit is contained in:
y
parent
7ed715abbe
commit
ad864cf983
6 changed files with 25 additions and 111 deletions
2
.github/workflows/release.yml
vendored
2
.github/workflows/release.yml
vendored
|
|
@ -31,4 +31,4 @@ jobs:
|
|||
gh release create "$tag" \
|
||||
--title="$tag" \
|
||||
--draft \
|
||||
manifest.json temp/vault/.obsidian/plugins/tree-edit/main.js temp/vault/.obsidian/plugins/tree-edit/styles.css
|
||||
manifest.json temp/vault/.obsidian/plugins/lineage-dev/main.js temp/vault/.obsidian/plugins/lineage-dev/styles.css
|
||||
|
|
|
|||
101
README.md
101
README.md
|
|
@ -1,96 +1,13 @@
|
|||
# Obsidian Sample Plugin
|
||||
# Lineage
|
||||
Lineage is an Obsidian plugin that aims to provide a fully local [gingko-like](https://gingkowriter.com/) writing experience.
|
||||
|
||||
This is a sample plugin for Obsidian (https://obsidian.md).
|
||||
|
||||
|
||||
This project uses Typescript to provide type checking and documentation.
|
||||
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
|
||||
## Installation
|
||||
The plugin is currently in early development and is not available in the community plugin store.
|
||||
You can test it using [BRAT](https://tfthacker.com/brat-quick-guide#Testing+Plugins).
|
||||
|
||||
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
|
||||
## Usage
|
||||
The plugin uses HTML comments to structure markdown files.
|
||||
|
||||
This sample plugin demonstrates some of the basic functionality the plugin API can do.
|
||||
- Adds a ribbon icon, which shows a Notice when clicked.
|
||||
- Adds a command "Open Sample Modal" which opens a Modal.
|
||||
- Adds a plugin setting tab to the settings page.
|
||||
- Registers a global click event and output 'click' to the console.
|
||||
- Registers a global interval which logs 'setInterval' to the console.
|
||||
|
||||
## First time developing plugins?
|
||||
|
||||
Quick starting guide for new plugin devs:
|
||||
|
||||
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
|
||||
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
|
||||
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
|
||||
- Install NodeJS, then run `npm i` in the command line under your repo folder.
|
||||
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
|
||||
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
|
||||
- Reload Obsidian to load the new version of your plugin.
|
||||
- Enable plugin in settings window.
|
||||
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
|
||||
|
||||
## Releasing new releases
|
||||
|
||||
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
|
||||
- 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.
|
||||
- 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
|
||||
- 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.
|
||||
- Publish the release.
|
||||
|
||||
> 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`.
|
||||
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
|
||||
|
||||
## Adding your plugin to the community plugin list
|
||||
|
||||
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
|
||||
- Publish an initial version.
|
||||
- Make sure you have a `README.md` file in the root of your repo.
|
||||
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
|
||||
|
||||
## How to use
|
||||
|
||||
- Clone this repo.
|
||||
- Make sure your NodeJS is at least v16 (`node --version`).
|
||||
- `npm i` or `yarn` to install dependencies.
|
||||
- `npm run dev` to start compilation in watch mode.
|
||||
|
||||
## Manually installing the plugin
|
||||
|
||||
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
|
||||
|
||||
## Improve code quality with eslint (optional)
|
||||
- [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.
|
||||
- To use eslint with this project, make sure to install eslint from terminal:
|
||||
- `npm install -g eslint`
|
||||
- To use eslint to analyze this project use this command:
|
||||
- `eslint main.ts`
|
||||
- eslint will then create a report with suggestions for code improvement by file and line number.
|
||||
- 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:
|
||||
- `eslint .\src\`
|
||||
|
||||
## Funding URL
|
||||
|
||||
You can include funding URLs where people who use your plugin can financially support it.
|
||||
|
||||
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
|
||||
|
||||
```json
|
||||
{
|
||||
"fundingUrl": "https://buymeacoffee.com"
|
||||
}
|
||||
```
|
||||
|
||||
If you have multiple URLs, you can also do:
|
||||
|
||||
```json
|
||||
{
|
||||
"fundingUrl": {
|
||||
"Buy Me a Coffee": "https://buymeacoffee.com",
|
||||
"GitHub Sponsor": "https://github.com/sponsors",
|
||||
"Patreon": "https://www.patreon.com/"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## API Documentation
|
||||
|
||||
See https://github.com/obsidianmd/obsidian-api
|
||||
To open a file, you can use the file context menu or the command palette.
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ const context = await esbuild.context({
|
|||
logLevel: "info",
|
||||
sourcemap: prod ? false : "inline",
|
||||
treeShaking: true,
|
||||
outfile: "temp/vault/.obsidian/plugins/tree-edit/main.js",
|
||||
outfile: "temp/vault/.obsidian/plugins/lineage-dev/main.js",
|
||||
plugins: [
|
||||
inlineWorkerPlugin(),
|
||||
esbuildSvelte({
|
||||
|
|
@ -61,7 +61,7 @@ const context = await esbuild.context({
|
|||
const cssContext = await esbuild.context({
|
||||
entryPoints: ["src/styles.css"],
|
||||
bundle: true,
|
||||
outfile: "temp/vault/.obsidian/plugins/tree-edit/styles.css"
|
||||
outfile: "temp/vault/.obsidian/plugins/lineage-dev/styles.css"
|
||||
});
|
||||
|
||||
if (prod) {
|
||||
|
|
|
|||
|
|
@ -1,11 +1,9 @@
|
|||
{
|
||||
"id": "sample-plugin",
|
||||
"name": "Sample Plugin",
|
||||
"version": "1.0.0",
|
||||
"id": "lineage",
|
||||
"name": "Lineage",
|
||||
"version": "0.1.0-dev",
|
||||
"minAppVersion": "0.15.0",
|
||||
"description": "Demonstrates some of the capabilities of the Obsidian API.",
|
||||
"author": "Obsidian",
|
||||
"authorUrl": "https://obsidian.md",
|
||||
"fundingUrl": "https://obsidian.md/pricing",
|
||||
"isDesktopOnly": false
|
||||
}
|
||||
"description": "Gingko-like writing experience.",
|
||||
"author": "ycnmhd",
|
||||
"isDesktopOnly": true
|
||||
}
|
||||
11
package.json
11
package.json
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "tree-edit",
|
||||
"version": "0.1.0",
|
||||
"name": "lineage",
|
||||
"version": "0.1.0-dev",
|
||||
"description": "",
|
||||
"scripts": {
|
||||
"dev": "node esbuild.config.mjs",
|
||||
|
|
@ -34,6 +34,7 @@
|
|||
"husky": "8.0.3",
|
||||
"lint-staged": "13.1.0",
|
||||
"lucide-svelte": "0.292.0",
|
||||
"monkey-around": "3.0.0",
|
||||
"obsidian": "latest",
|
||||
"prettier": "3.0.3",
|
||||
"prettier-plugin-svelte": "3.1.2",
|
||||
|
|
@ -43,8 +44,6 @@
|
|||
"tslib": "2.4.0",
|
||||
"typescript": "5.3.3",
|
||||
"uniqid": "5.4.0",
|
||||
"vitest": "0.34.5",
|
||||
"monkey-around": "3.0.0"
|
||||
},
|
||||
"dependencies": {}
|
||||
"vitest": "0.34.5"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
{
|
||||
"1.0.0": "0.15.0"
|
||||
"0.1.0-dev": "0.15.0"
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue