Documentation forAver - TailwindCSS Personal Portfolio Template
Files Structure & Setup
Follow the steps below to get started with your Site Template:
- Open the
template-filesFolder to find all the Templates Files - You will need to Upload these files and folders on your Web Server to use it on your Website.
- Make sure you upload the required files/folders listed below:
template-files/source/fonts- Directory of Local Fonts Filestemplate-files/source/images- Directory of Images filestemplate-files/source/plugins- Directory of Pluginstemplate-files/source/scripts- Directory of JavaScripts filestemplate-files/source/styles- Directory of Main Stylesheet Filestemplate-files/*.html- Html Files
All codes are commented in the HTML files for your convenience. Please check the code comments for more details.
Installation
Checkout Official TailwindCSS Documentation if you need.
System Requirements
- Node.js 16.8.0 or later
- MacOS, Windows (including WSL), and Linux are supported
Install dependencies in your project:
Nevigate to `template-files/` then open terminal and install dependencies by running
npm install
# or
yarn # if you have Yarn installed
Run `npm run dev` or `yarn dev`
to start development server in your local machine
npm run dev
# or
yarn dev # if you have Yarn installed
Now you can use LiveServer in your VSCode
or directly open your HTML file in your browser to see preview.
Html Structure
Favicon Changing
Logo Changing
Update the image src or replace the image from `source/images/` directory
Contact form Update
Update contact email at main.js file.
CSS Files & Structure
CSS Files
Changing Font
This template uses total 2 fonts 'Outfit' Font family from the Google Fonts Library and 'Melodrama' As local font. To change the Font, you will need to Edit the root variable in 'base.css' file.
Javascript Files & Structure
Javascript Files
Sources & Credits
I've used the following images, icons or other files as listed.
- TailwindCSS
- Google Fonts
- unsplash(Photos)