Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add initial test vault #399

Merged
merged 5 commits into from
Sep 16, 2023
Merged

Add initial test vault #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39fe55f
test-vault: add initial test vault
julesvirallinen Sep 14, 2023
500c701
test-vault: compile dg to test vault on npm run dev
julesvirallinen Sep 14, 2023
411ddde
test-vault: add some default settings
julesvirallinen Sep 14, 2023
b28182d
lint: don't lint testVault
julesvirallinen Sep 14, 2023
30a470a
chore: remove unnecessary package
julesvirallinen Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ main.js
jest.config.js

.eslintrc.js
src/dg-testVault/*
2 changes: 1 addition & 1 deletion .eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@
],
"@typescript-eslint/no-explicit-any": ["warn"],
// allow prettier to use SmartTabs
"no-mixed-spaces-and-tabs": "off",
"no-mixed-spaces-and-tabs": "off"
}
}
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ node_modules

# Don't include the compiled main.js file in the repo.
# They should be uploaded to GitHub releases instead.
main.js
/main.js

# Exclude sourcemaps
*.map
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ coverage
.parcel-cache

*.yml
src/dg-testVault/*
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ dg-publish: true

- The dg-publish setting tells the plugin that this note should be published to your digital garden. Notes without this setting will not be published. (In other terms: Every note you publish will need this setting.)

7. Open your command pallete by pressing CTRL+P on Windows/Linux (CMD+P on Mac) and find the "Digital Garden: Publish Single Note" command. Press enter.
7. Open your command palette by pressing CTRL+P on Windows/Linux (CMD+P on Mac) and find the "Digital Garden: Publish Single Note" command. Press enter.
8. Go to your site's URL which you should find on [Vercel](https://vercel.com/dashboard). If nothing shows up yet, wait a minute and refresh. Your note should now appear.

Congratulations, you now have your own digital garden, hosted free of charge!
Expand Down Expand Up @@ -92,10 +92,14 @@ Note that you in no way have to feel any pressure to do this. The plugin is comp

## Local development

1. Clone this repository into `.obsidian` of your vault (it is recommended to use a test-vault instead of your own!)
NOTE: this plugin contains a testing vault at `src/dg-testVault`, which is recommended for local development.

1. Clone this repository
2. (for best compatability, use node version manager and run `nvm install && nvm use`)
3. Install dependencies with `npm install`
4. Run with `npm run dev`
5. You should now be able to enable the plugin in obsidian
5. Open the vault from `src/dg-testVault` into obsidian

6. (if you want to develop this plugin with another vault, move it into .obsidian/plugins of that vault)

Note: this repository uses prettier and eslint to enforce code formatting and style. It is recommended to install these to your IDE for automatic formatting and error highlighting.
Loading
Loading