This repository has been archived by the owner on Sep 2, 2021. It is now read-only.
Incorporating changes for the brackets.io redesign #205
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,3 +2,6 @@ Thumbs.db | |
|
|
||
| #OSX .DS_Store files | ||
| .DS_Store | ||
| node_modules/ | ||
| npm-debug.log | ||
| *.map | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "dev"] | ||
| path = dev | ||
| url = https://github.com/adobe/brackets-site-sass |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,79 @@ | ||
| [](https://brackets.io) Welcome to brackets.io | ||
| ============================================================================= | ||
| This is the offcial repository for the brackets.io website | ||
|
|
||
| # Development | ||
|
|
||
| While the js, and html can be modified right in the repository, the sass stylesheets for brackets.io exist in another repository - [brackets-site-sass](https://github.com/adobe/brackets-site-sass), and are included in as a submodule. | ||
|
|
||
| This is because the same style sheets are shared by [brackets-registry](https://github.com/adobe/brackets-registry) as well. | ||
|
|
||
| Refer to the section below for assistance on how to develop the css for brackets.io | ||
|
|
||
| ### Developing CSS | ||
| - Requirements | ||
| - Git command line tools — follow the setup instructions on [GitHub](https://help.github.com/articles/set-up-git) or download [here](http://git-scm.com/downloads) | ||
| - [NodeJS installed](https://nodejs.org/en/download/releases/). Tested with node v6.3.1 & npm v5.5.1 | ||
| - Steps to follow | ||
| - Open gitbash (or any other command line shell of your choice, that supports git & node) & clone the repository | ||
|
|
||
| ```bash | ||
| git clone https://github.com/adobe/brackets.io.git | ||
| cd brackets.io | ||
| ``` | ||
|
|
||
| - Update the brackets-site-sass submodule | ||
|
|
||
| ```bash | ||
| git submodule update --init | ||
| ``` | ||
|
|
||
| - Change directory to the brackets-site-sass submodule | ||
|
|
||
| ```bash | ||
| cd dev | ||
| ``` | ||
|
|
||
| - Get the development dependencies for the submodule | ||
|
|
||
| ```bash | ||
| npm install | ||
|
There was a problem hiding this comment. Mention the node version with which you have tested . |
||
| ``` | ||
|
|
||
| The brackets-site-sass folder contains the scss folder, which contains the sass files that were used to develop the minified css(brackets.min.css). Any modification that needs to be made to the minified css must be made by compiling these scss files. | ||
|
|
||
| - And then run the auto-compile grunt task | ||
|
|
||
| ```bash | ||
| grunt watch | ||
| ``` | ||
|
|
||
| The above task will watch the _scss_ folder for any changes. Post this, you can modify the files in the scss folder and _brackets.min.css_ will be automatically generated in the css folder. | ||
|
|
||
| **Note:** You must keep the grunt task running for the automatic compilation to work, so don't close the | ||
| shell running the task. | ||
|
|
||
| **Note:** Also, test the new styles with brackets-registry as well, and update the minified css there as well. | ||
|
|
||
|
|
||
| ### Running brackets.io locally | ||
| - Requirements | ||
| - _http-server_ | ||
|
|
||
| ```bash | ||
| npm install -g http-server | ||
| ``` | ||
| - Steps to follow | ||
| - Open gitbash (or any other command line shell of your choice, that supports git & node) | ||
| - Change directory to local brackets.io repository | ||
| - Start the http-server | ||
|
|
||
| ```bash | ||
| http-server ./ | ||
| ``` | ||
|
|
||
| This will start a local http-server on the 8080 port. The site can then be viewed using **_http://localhost:8080_** in browser. | ||
|
|
||
| http-server can also be started with options for port, address etc. [Check the npm page for more details](https://www.npmjs.com/package/http-server) | ||
|
|
||
| **Note:** Chrome generally caches resources, and so sometimes, even on reloading, code changes are not reflected. In such a case, use the [Empty Cache and Hard Reload](http://www.thewindowsclub.com/empty-cache-hard-reload-chrome) option in Chrome. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Has the icon and the fonts below at lines 39 and 40 legally validated to be used in the site? Check with PgM once on the legal.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The favicon used is the existing one. I have not changed that.
As for the webfonts. They are served though Google fonts API, and are free to use in a commercial and Non-commercial project. https://developers.google.com/fonts/
All other icons used have been properly attributed for, in consultation with Legal