1. Project Overview & Quickstart (anuraghazra/content)
1. Project Overview & Quickstart (anuraghazra/content)
content
The official source for MDN Web Docs content. Home to over 14,000 pages of documentation about HTML, CSS, JS, HTTP, Web APIs, and more.
Repository Details
- Repository: anuraghazra/content
- GitHub Stars: β 10,908
- Primary Language: Markdown
Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.
2. Official Technical Reference & Guides (anuraghazra/anuraghazra.github.io)
Strained eyes? There's DarkMode too :p
NOTE: If you are using this site as a template for your own portfolio site, I would be very glad if you add a link to the original site with my name in footer
:rocket: Quick start
Run the site locally
NOTE: The default branch for this repo is develop, when you push or pull make sure you specify the correct branch
Step 1: Clone The Repo
Fork the repository. then clone the repo locally by doing -
git clone https://github.com/anuraghazra/anuraghazra.github.io.gitStep 2: Install Dependencies
cd into the directory
cd anuraghazra.github.ioinstall all the dependencies
npm installStep 3: Start Development Server
Then start the development Server
npm run developAfter running the development server the site should be running on https://localhost:8000
:open_file_folder: What's inside?
A quick look at the folder structure of this project.
.
βββ content
β ββββblog
β ββββcase-studies
β ββββjson
βββ cypress
βββ plugins
βββ src
ββββcomponents
β ββββAbout
β ββββBlog
β ββββcommon
β ββββConcepts
β ββββContact
β ββββCreativeCoding
β ββββHome
β ββββLayout
β β ββββNavbar
β ββββLightbox
β ββββProjects
β ββββSkills
ββββhooks
ββββpages
ββββstatic
β ββββimages
ββββstyles
ββββtemplatesTools Used
- Gatsby.js (of course)
- Styled Components for styling
- Cypress for E2E Testing
- Jest for Unit Testing
- TravisCI for CI/CD
:v: Contributing
NOTE: if you want to change the blog content or fix any typo you can do that from github's ui without cloning the repo locally
After cloning & setting up the local project you can push the changes to your github fork and make a pull request.
You can also run the tests locally to see if everything works fine with
Running tests
npm run test
npm run test:e2ePushing the changes
git add .
git commit -m "commit message"
git push YOUR_REPO_URL developMade with :heart: and Gatsbyjs
2. Official Technical Reference & Guides (anuraghazra/anuraghazra.github.io)
Strained eyes? There's DarkMode too :p
NOTE: If you are using this site as a template for your own portfolio site, I would be very glad if you add a link to the original site with my name in footer
:rocket: Quick start
Run the site locally
NOTE: The default branch for this repo is develop, when you push or pull make sure you specify the correct branch
Step 1: Clone The Repo
Fork the repository. then clone the repo locally by doing -
git clone https://github.com/anuraghazra/anuraghazra.github.io.gitStep 2: Install Dependencies
cd into the directory
cd anuraghazra.github.ioinstall all the dependencies
npm installStep 3: Start Development Server
Then start the development Server
npm run developAfter running the development server the site should be running on https://localhost:8000
:open_file_folder: What's inside?
A quick look at the folder structure of this project.
.
βββ content
β ββββblog
β ββββcase-studies
β ββββjson
βββ cypress
βββ plugins
βββ src
ββββcomponents
β ββββAbout
β ββββBlog
β ββββcommon
β ββββConcepts
β ββββContact
β ββββCreativeCoding
β ββββHome
β ββββLayout
β β ββββNavbar
β ββββLightbox
β ββββProjects
β ββββSkills
ββββhooks
ββββpages
ββββstatic
β ββββimages
ββββstyles
ββββtemplatesTools Used
- Gatsby.js (of course)
- Styled Components for styling
- Cypress for E2E Testing
- Jest for Unit Testing
- TravisCI for CI/CD
:v: Contributing
NOTE: if you want to change the blog content or fix any typo you can do that from github's ui without cloning the repo locally
After cloning & setting up the local project you can push the changes to your github fork and make a pull request.
You can also run the tests locally to see if everything works fine with
Running tests
npm run test
npm run test:e2ePushing the changes
git add .
git commit -m "commit message"
git push YOUR_REPO_URL developMade with :heart: and Gatsbyjs