GitHub Readme used for documentation also used .md (markdown) files for documentation.
Note, for all webpages containing any number of md files, GitHub only renders the README.md file on current page if present.
Note
Markdown files can include <html> language code as both are compatible.
-
Fork the repository to your own GitHub account.
-
Clone the repository to your local machine
$ git clone "https://www.github.com/{Username}/Markdown-for-Documentation.git"
where username is your GitHub account username.
- Create a branch where you can do your local work. Never work on master branch as we do not allow master commits except by admins.
$ git branch {branchname}
$ git checkout branchname
- Do your work and stage your changes.
$ git add <filename>
- Commit you changes with a commit message containing your name, file(s) worked upon, changes added.
$ git commit -m "Name| files| Changes"
- Push changes to your forked repository
$ git push -u origin branchname
- Create a pull request to the upstream repository.
- Create upstream as our repository
$ git remote add upstream "https://www.github.com/NishkarshRaj/Markdown-for-Documentation"
- Fetch upstream changes in local machine
$ git fetch upstream
- Switch to master branch
$ git checkout master
- Merge changes in local machine
$ git merge upstream/master
- Push changes to your forked GitHub repository
$ git push -f origin master