Giter VIP home page Giter VIP logo

js-docs's Introduction

Javasript Gatsby

JavaScript Doc's made with Gatsby.

PRs Welcome

This project was made to contribute to the Open Source World and for adquire more knowledge with this tools.

πŸš€ Fork and Contribute

  1. Forking repository

    Fork the repository and configure set-up UPSTREAM:

    $ git remote add upstream https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git

    Check the repository:

    $ git remote -v
  2. Create a branch

    Navigate into the new site’s directory and start it up.

    cd js-docs/
    git checkout -b <add-your-new-branch-name>
    For example: git checkout -b feature-xyz
  3. Install dependencies

    Run the following commands above:

    cd js-docs/
    yarn install or npm install
  4. Start developing.

    Change to the repository directory on your computer (if you are not already there):

    cd js-docs/
    yarn start or npm start
  5. Create a new page

    To create more one page about javascript concepts, read about rules:

    • Add a new folder into pages directory
    • Create a archive index.js on the new folder created
    • Create a markdown into markdown directory

    Note: Remember see if not exist a style that you want use. The principal styles are into src/styles.js

    Note 2: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

  6. Make a PR (Pull Request)

    Don't forget to align the code with the master:
    $ git pull upstream master
    Submit the Pull Request to the repository on Github! And Be happy!
  7. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

πŸ’« Deploy

Deploy to Netlify

πŸŽ“ Authors / Contributors


Bruno Ramires

Leonardo Cesca

Laks Castro

js-docs's People

Contributors

brunormferreira avatar leonardocesca avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.