Readme
This commit is contained in:
116
README.md
Normal file
116
README.md
Normal file
@@ -0,0 +1,116 @@
|
||||
# Portfolio Website
|
||||
|
||||
This repository hosts my personal website and project portfolio.
|
||||
|
||||
The site is built with [Hugo](https://gohugo.io/), a fast static site generator, and is intended to showcase my work, projects, background, and selected professional information in a simple and maintainable format.
|
||||
|
||||
## Purpose
|
||||
|
||||
This website is meant to:
|
||||
|
||||
- present my portfolio projects
|
||||
- highlight my skills, experience, and interests
|
||||
- provide a central place to share information about my work
|
||||
- serve as the public source for my personal website
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- Framework: Hugo
|
||||
- Output: Static website
|
||||
- Language: Markdown for content, templates for layout
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Install Hugo before running the site locally.
|
||||
|
||||
- Hugo installation guide: [https://gohugo.io/installation/](https://gohugo.io/installation/)
|
||||
|
||||
To verify your installation:
|
||||
|
||||
```bash
|
||||
hugo version
|
||||
```
|
||||
|
||||
### Run Locally
|
||||
|
||||
Start the development server with:
|
||||
|
||||
```bash
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
Then open:
|
||||
|
||||
```text
|
||||
http://localhost:1313
|
||||
```
|
||||
|
||||
The `-D` flag includes draft content during local development.
|
||||
|
||||
## Build for Production
|
||||
|
||||
Generate the static site with:
|
||||
|
||||
```bash
|
||||
hugo
|
||||
```
|
||||
|
||||
The generated files will be placed in the `public/` directory.
|
||||
|
||||
## Project Structure
|
||||
|
||||
Typical Hugo projects use a structure similar to the following:
|
||||
|
||||
```text
|
||||
.
|
||||
├── archetypes/
|
||||
├── assets/
|
||||
├── content/
|
||||
├── layouts/
|
||||
├── static/
|
||||
├── themes/
|
||||
├── config.toml
|
||||
└── README.md
|
||||
```
|
||||
|
||||
Depending on the Hugo version and configuration style, the main config file may also be named `hugo.toml`, `hugo.yaml`, or `hugo.json`.
|
||||
|
||||
## Content Management
|
||||
|
||||
Portfolio content is generally managed through the `content/` directory. Typical updates include:
|
||||
|
||||
- adding new project pages
|
||||
- editing homepage and about page content
|
||||
- updating images and downloadable assets in `static/`
|
||||
- adjusting layouts and partials in `layouts/`
|
||||
|
||||
To create a new content page:
|
||||
|
||||
```bash
|
||||
hugo new content/projects/my-project.md
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
This project is intended to be deployed as a static website.
|
||||
|
||||
Typical deployment options include:
|
||||
|
||||
- GitHub Pages
|
||||
- Netlify
|
||||
- Vercel
|
||||
- any static file hosting provider
|
||||
|
||||
Deployment generally consists of building the site with Hugo and publishing the contents of the `public/` directory.
|
||||
|
||||
## Notes
|
||||
|
||||
- keep content in Markdown for simple maintenance
|
||||
- use Hugo templates and partials to keep layouts reusable
|
||||
- review generated pages locally before publishing changes
|
||||
|
||||
## License
|
||||
|
||||
This repository contains the source code and content for my personal website. Reuse terms can be added here if needed.
|
||||
Reference in New Issue
Block a user