ll-summer-23
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Write
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.

      Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Explore these features while you wait
      Complete general settings
      Bookmark and like published notes
      Write a few more notes
      Complete general settings
      Write a few more notes
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Engagement control
    • Make a copy
    • Transfer ownership
    • Delete this note
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Help
Menu
Options
Engagement control Make a copy Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners Signed-in users Everyone
Write
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.

    Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Explore these features while you wait
    Complete general settings
    Bookmark and like published notes
    Write a few more notes
    Complete general settings
    Write a few more notes
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # Cloning a GitHub Repository and Editing in Visual Studio Code This guide will walk you through the process of cloning a GitHub repository and editing its contents using Visual Studio Code (VS Code). Cloning a repository allows you to create a local copy of the repository on your computer, which you can edit and then push your changes back to GitHub. ## Prerequisites You should have a GitHub account. If you don't have one, you can sign up at GitHub. You should have Visual Studio Code installed on your computer. [This resource](https://hackmd.io/tDt-lhlZSninMyKj8S3xUA) will help you get it on your machine. ## Step 1: Clone the GitHub Repository Open your web browser and go to the GitHub repository you want to clone. Click on the "Code" button on the repository's main page. Copy the URL of the repository from the dropdown. Open a terminal (command prompt on Windows, terminal on macOS and Linux) on your computer. Navigate to the directory where you want to clone the repository using the cd command. For example: ``` cd Documents ``` Use the git clone command followed by the copied URL to clone the repository. For example: ``` git clone https://github.com/username/repository-name.git ``` The repository will be cloned into a new directory with the same name as the repository. Navigate into the cloned directory using the cd command. ## Step 2: Editing in Visual Studio Code Open Visual Studio Code. Click on "File" in the top left corner and select "Open Folder." Navigate to the cloned repository directory and select it. Visual Studio Code will now open the repository's contents. You can see all the files and folders in the Explorer panel on the left. To edit a file, simply click on it in the Explorer panel. The file will open in the main editor area. Make your changes to the file. After making changes, save the file by clicking "File" in the top left corner and selecting "Save" or by using the keyboard shortcut Ctrl + S (Windows/Linux) or Cmd + S (macOS). ## Step 3: Pushing Changes to GitHub Open the terminal in Visual Studio Code by clicking "View" in the top menu and selecting "Terminal," or by using the keyboard shortcut Ctrl + backtick (`). Use the following commands to commit and push your changes to GitHub: ``` git add . git commit -m "Add a descriptive commit message here" git push origin main ``` Replace "Add a descriptive commit message here" with a meaningful message describing your changes. Your changes will now be pushed to GitHub. ## Using .gitignore to Protect API Keys and Sensitive Information ### Why Use .gitignore? When you're developing an application, you might work with sensitive information like API keys, passwords, and other configuration details. Committing such information to version control systems like Github can pose security risks, as it exposes this data to potential attackers. The .gitignore file helps prevent these sensitive files from being accidentally included in your Git repository, enhancing security and privacy. ### Creating .gitignore Files Visual Studio Code simplifies the process of creating and managing .gitignore files for your projects. Open Your Project in Visual Studio Code: Launch Visual Studio Code and open the root directory of your project. ### Creating a .gitignore File: In the Explorer panel on the left, right-click on your project folder and select "New File." Name the file .gitignore (note the leading dot) and press Enter. ### Adding Entries to .gitignore: Open the newly created .gitignore file. Add entries for files and directories you want to exclude from version control. For example, to exclude a file named config.json and all .env files, you would add: ``` config.json .env ``` Each line represents a file or directory pattern to be ignored. Save the .gitignore file ### Commit and Push Changes: After saving the .gitignore file, commit and push your changes to ensure that the .gitignore settings are applied across your repository. ### Including .env.local Files in .gitignore .env.local files are often used to store environment-specific configuration. Including them in .gitignore ensures that local configuration remains private. ### Modify Your .gitignore File: Open your existing .gitignore file. Add an entry to ignore .env.local files: ```.env.local``` Save the .gitignore file. ### Save and Commit Changes: Save your .gitignore file and commit your changes to ensure that .env.local files are excluded from version control. By using .gitignore, you safeguard sensitive information like API keys, passwords, and local configurations from being exposed in your Git repository. This security practice helps protect your application and its users' data. Utilizing Visual Studio Code's built-in features makes it easy to create and manage .gitignore files, contributing to a more secure development process. Remember to regularly update your .gitignore file as your project evolves and new sensitive files are added. By following these steps, you can ensure your application remains secure and your sensitive information remains private.

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password
    or
    Sign in via Facebook Sign in via X(Twitter) Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    By signing in, you agree to our terms of service.

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully