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 a GitHub docs explorer button to the popup #134

Open
wheelercj opened this issue Oct 9, 2024 · 1 comment
Open

Add a GitHub docs explorer button to the popup #134

wheelercj opened this issue Oct 9, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@wheelercj
Copy link
Collaborator

wheelercj commented Oct 9, 2024

Add a new button to Stardown's popup with a title like "My repos" or something similar. When the button is clicked, the popup then shows a list of GitHub repos to which the user is a contributor. When one of those is clicked, the popup shows a list of all of the chosen repo's markdown files and folders containing markdown files. When one of those is clicked, the GitHub page for that file or folder opens. Any popup animations should probably be very short. I think it would make the most sense to put this new button either between the "Notepad" and "Settings" buttons, or between a new horizontal rule and the existing one.

This will require integrating with GitHub's API (via OAuth?). While creating this feature, it would probably be good to keep in mind that we might also add support for other Git hosts in the future.

If the user clicks the new popup button in the popup when they have not yet authorized GitHub integration, the integration process should then begin. The settings page should probably also have buttons for disconnecting from GitHub and/or changing which GitHub accounts to integrate with. Some GitHub users have multiple accounts (e.g. a personal account and a work account for each company they have worked at).

Later, we will most likely also want to add search bars, filtering, sorting, pinning, etc. for the lists of repos, files, and folders.

Let me know if you had something else in mind for any parts of this issue!

Why integrate with GitHub?

Many Stardown users will also be GitHub users and may use Stardown specifically for use with GitHub. GitHub repos almost always use markdown for documentation (apparently some of them use AsciiDoc). Navigating GitHub's site to find the correct markdown file to read and/or edit can be very time-consuming as GitHub pages tend to load much more than what the user needs when they're just working on documentation. This feature will speed up markdown workflows significantly.

Also, there don't appear to be any well-known web clippers that integrate directly with GitHub. Although this feature does not integrate the web clipper part of Stardown directly with GitHub, that integration may also be added in the future.

Of course, this feature should not get in the way of using Stardown with other sites and applications such as Obsidian.

@wheelercj wheelercj added the enhancement New feature or request label Oct 9, 2024
@wheelercj
Copy link
Collaborator Author

This might be helpful if we use OAuth2: identity - Mozilla | MDN

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants