HackMD
  • Prime
    Prime  Full-text search on all paid plans
    Search anywhere and reach everything in a Workspace with Prime plan.
    Got it
      • Create new note
      • Create a note from template
    • Prime  Full-text search on all paid plans
      Prime  Full-text search on all paid plans
      Search anywhere and reach everything in a Workspace with Prime plan.
      Got it
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Gist
    Import
    Dropbox Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with GitHub
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # Getting Started with Github and Gitbook Overview --------------- [GitHub](https://github.com/) is a collaborative development platform for open-source software projects. It uses Git, a version control system, to track and log changes to the source code, and display that history front and center. The Yearn team also uses Github for transparent project planning, visible collaboration, and housing all of the team's documentation and projects. To reach Yearn's Github projects page just navigate to the [Yearn repository](https://github.com/iearn-finance) and tap on Projects in the header as seen below: 1. Yearn Finance Repository List ![](https://i.imgur.com/CkEVHb9.png) 2. Tap on Projects List Tab![](https://i.imgur.com/SzWxdCz.png) 3. Tap on Docs to see a view of the documents projects page ![](https://i.imgur.com/YreX2Gy.png) The Yearn Documentation team takes advantage of GitHub's robust graphic user interface (GUI) for Git to open issues, leave comments and manage our content files. On Github you can create issues in a repository which can then be labeled with a particular tag and then assigned to someone. This issue will then pop up as a card on the Projects board which can be moved around based on its current status. For more information on how to create an issue please visit [Github Help - Creating an Issue](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/creating-an-issue). Additionally Yearn uses a simple Git branching model, where one party manages the master branch and reviews all changes before adding them, which is usually the job of one of the repo admins. To learn more about how git workflows work, including from a command line instead of a GUI like Github please see: [GitHub Standard Fork & Pull Request Workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962). **_Lost and have no idea how GitHub works?_** Check out this short [video](https://www.youtube.com/watch?v=w3jLJU7DT5E) for a brief intro to GitHub. Feel free to peruse [learn git branching](https://learngitbranching.js.org/) for fundamental git concepts. Yearn also uses [Gitbook](https://www.gitbook.com/) to present the information in our Github Docs Repository(AKA Repo) in a way accessible to the public which can be seen at the official [Yearn Docs](https://docs.yearn.finance/) page. Below are two clear guides to contributing via GitHub and Gitbook based on how much you believe you will be contributing. ### Simple One-off Tasks If you notice a typo or some small changes where you don't think setting up the documentation is worth the time to do so or you don't plan to be an ongoing contributor, just follow the below steps: 1. Log into the [GitHub website](https://github.com/). a. Make sure you have a GitHub account and you’re logged in. 2. Go to the Github website, and fork the repository (AKA repo) you are making a change to. For example, you may want to fork the [Docs](https://github.com/iearn-finance/docs) repository. You can do so by navigating to the repository you want to change and in the top-right corner of the page, click fork. ![](https://i.imgur.com/hgljuOl.jpg) a. Forking the repo creates your a version of the site on your GitHub so you can make changes without impacting the original project. To learn more about forking visit [Github Forking Documentation](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) 3. In your forked repository, go to file or folder you want to change ensuring you adhere to the [Writing Style Guide](https://hackmd.io/dXQecpkJQX6XRy4y7k7j3g). - **Edit File** Once in the file, press the pen icon to edit content. This will enter edit mode within Github. Edit mode allows making and proposing new changes without overwriting existing content. ![](https://i.imgur.com/m51yBWQ.png) **Add File** Once in the folder that represents proper page placement, press “Create new file”. This will add a new .md file in your own GitHub account. This allows you to propose the addition of your content without publishing it right away. 4. Once file changes are complete, you'll need to commit your changes. To do this scroll to the bottom of the page to where it says "Commit changes," write a short description of your changes, and then click the 'commit changes' button. 5. ![](https://i.imgur.com/iehR1ds.png) You will then be prompted to submit a Pull Request (PR). During that process you will be asked for an explanation of changes. This will help any reviewer understand what changes were made, so they can make a decision whether to publish it to the main branch/site. 6. Once merged into your local repository Fill out Pull Request (PR) form by navigating back to the home page of your forked repository and tapping Pull Requests in order to submit your changes to the main Yearn Documentation "Trunk" which you forked from. a. ![](https://i.imgur.com/hjA4JGL.png) b. Then tapping create Pull Request ![](https://i.imgur.com/DqE5raK.png) c. Lastly including enough information in the PR for the maintainers to adequately review. ![](https://i.imgur.com/pkP0yho.png) 7. Review/Merge There might be feedback/changes on a PR. A reviewer can approve, request changes, or merge the edited file into the repo. Edits can be made with an open PR (often without leaving Github's website) and the PR will update automatically. Once happy, a reviewer will merge your work and it will be live on the site. ### For Ongoing Contributions Yearn uses [Gitbook](https://www.gitbook.com/) which leverages Github in order to organize our [Documentation](https://docs.yearn.finance/). In order to successfully contribute more than simple changes, reaching out to other Yearn contributors is always preferable to get an idea of what the team is working on. Feel free to reach out on Discord if you are having any trouble with the instructions below. 1. Log into the [GitHub website](https://github.com/). a. Make sure you have a GitHub account and you’re logged in. 2. Go to the Github website, and fork the [Docs repository](https://github.com/iearn-finance/docs) (AKA repo) you are making a change to. You can do so by navigating to the repository you want to change and in the top-right corner of the page, click fork, for more detailed instructions see the Simple One-off Tasks Guide listed above. 3. Head on over to [Gitbook](https://www.gitbook.com/) and sign up for a free account. From there create a new space, give it a familiar name and ensure it is public. ![](https://i.imgur.com/9H0DbH4.png) 4. ![](https://i.imgur.com/KMz1oBA.png) 5. Once you have created a new space tap `Integrations` on the left sidebar and tap on the Github switch. ![](https://i.imgur.com/P7vIy4j.png) 6. You should be prompted with `Link your GitHub repository` where you can now select `list all public repositories`, in the list you can search your recently forked Yearn Docs repo, likely named `docs` for you. ![](https://i.imgur.com/iblM3Sl.png) ![](https://i.imgur.com/SRMLRis.png) 7. Tap that, select `Sync "master" branch only` if you are only working on the base branch or select a branch if you are working on translations as those live on other branches.For more information on how the Github branching model works see[learn git branching](https://learngitbranching.js.org/). ![](https://i.imgur.com/1CV6V9b.png) 8. Lastly for the prompt `Which content should be used for the first synchronization ?` select `I write my content on GitHub`. Give it some time to import and you should be all set! ![](https://i.imgur.com/L3uIqGl.png) ![](https://i.imgur.com/3YdY9tJ.png) Once fully imported you can now begin making edits right on the page you're on which you can Save and Merge when you are ready. ![](https://i.imgur.com/Z7W9dA5.png) ![](https://i.imgur.com/IrzTxiM.png) ![](https://i.imgur.com/RzTPLQM.png) Once you are finished editing and are ready to merge these changes into the original Yearn master repo which you originally forked from. Go to your `<your github name>/<your docs repo name>` and Tap `Create a Pull Request` ensuring that the base repository is `iearn-finance/docs` and the head is `<your github name>/<your docs repo name>`. A [Reviewer](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw) may then add some comments that require you to to submit your PR in order to ensure your additions look right before merging in. Fore more information regarding the PR and merge process see the guide above. Confused? Reach out in [Yearn Documentation Chat](https://discord.com/channels/734804446353031319/748476302121762866) and someone will walk you through it step-by-step. If you think you can improve this guide feel free to submit a PR ;)

    Import from clipboard

    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 lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.


    Upgrade

    All
    • All
    • Team
    No template found.

    Create custom template


    Upgrade

    Delete template

    Do you really want to delete this template?

    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

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox

    New to HackMD? Sign up

    Help

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

    Documents

    Tutorials

    Book Mode Tutorial

    Slide Mode Tutorial

    YAML Metadata

    Contacts

    Facebook

    Twitter

    Feedback

    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

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings
    Upgrade now

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    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. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        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
        Available push count

        Upgrade

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Upgrade

        Danger Zone

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

        Syncing

        Push failed

        Push successfully