Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liamcain/obsidian-creases
👕 Tools for effectively folding markdown sections in Obsidian
https://github.com/liamcain/obsidian-creases
obsidian-md obsidian-plugin
Last synced: 10 days ago
JSON representation
👕 Tools for effectively folding markdown sections in Obsidian
- Host: GitHub
- URL: https://github.com/liamcain/obsidian-creases
- Owner: liamcain
- License: mit
- Created: 2021-02-06T17:12:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-17T14:22:51.000Z (over 1 year ago)
- Last Synced: 2024-10-23T00:35:37.028Z (18 days ago)
- Topics: obsidian-md, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 2.69 MB
- Stars: 229
- Watchers: 4
- Forks: 8
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - liamcain/obsidian-creases - 👕 Tools for effectively folding markdown sections in Obsidian (TypeScript)
- jimsghstars - liamcain/obsidian-creases - 👕 Tools for effectively folding markdown sections in Obsidian (TypeScript)
README
# Creases 👕
Tools for efficiently folding markdown sections in Obsidian.
Add `%% fold %%` markers to "crease" your markdown. Then run **Fold along creases** to get your file into the state you want.
## ⚙️ Commands
### General Folding
- **Fold headings by level** – Fold all headings in the correct document that match a given level (H1 - H6)
- **Fold More** - Finds and folds the closest heading or list item.
- **Fold less** - Finds and unfolds the closest heading or list item.
### Fold Levels
Creases also borrows the concept of a "fold level" from vim. The fold level is inferred from the current folds in the note. If have you have your `## Heading Level 2` headings folded, _decreasing_ the fold level will unfold all headings up to `# Heading Level 1`. _Increasing_ the fold level will unfold up to your `### Heading Level 3`.
- **Increase heading fold level** - Increase the fold level by 1
- **Decrease heading fold level** - Decrease the fold level by 1
### Working with "creases"
- **Toggle Crease** – Crease/uncrease the current section that you're in
- **Crease the current folds** – Applies a crease to the current folds in the file, allowing you to easily get back to these current folds using **fold along creases**.
- **Fold along creases** – Fold all the creased sections of your file
- **Iron out the creases** – Remove all the creases from the current file
## ➕ Additional Features
- **Templates support** – If you use the _Templates_ core plugin, any creases included in your template will automatically be folded.
- **Templater support** – Add creases to your [Templater](https://github.com/SilentVoid13/Templater) templates to have content automatically folded.
## ⚡️ Example Workflows (aka "Has this ever happened to you?")
### Create a "save state" for your folds
If you're working on a long document, you might find yourself folding sections as you go. Now you want to do a "Find" in the fold. Uh oh, it found a match but now all your folded away content is unfolded.
Instead, save your folds as creases:
1. Run "Crease the current folds" to mark all your current folds as _creased_.
2. Search the document to your heart's content, unfolding without a care in the world.
3. Run "Fold along creases" to restore all your folds to exactly how they were before.
4. _Optional_ Now that you're back to your ideal document origami, you can run "Iron out the creases" to get rid of the fold markers.
### You want content in your template to be folded by default.
Whether you use the core **Templates** plugin or **Templater**, you might find yourself wishing that some sections start folded since you don't look at them often.
1. In your template file, just make sure that `%% fold %%` appears on the same line as the heading or list item that you want folded. You can also run the "Toggle crease" command from within the template to insert the crease automatically.
### You want to fold all the `### Level 3 Heading`s in your document
Folding all the headings at a given depth can be a tedious process. Well, no longer.
1. Just run "Toggle fold for H3."
## 🎞 Credits
Special thanks **@mleo2003** on Discord for the plugin name.
## Say Thanks 🙏
If you like this plugin and would like to buy me a coffee, you can!
[
](https://www.buymeacoffee.com/liamcain)
Like my work and want to see more like it? You can sponsor me.
[](https://github.com/sponsors/liamcain)