https://github.com/vrtmrz/obsidian-screwdriver
https://github.com/vrtmrz/obsidian-screwdriver
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/vrtmrz/obsidian-screwdriver
- Owner: vrtmrz
- License: mit
- Created: 2022-03-15T09:07:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-25T03:28:17.000Z (over 1 year ago)
- Last Synced: 2024-08-13T07:17:47.882Z (10 months ago)
- Language: TypeScript
- Size: 204 KB
- Stars: 17
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - vrtmrz/obsidian-screwdriver - (TypeScript)
README
## Screwdriver
The plugin for picking and putting hidden files.
You can dump your files which are stored in the specified directory, or put dumped files into any path under your vault.
Note: Since v0.0.7, We can use properties to control this plug-in!
## Features
- Dump files from the specified directory with filters and ignores.
- Put dumped files into any path under your vault (including the hidden directory).
>[!IMPORTANT]
Please note that the output of this plug-in is a markdown file, but very large. Make sure to set to be ignored by your other plug-ins. i.e., `Templater` or `DataView`.
### How to use
#### Install
You can install Screwdriver in the following ways:
- From Community Plugins
- Via [BRAT](https://github.com/TfTHacker/obsidian42-brat).
#### Prepare a command file
The command file is the file which has some directions on the frontmatter; like the following.
```yaml
targets:
- .obsidian/plugins/tagfolder
urls: []
ignores:
- /node_modules
- /.git
filters:
- main\.js$
- manifest\.json$
- styles\.css$
comment: "'Add target directory' to add targets"
tags: []
adjustObsidianDir: true
skipNewFile: false
skipOldFile: false
```
However, we do not have to worry so much. We can make this file by `Ctrl+P` -> `Screwdriver: Create or add local file exporting template`.
Then, all we have to do is simply pick the target directory, by `Ctrl+P` -> `Screwdriver: Add target directory`.
When we choose the Plug-in or Theme, filters will be supplied automatically.
If you want to control more detail, please change the `filters` and `ignores`.
- `Ignores`: files beginning with the letter set here will be omitted while dumping.
- `Filters`: only the files that match with the expression set here will be dumped.
If you want to export multiple things at once, please repeat the `Add target directory`
>[!TIP]
>If we want to fetch the file on the Internet, we can use `Create or add remote file fetching template`.
>Using this template, we can retrieve the files from the internet. It may be useful for fetching CSS Snippets from Gist.
#### Export files
`Ctrl+P` -> `Export specified files and store into the active file` to export files into the activefile.
```yaml
---
targets:
- .obsidian/plugins/tagfolder
urls: []
ignores:
- /node_modules
- /.git
filters:
- main\.js$
- manifest\.json$
- styles\.css$
comment: "'Add target directory' to add targets"
tags: []
adjustObsidianDir: true
skipNewFile: false
skipOldFile: false
---
```
```md
# .obsidian/plugins/tagfolder/main.js
- Created :2023/7/12 9:28:27
- Modified:2023/8/25 17:52:29
```screwdriver:.obsidian/plugins/tagfolder/main.js:plain:1692953549000
/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
if you want to view the source, please visit the github repository of this plugin
*/
```
>[!TIP]
>Exported files can be modified by editing the doc.
#### Restore
`Ctrl+P` -> `Restore exported files from the active file` to restore files into your storage.
>[!IMPORTANT]
>The files are written as the filename following \`\`\` or \`\`\`screwdriver:
If you're using [Self-hosted LiveSync](https://github.com/vrtmrz/obsidian-livesync) or [remotely-save](https://github.com/fyears/remotely-save), it could be useful to synchronize your configuration between devices.