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.

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

Add 'Focus Mode' plugin. #276

Merged
merged 11 commits into from May 10, 2021
Merged

Add 'Focus Mode' plugin. #276

merged 11 commits into from May 10, 2021

Conversation

ryanpcmcquen
Copy link
Contributor

@ryanpcmcquen ryanpcmcquen commented May 5, 2021

  • I am submitting a new Community Plugin

Repo URL

https://github.com/ryanpcmcquen/obsidian_focus_mode

Focus Mode demo

Release Checklist

  • I have tested this on Windows

  • I have tested this on macOS

  • I have tested this on Linux

  • Github release contains all required files

    • main.js
    • manifest.json
    • styles.css
  • Github release name matches the exact version number specified in your manifest.json (Note: Use the exact version number, don't include a prefix v)

  • The id in my manifest.json matches the id in the community-plugins.json file.

  • README clearly describes the plugins purpose and provides clear usage instructions.

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 5, 2021

Oh wait, my release only contains main.ts, not main.js. Looks like the default .gitignore excludes it ... am I supposed to manually add that?

@lishid
Copy link
Collaborator

@lishid lishid commented May 5, 2021

You should upload the built files to your Releases tab instead of pushing it into the repo - edit this release: https://github.com/ryanpcmcquen/obsidian_focus_mode/releases/tag/1.0.0

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 5, 2021

@lishid, thanks for the reply! Does it only need those 3 files?

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 5, 2021

Also, is there a naming convention for that? For instance, would this name work?

obsidian_focus_mode__1.0.0.zip

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 5, 2021

Oh, or is the expectation that I just manually include those files?

@lishid
Copy link
Collaborator

@lishid lishid commented May 5, 2021

Yeah, check out how the other plugins do it in the releases section :)

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 5, 2021

@lishid, done!

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 7, 2021

@lishid or @ericaxu, anything else I can do on this to help? I don't have access to the other platforms now, but since the code here operates on the DOM, it should be universal.

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 7, 2021

Got access to a Windows machine and tested there, will try to find a Linux comp or user.

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 8, 2021

Tested on Linux (Kubuntu 20.04/AppImage 0.11.13):
Screenshot_20210508_084415

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 8, 2021

Windows screenshot for posterity:
windows_obsidian_focus_mode

@lishid
Copy link
Collaborator

@lishid lishid commented May 8, 2021

Ok, couple of small things:

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 8, 2021

@lishid thanks for the solid review! Done:
ryanpcmcquen/obsidian-focus-mode@fe47027

@lishid
Copy link
Collaborator

@lishid lishid commented May 10, 2021

I've changed your plugin ID from using underscores to using dashes. Once you update them in your repo, I'll merge the PR 👍

@ryanpcmcquen
Copy link
Contributor Author

@ryanpcmcquen ryanpcmcquen commented May 10, 2021

@lishid done! Despite the fact that I love underscores, consistency should always win!

@lishid lishid merged commit 14662ef into obsidianmd:master May 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants