Skip to content

Commit

Permalink
add: [comments in HTML + documentation in README] on editing contents.
Browse files Browse the repository at this point in the history
  • Loading branch information
@nisarhassan12
nisarhassan12 committed May 9, 2020
1 parent 64fb6ea commit 363e102
Show file tree
Hide file tree
Showing 3 changed files with 481 additions and 225 deletions.
227 changes: 226 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1 +1,226 @@
# porfolio-template
# Portfolio Template

### A beautiful minimal and accessible portfolio template for Developers.

View the live Demo here →

## Features

- Clean, Simple and Modern UI Design.
- Fully Accessible.
- Fully Responsive.
- Lightinig fast.
- Uses No Frameworks or libraries as dependencies.
- Well Organized Documentation.

## Getting Started 🚀

You'll need [Git](https://git-scm.com) to be installed on your computer.
```
# Clone this repository
$ git clone https://github.com/nisarhassan12/portfolio-template
```

If you don't have Git installed or you don't like using the terminal then you can download the [zip](https://github.com/nisarhassan12/portfolio-template/archive/master.zip) and extract that and open the extracted folder in the code editor of your your choice.

## Editing the Template 🔨

Go to `index.html` and fill your information.

### Header

In all of the places where you're supposed to fill your information you'll find HTML comments. As shown below just replace what is already in the opening and closing tags below the comment with your information.

```html
<div class="header__text-box row">
<div class="header__text">
<h1 class="heading-primary">
<!-- Replace the following name with your name -->
<span>Syed Ali Hussnain</span>
</h1>
<!-- Put a small paragraph about yourself -->
<p>A Web Developer based in Lahore, Pakistan.</p>
<a href="#contact" class="btn btn--pink">Get in touch</a>
</div>
</div>
```

### Work Section

Each div with class `work__box` represents a project, replace the contents of the all the tags with the information of your projects.

```html
<div class="work__box">
<div class="work__text">
<h3>Portfolio Template</h3>
<p>
A free Open Source Portfolio for anyone to use for free.
</p>
<ul class="work__list">
<li>HTML</li>
<li>SCSS</li>
<li>JavaScript</li>
<li>Parcel</li>
</ul>

<div class="work__links">
<a href="#" class="link__text">
Visit Site <span>&rarr;</span>
</a>
<a href="https://github.com/nisarhassan12/portfolio" target="_blank">
<img src="./images/github.svg" class="work__code" alt="GitHub">
</a>
</div>
</div>
<div class="work__image-box">
<img
src="./images/project-1.png"
class="work__image"
alt="Project 1"
/>
</div>
</div>
```

For changing the screenshot:
- first place the image in `images/` folder and then in HTML replace the name in `src` with the name of your image.

- Recommended size for project image (1366 x 767px) also make sure the size of all project images is the same.

```html
<img
src="./images/name-of-your-image.png"
class="work__image"
alt="Project 1"
/>
```

### Clients Section

- Place the logos of the clients and companies that you have worked with in `images/` directory and then replace the name in `src` with the name of your logos accordingly.

- Make sure that you don't have whitespace on either side of the logos.

```html
<img
src="./images/your-logo.png"
class="client__logo"
alt="Your Logo"
/>
```

### About Section

- Replace the contents in the below paragraph with information about yourself.
- Place a nice photo of yourself in the `images/` directory and then change the name in the src with your image name.

```html
<section class="about" id="about">
<div class="row">
<h2>About Me</h2>
<div class="about__content">
<div class="about__text">
<!-- Replace the below paragraph with info about yourself -->
<p>
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Eos id
nostrum illo harum blanditiis, tenetur eum suscipit cupiditate
in vel, ex quam quidem quos mollitia labore aut sunt eius
ratione molestiae fuga veniam facere similique voluptate. Rerum
facilis numquam veritatis accusamus eligendi tempora illum omnis
temporibus quos cupiditate id deleniti, illo labore iure optio
ex, consequuntur fugit quia.
</p>
<!-- Provide a link to your resume -->
<a href="#" class="btn">My Resume</a>
</div>

<div class="about__photo-container">
<!-- Add a nice photo of yourself -->
<img
class="about__photo"
src="./images/syed-ali-hussnain.jpg"
alt=""
/>
</div>
</div>
</div>
</section>
```

### Contact Section

- Modify the paragraph to your likings.
- Replace the email with yours in the `href` anchor property and the text also.

```html
<section class="contact" id="contact">
<div class="row">
<h2>Get in Touch</h2>
<div class="contact__info">
<p>
Are you looking for a fast-performing and user-friendly website to
represent your product or business? or looking for any kind of
consultation? or want to ask questions? or have some advice for me
or just want to say "Hi 👋" in any case feel free to Let me know. I
will do my best to respond back. 😊 The quickest way to reach out to
me is via an email.
</p>
<!-- Replace the email with yours -->
<a href="mailto:[email protected]" class="btn">[email protected]</a>
</div>
</div>
</section>
```

### Footer

- Replace the `href` attribute values to your profile URLs for all anchors.
- Remove the div with class `footer__github-buttons`.

```html
<footer role="contentinfo" class="footer">
<div class="row">
<!-- Update the links to point to your accounts -->
<ul class="footer__social-links">
<li class="footer__social-link-item">
<a href="https://twitter.com/nisarhassan12/">
<img src="./images/twitter.svg" class="footer__social-image" alt="Twitter">
</a>
</li>
<li class="footer__social-link-item">
<a href="https://github.com/nisarhassan12/">
<img src="./images/github.svg" class="footer__social-image" alt="Github">
</a>
</li>
<li class="footer__social-link-item">
<a href="https://codepen.io/nisar_hassan">
<img src="./images/codepen.svg" class="footer__social-image" alt="Codepen">
</a>
</li>
<li class="footer__social-link-item">
<a href=https://www.linkedin.com/in/nisar-hassan-naqvi-413466199/">
<img src="./images/linkedin.svg" class="footer__social-image" alt="Linkedin">
</a>
</li>
</ul>
<!-- If you give me some credit by keeping the below paragraph, will be huge for me 😊 Thanks. -->
<p>
&copy; 2020 - Template designed & developed by <a href="https://nisar.dev">Nisar</a>.
</p>
<div class="footer__github-buttons">
<iframe
src="https://ghbtns.com/github-btn.html?user=nisarhassan12&repo=portfolio-template&type=watch&count=true"
frameborder="0" scrolling="0" width="170" height="20" title="Watch Portfolio Template on GitHub">
</iframe>
</div>
</div>
</footer>
```
17 changes: 17 additions & 0 deletions index.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,11 @@ a {
margin-bottom: 25rem;
}

.work__links {
display: flex;
align-items: center;
}

.work__text {
flex: 0 0 30%;
}
Expand All @@ -427,6 +432,12 @@ a {
margin-bottom: var(--gutter-normal);
}

.work__code {
display: block;
height: 3rem;
margin-left: var(--gutter-normal);
}

.work__image-box {
margin-bottom: var(--gutter-normal);
}
Expand All @@ -438,6 +449,12 @@ a {
}
}

@media(max-width: 900px) {
.work__code {
height: 4rem;
}
}

/* --------------------------------------- */
/* ----- Clients ----- */
/* --------------------------------------- */
Expand Down
Loading

0 comments on commit 363e102

Please sign in to comment.