content Documentation

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.

11,069 stars Markdown Markdown 1 file Β· ~14,668 tokens #css#documentation#html#http#javascript#learning#mdn#reference
RAW Doc

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

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 -

bash
git clone https://github.com/anuraghazra/anuraghazra.github.io.git

Step 2: Install Dependencies

cd into the directory

bash
cd anuraghazra.github.io

install all the dependencies

bash
npm install

Step 3: Start Development Server

Then start the development Server

text
npm run develop

After 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.

text
.
β”œβ”€β”€ 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
    └───templates

Tools Used

  1. Gatsby.js (of course)
  2. Styled Components for styling
  3. Cypress for E2E Testing
  4. Jest for Unit Testing
  5. 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

bash
npm run test
npm run test:e2e

Pushing the changes

bash
git add .
git commit -m "commit message"
git push YOUR_REPO_URL develop

Made 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 -

bash
git clone https://github.com/anuraghazra/anuraghazra.github.io.git

Step 2: Install Dependencies

cd into the directory

bash
cd anuraghazra.github.io

install all the dependencies

bash
npm install

Step 3: Start Development Server

Then start the development Server

text
npm run develop

After 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.

text
.
β”œβ”€β”€ 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
    └───templates

Tools Used

  1. Gatsby.js (of course)
  2. Styled Components for styling
  3. Cypress for E2E Testing
  4. Jest for Unit Testing
  5. 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

bash
npm run test
npm run test:e2e

Pushing the changes

bash
git add .
git commit -m "commit message"
git push YOUR_REPO_URL develop

Made with :heart: and Gatsbyjs