A focused Markdown editor that provides a better way to edit and save GitHub Gists — perfect for writing project proposals, outlines, and documentation snippets.
https://ezgisteditor.netlify.app
-
Clone your fork: First, fork the repository on GitHub. Then clone your fork locally:
git clone https://github.com/YOUR_USERNAME/EzGistEditor.git cd EzGistEditor
(Replace
YOUR_USERNAME
) -
Add Upstream Remote:
git remote add upstream https://github.com/nilayarya/EzGistEditor.git git fetch upstream
-
Install Dependencies:
npm install
-
Run Development Server:
npm run dev
Contributions are welcome! Please follow these steps:
-
Create a Branch: Branch off the
main
branch from the upstream repository:git checkout -b my-feature-branch -t upstream/main
-
Make Changes: Write your code and add tests if applicable. Ensure code follows existing style.
-
Commit Changes: Use semantic commit messages
git add . git commit -m "feat: Add PDF generation button" # or git commit -m "fix: Correct preview pane alignment" # or git commit -m "docs: Update README setup instructions"
Common prefixes:
feat
,fix
,docs
,style
,refactor
,test
,chore
. AddBREAKING CHANGE:
in the body/footer for breaking changes. -
Rebase: Before pushing, synchronize with the main repository:
git fetch upstream git rebase upstream/main
Resolve any conflicts that arise during the rebase.
-
Push: Push your branch to your fork:
git push origin my-feature-branch
-
Open Pull Request: Go to the original repository (
nilayarya/EzGistEditor
) on GitHub and open a pull request from your fork's branch (my-feature-branch
) to the originalmain
branch. Fill out the pull request template.