Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
955a7f8
Set up jsdoc (added dependencies, package script, config json, and cu…
sharanramjee Dec 29, 2021
a93825c
Added documentation/docs to .gitignore
sharanramjee Dec 29, 2021
3c5be91
Updated readme with documentation instructions and added documentatio…
sharanramjee Dec 30, 2021
0777fd5
Changed Slider component (not in use anywhere in the project) name to…
sharanramjee Dec 30, 2021
4a00617
Modified the include pattern to include .jsdoc and .jsx files
sharanramjee Dec 30, 2021
9fbab24
Added documentation for about.jsx and modified documentation for inde…
sharanramjee Dec 30, 2021
ae00044
Moved application content from application.jsx to content.json
sharanramjee Dec 30, 2021
aba6aff
Added documentation for application.jsx
sharanramjee Dec 30, 2021
ad402f6
Added documentation for challenges.jsx
sharanramjee Dec 30, 2021
247445b
Added documentation for countdown.jsx and a reference to Countdown in…
sharanramjee Dec 30, 2021
717ec4f
Added documentation for email-signup-widget.jsx and updated the docum…
sharanramjee Dec 30, 2021
987018f
Added documentation for faq.jsx
sharanramjee Dec 30, 2021
27b77ba
Added documentation for footer.jsx
sharanramjee Dec 30, 2021
7937cbe
Added documentation for home.jsx and updated documentation for countd…
sharanramjee Dec 30, 2021
564f42b
Added documentation for navbar.jsx and updated documentation for foot…
sharanramjee Dec 30, 2021
7cc0b36
Added documentation for projects.jsx and updated documentation for ho…
sharanramjee Dec 30, 2021
017ebcf
Added TODO to slider.jsx to delete the file in the future since it is…
sharanramjee Dec 30, 2021
e8cae61
Added documentation for sponsors.jsx
sharanramjee Dec 30, 2021
58d6c06
Added documentation for team.jsx
sharanramjee Dec 30, 2021
86db11e
Applied TreeHacks theme to custom-template
sharanramjee Jan 4, 2022
66ec86f
Merge branch 'website-2022' into add-documentation
marcopizarro Feb 1, 2022
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
/.pnp
.pnp.js

# documentation
/documentation/docs

# testing
/coverage

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ To run the site locally, run:
- `npm install`
- `npm start`

To generate documentation, run:
- `npm run doc`

Open `documentation/docs/index.html` to view the documentation.

## Directory Structure

Most of the important files for the site are in the '/src' directory.
Expand Down
2 changes: 1 addition & 1 deletion app.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "website-2019",
"name": "website-2022",
"scripts": {
},
"env": {
Expand Down
12 changes: 12 additions & 0 deletions documentation/custom-template/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://underscorejs.org/).


## Generating Typeface Fonts

The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows:

1. Open the [OpenSans page at Font Squirrel](<http://www.fontsquirrel.com/fonts/open-sans>).
2. Click on the 'Webfont Kit' tab.
3. Either leave the subset drop-down as 'Western Latin (Default)', or, if we decide we need more glyphs, than change it to 'No Subsetting'.
4. Click the 'DOWNLOAD @FONT-FACE KIT' button.
5. For each typeface variant we plan to use, copy the 'eot', 'svg' and 'woff' files into the 'templates/default/static/fonts' directory.
Loading