Mercurial > obsidian-remember-file-state

comparison README.md @ 47:8e8019698f16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README
author Ludovic Chabant <ludovic@chabant.com>
date Wed, 20 Sep 2023 23:31:06 -0700
parents b77a0dd22db8
children
comparison
equal deleted inserted replaced
46:fb40e8d5d4e3 47:8e8019698f16
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 and scrolling position. 4 as you switch between them. It restores the cursor position and scrolling
5 The plugin doesn't do any polling, and strives to only do work when 5 position. By default, it also remembers these states across sessions by saving
6 opening and closing files in order to not slow down the editing experience. 6 the data to disk.
7 7
8 Note that this plugin doesn't currently remember state across sessions. 8 This plugin doesn't do any polling and doesn't register any timers. It strives
9 to only do work when opening and closing files in order to not slow down the
10 editing experience.
9 11
10 12
11 ## Developer Quickstart 13 ## Developer Quickstart
12 14
13 My own workflow for working on this plugin is the following: 15 My own workflow for working on this plugin is the following:
16 enable it. 18 enable it.
17 2. Clone the `obsidian-remember-file-state` repository. 19 2. Clone the `obsidian-remember-file-state` repository.
18 3. Run the usual incantations, such as `npm install`. 20 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 21 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 22 and overwrites the test vault's plugin: `npm run dogfood
21 /path/to/vault/.obsidian/plugins/obsidian-remember-state`. 23 /path/to/vault/.obsidian/plugins/obsidian-remember-file-state`.
22 5. When making changes, trigger the "_Reload App Without Saving_" command to 24 5. When making changes, trigger the "_Reload App Without Saving_" command to
23 reload Obsidian. 25 reload Obsidian.
24 6. Optionally, hit `Ctrl-Shift-I` to open the developer console and see the 26 6. Optionally, hit `Ctrl-Shift-I` to open the developer console and see the
25 console log. 27 console log.
26 28