Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.56 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.56 KB
Raw

Portfolio Generator

Go Report Card

📚 Table of Contents

  1. Project Structure
  2. Getting Started
  3. Styles
  4. Live Example

Project Structure

📂 portfolio-ssg
├── README.md
├── examples
    ├── data.json
├── generate.go
├── styles.css
└── portfolio.tmpl

Getting Started

Run each command line-by-line in your terminal to set up the project:

git clone [email protected]:tsamantanis/portfolio-ssg.git
cd portfolio-ssg

Single File 📄

To generate a retro style portfolio from a single file use:

go run generate.go --file=PATH_TO_FILE

replacing PATH_TO_FILE with the relative path to a .json file of your choosing. Place your .json file within the data directory for optimal results.

Folder 📂

To generate multiple portfolio files from a directory use:

go run generate.go --dir=PATH_TO_DIRECTORY

replacing PATH_TO_DIRECTORY with the relative path to a directory which contains .json files. The directory can contain sub-directories.

Styles 🎨

You can edit the styles.css file to add your own styles. View an example of a retro styled portfolio page here

Live Example

You can view a live example of this readme file generated using this portfolio generator here