Mercurial > obsidian-remember-file-state

annotate README.md @ 37:8be02002ed66

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use Obsidian's view APIs for scrolling state Obsidian does some asynchronous formatting upon opening a file which can affect the vertical positioning of things, especially when there are tables for instance. Setting the scrolling position via the CM6 APIs gets invalidated by this, so we're using the Obsidian view API instead even if it only allows getting/setting vertical scrolling (not horizontal).
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 14 Aug 2023 10:44:55 -0700
parents b77a0dd22db8
children 8e8019698f16
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
32
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
1 # Remember File State
0
7975d7c73f8a Initial commit
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2
7975d7c73f8a Initial commit
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3 This [Obsidian](https://obsidian.md) plugin remembers the editor state of files
33
b77a0dd22db8 Editing pass on the README text.
Ludovic Chabant <ludovic@chabant.com>
parents: 32
diff changeset
4 as you switch between them. It restores the cursor position and scrolling position.
b77a0dd22db8 Editing pass on the README text.
Ludovic Chabant <ludovic@chabant.com>
parents: 32
diff changeset
5 The plugin doesn't do any polling, and strives to only do work when
b77a0dd22db8 Editing pass on the README text.
Ludovic Chabant <ludovic@chabant.com>
parents: 32
diff changeset
6 opening and closing files in order to not slow down the editing experience.
0
7975d7c73f8a Initial commit
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7
7975d7c73f8a Initial commit
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8 Note that this plugin doesn't currently remember state across sessions.
7975d7c73f8a Initial commit
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9
32
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
10
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
11 ## Developer Quickstart
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
12
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
13 My own workflow for working on this plugin is the following:
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
14
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
15 1. Install the "_Remember File State_" plugin in a test vault. Don't forget to
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
16 enable it.
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
17 2. Clone the `obsidian-remember-file-state` repository.
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
18 3. Run the usual incantations, such as `npm install`.
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
19 4. Run the build process in watch mode so that it compiles the TypeScript code
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
20 and overwrites the test vault's plugin: `npm run dogfood
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
21 /path/to/vault/.obsidian/plugins/obsidian-remember-state`.
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
22 5. When making changes, trigger the "_Reload App Without Saving_" command to
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
23 reload Obsidian.
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
24 6. Optionally, hit `Ctrl-Shift-I` to open the developer console and see the
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
25 console log.
141f0a7d1986 Better error handling for npm dogfood command. Expand the README info.
Ludovic Chabant <ludovic@chabant.com>
parents: 0
diff changeset
26