README.md

JavaScript Doc's made with Gatsby.

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

🎓 Authors / Contributors

Bruno Ramires
Leonardo Cesca
Laks Castro