Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fontawesome setup readme #472

Merged
merged 3 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ src/components/*
gulp-config.json
typings
.sass-cache/
.npmrc

# debug files
npm-debug.log
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ Note that compiled, minified css and js files are included within the repo. Cha
To enable BrowserSync, set `sync` to `true` and assign `syncTarget` the base URL of a site on your local WordPress instance that will use this theme, such as `http://localhost/wordpress/my-site/`. Your `syncTarget` value will vary depending on your local host setup.

The full list of modifiable config values can be viewed in `gulpfile.js` (see `config` variable).
4. Run `gulp default` to process front-end assets.
5. If you haven't already done so, create a new WordPress site on your development environment, and [install and activate theme dependencies](#installation-requirements).
6. Set Main Site Theme as the active theme.
7. Make sure you've completed [all theme configuration steps](#configuration).
8. Run `gulp watch` to continuously watch changes to scss and js files. If you enabled BrowserSync in `gulp-config.json`, it will also reload your browser when scss or js files change.
4. Optional: If you'd like to enable Font Awesome 6 Pro, you should copy the code from template.npmrc and paste it into the .npmrc file in the root directory. Then run `npm install --save-optional @fortawesome/fontawesome-pro` in the terminal to install the package in the local node_modules.
5. Run `gulp default` to process front-end assets.
6. If you haven't already done so, create a new WordPress site on your development environment, and [install and activate theme dependencies](#installation-requirements).
7. Set Main Site Theme as the active theme.
8. Make sure you've completed [all theme configuration steps](#configuration).
9. Run `gulp watch` to continuously watch changes to scss and js files. If you enabled BrowserSync in `gulp-config.json`, it will also reload your browser when scss or js files change.
19 changes: 19 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,8 @@
],
"dependencies": {
"gulp-cli": "^2.3.0"
},
"optionalDependencies": {
"@fortawesome/fontawesome-pro": "^6.5.2"
}
}
6 changes: 6 additions & 0 deletions template.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# FontAwesome v6-pro setup instruction.
# Copy the following lines into .npmrc in the root directory, then replace the ${FONTAWESOME_PACKAGE_TOKEN} with your token.

# @awesome.me:registry=https://npm.fontawesome.com/
# @fortawesome:registry=https://npm.fontawesome.com/
# //npm.fontawesome.com/:_authToken=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX