Mercurial > obsidian-remember-file-state

comparison README.md @ 32:141f0a7d1986

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Better error handling for npm dogfood command. Expand the README info.
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 28 Nov 2022 20:39:13 -0800
parents 7975d7c73f8a
children b77a0dd22db8
comparison
equal deleted inserted replaced
31:cfd1b1b6768a 32:141f0a7d1986
1 ## Remember File State 1 # Remember File State
2 2
3 This [Obsidian](https://obsidian.md) plugin remembers the editor state of files 3 This [Obsidian](https://obsidian.md) plugin remembers the editor state of files
4 as you switch between them. It restores the cursor position, scrolling position, 4 as you switch between them. It restores the cursor position, scrolling position,
5 and so on. The plugin doesn't do any polling, and strives to only do work when 5 and so on. The plugin doesn't do any polling, and strives to only do work when
6 opening and closing files in order to no slow down the editing experience. 6 opening and closing files in order to no slow down the editing experience.
7 7
8 Note that this plugin doesn't currently remember state across sessions. 8 Note that this plugin doesn't currently remember state across sessions.
9 9
10
11 ## Developer Quickstart
12
13 My own workflow for working on this plugin is the following:
14
15 1. Install the "_Remember File State_" plugin in a test vault. Don't forget to
16 enable it.
17 2. Clone the `obsidian-remember-file-state` repository.
18 3. Run the usual incantations, such as `npm install`.
19 4. Run the build process in watch mode so that it compiles the TypeScript code
20 and overwrites the test vault's plugin: `npm run dogfood
21 /path/to/vault/.obsidian/plugins/obsidian-remember-state`.
22 5. When making changes, trigger the "_Reload App Without Saving_" command to
23 reload Obsidian.
24 6. Optionally, hit `Ctrl-Shift-I` to open the developer console and see the
25 console log.
26