Skip to content

Commit

Permalink
feat(chore)!: less
Browse files Browse the repository at this point in the history
BREAKING CHNANGE: Move section contents to details array

* Add less as output method
* Add Settings paramter to all sections
* Add details to all sections
* Details now hold each section content
  • Loading branch information
coolapso committed Jun 6, 2024
1 parent 6dfed1f commit 7ae282b
Show file tree
Hide file tree
Showing 4 changed files with 193 additions and 115 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ Live example at: https://coolapso.sh
* **version:** Shows the website version
* Disabled by default
* only enabled if provided a version parameter
* Less, print commands output with less
* Global, all commands use less instead of standard output
* Per command, only defined commands use less as output method
* `less <command>`, will output using less instead of standard output
* Command auto completion
* progression bars can be interrupted by pressing `ctrl+d`
* Favicons
Expand Down
214 changes: 119 additions & 95 deletions exampleSite/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ params:
# promptSimbolsColor: grey
# startxLocation: https://example.com
# hideSocialName: true
# exitLocation: 'about:blank'
# hidesource: true
# useLess: true
exitLocation: 'about:blank'
source: true
greeting: |
Welcome to my online resume
Expand All @@ -21,6 +22,9 @@ params:
whois:
# settings:
# useLess: true
details:
name: "John Doe"
profession: "Unknown"
location: "Somewhere"
Expand All @@ -30,113 +34,133 @@ params:
Here you can write something catchy about yourself
social:
## IF you want to keep them aligned just add spaces
- name: "github"
url: " https://github.com"
- name: "facebook"
url: " https://facebook.com"
- name: "myspace"
url: " https://myspace.com"
- name: "hi5"
url: " https://www.hi5.com"
- name: "instagram"
url: " https://instagram.com"
- name: "Another social"
url: " https://anothersocial.com"
# settings:
# useLess: true
details:
## IF you want to keep them aligned just add spaces
- name: "github"
url: " https://github.com"
- name: "facebook"
url: " https://facebook.com"
- name: "myspace"
url: " https://myspace.com"
- name: "hi5"
url: " https://www.hi5.com"
- name: "instagram"
url: " https://instagram.com"
- name: "Another social"
url: " https://anothersocial.com"

work:
- jobTitle: Job With Red Title
color: red
company: '-'
location: somewhere
date: August 2010 - Present
description: Some description about this red title job

- jobTitle: Job with purple title
color: purple
company: '-'
location: somewhere elese
date: July 2000 - July 2010
description: Some description about this purple job

- jobTitle: Job with default color title
company: '-'
location: anywhere
date: July 2008 - 2010
description: Description about this default color job

education:
- courseName: Red Color training
color: red
date: June 2019 - July 2019
description: Descrption about red color trianing

- courseName: Default color training
date: Sept 2004 - Jun 2008
#description: There is no need for description
# settings:
# useLess: true
details:
- jobTitle: Job With Red Title
color: red
company: '-'
location: somewhere
date: August 2010 - Present
description: Some description about this red title job

- jobTitle: Job with purple title
color: purple
company: '-'
location: somewhere elese
date: July 2000 - July 2010
description: Some description about this purple job

- jobTitle: Job with default color title
company: '-'
location: anywhere
date: July 2008 - 2010
description: Description about this default color job

education:
- courseName: Red Color training
color: red
date: June 2019 - July 2019
description: Descrption about red color trianing

- courseName: Default color training
date: Sept 2004 - Jun 2008
#description: There is no need for description

skills:
- name: Skill 1
percentage: 90
Description: you can add a description

- name: Skill 2
percentage: 30
#description: or you can leave it comented

- name: Skill 3
color: blue
percentage: 50
description: Skill names can have colors too

softskills:
- name: SoftSkill 1
color: red
percentage: 80
#description:

- name: SoftSkill 2
#color:
percentage: 90
description: Description
settings:
useLess: true
details:
- name: Skill 1
percentage: 90
Description: you can add a description

- name: Skill 2
percentage: 30
#description: or you can leave it comented

- name: Skill 3
color: blue
percentage: 50
description: Skill names can have colors too

softskills:
- name: SoftSkill 1
color: red
percentage: 80
#description:

- name: SoftSkill 2
#color:
percentage: 90
description: Description

languages:
- name: English
color: Blue
percentage: 50
#description:
# settings:
# useLess: true
details:
- name: English
color: Blue
percentage: 50
#description:

- name: Gibberish
percentage: 100
description: pasghettipigglywiggly
- name: Gibberish
percentage: 100
description: pasghettipigglywiggly


projects:
- title: Project Red
color: red
date: since 2019
link: https://example.com
description: Describing red stuff

- title: Project Blue
color: blue
date: since 2016
link: https://example.com/blue
#description: nothing to describe

- title: Project Default
date: Since 2017
link: https://example.com/default
#description: not there either
# settings:
# useLess: true
details:
- title: Project Red
color: red
date: since 2019
link: https://example.com
description: Describing red stuff

- title: Project Blue
color: blue
date: since 2016
link: https://example.com/blue
#description: nothing to describe

- title: Project Default
date: Since 2017
link: https://example.com/default
#description: not there either

certifications:
- certName: Example Cert
company: Example Certifying Company
date: Date of Completion
#description: Lorem Ipsum
# settings:
# useLess: true
details:
- certName: Example Cert
company: Example Certifying Company
date: Date of Completion
#description: Lorem Ipsum

misc:
#commandName: newcommand
# settings:
# useLess: true
commandName: newcommand
title: "This Section can have a different command name"
titleColor: teal
content: |
Expand Down
Loading

0 comments on commit 7ae282b

Please sign in to comment.