diff options
author | Baptiste Jacquemet <baptiste.jacquemet@gmail.com> | 2019-05-06 20:01:14 +0300 |
---|---|---|
committer | Baptiste Jacquemet <baptiste.jacquemet@gmail.com> | 2019-05-06 20:01:14 +0300 |
commit | d477c50e6c8fc1784752193f3039f1f090042ecf (patch) | |
tree | d1ff092b687b6940ce3dbb9ae89ce0f0ab925678 | |
parent | f2ba58a04e99083a0b4d4620fe46cef11df2d868 (diff) |
change folder structure and add basic help posts
-rw-r--r-- | LICENSE (renamed from themes/LICENSE) | 0 | ||||
-rw-r--r-- | README.md | 3 | ||||
-rw-r--r-- | archetypes/default.md (renamed from themes/archetypes/default.md) | 0 | ||||
-rw-r--r-- | archetypes/portfolio.md (renamed from themes/archetypes/portfolio.md) | 0 | ||||
-rw-r--r-- | archetypes/post.md (renamed from themes/archetypes/post.md) | 0 | ||||
-rw-r--r-- | assets/sass/_mixins.sass (renamed from themes/assets/sass/_mixins.sass) | 0 | ||||
-rw-r--r-- | assets/sass/_variables.sass (renamed from themes/assets/sass/_variables.sass) | 0 | ||||
-rw-r--r-- | assets/sass/custom.sass (renamed from themes/assets/sass/custom.sass) | 0 | ||||
-rw-r--r-- | assets/sass/scaffold.sass (renamed from themes/assets/sass/scaffold.sass) | 0 | ||||
-rw-r--r-- | assets/syntax.css (renamed from themes/assets/syntax.css) | 0 | ||||
-rw-r--r-- | config.toml | 94 | ||||
-rw-r--r-- | content/post/_index.md | 6 | ||||
-rw-r--r-- | content/post/config-file.md | 107 | ||||
-rw-r--r-- | content/post/getting-started.md | 15 | ||||
-rw-r--r-- | content/post/portfolio-definition.md | 31 | ||||
-rw-r--r-- | content/post/shortcodes.md | 30 | ||||
-rw-r--r-- | exampleSite/config.toml | 8 | ||||
-rw-r--r-- | exampleSite/content/_index.md (renamed from content/_index.md) | 0 | ||||
-rw-r--r-- | exampleSite/content/about.md (renamed from content/about.md) | 0 | ||||
-rw-r--r-- | exampleSite/content/portfolio/_index.md | 6 | ||||
-rw-r--r-- | exampleSite/content/portfolio/sample-project/index.md (renamed from content/portfolio/sample-project/index.md) | 0 | ||||
-rw-r--r-- | exampleSite/content/portfolio/sample-project/john.jpg (renamed from content/portfolio/sample-project/john.jpg) | bin | 4965 -> 4965 bytes | |||
-rw-r--r-- | exampleSite/content/portfolio/sample-project/sample.jpg (renamed from content/portfolio/sample-project/sample.jpg) | bin | 85860 -> 85860 bytes | |||
-rw-r--r-- | exampleSite/content/post/archetypes.md (renamed from content/post/archetypes.md) | 0 | ||||
-rw-r--r-- | exampleSite/content/post/config-file.md | 176 | ||||
-rw-r--r-- | exampleSite/content/post/config_file.md | 100 | ||||
-rw-r--r-- | exampleSite/content/post/define-specific-og-image.md (renamed from content/post/define-specific-og-image.md) | 0 | ||||
-rw-r--r-- | exampleSite/content/post/getting-started.md | 18 | ||||
-rw-r--r-- | exampleSite/content/post/images/portfolio-example.png (renamed from content/post/images/portfolio-example.png) | bin | 1083052 -> 1083052 bytes | |||
-rw-r--r-- | exampleSite/content/post/images/sample_image.jpg (renamed from content/post/images/sample_image.jpg) | bin | 66575 -> 66575 bytes | |||
-rw-r--r-- | exampleSite/content/post/manage-your-menu.md (renamed from content/post/manage-your-menu.md) | 1 | ||||
-rw-r--r-- | exampleSite/content/post/portfolio-definition.md | 41 | ||||
-rw-r--r-- | exampleSite/content/post/shortcodes.md | 31 | ||||
-rw-r--r-- | exampleSite/static/images/gopher.png | bin | 0 -> 60711 bytes | |||
-rw-r--r-- | exampleSite/static/images/sample.jpg (renamed from static/images/sample.jpg) | bin | 85860 -> 85860 bytes | |||
-rw-r--r-- | layouts/404.html (renamed from themes/layouts/404.html) | 0 | ||||
-rw-r--r-- | layouts/_default/baseof.html (renamed from themes/layouts/_default/baseof.html) | 0 | ||||
-rw-r--r-- | layouts/_default/li.html (renamed from themes/layouts/_default/li.html) | 0 | ||||
-rw-r--r-- | layouts/_default/list.html (renamed from themes/layouts/_default/list.html) | 0 | ||||
-rw-r--r-- | layouts/_default/single.html (renamed from themes/layouts/_default/single.html) | 0 | ||||
-rw-r--r-- | layouts/designs/list.html (renamed from themes/layouts/designs/list.html) | 0 | ||||
-rw-r--r-- | layouts/designs/terms.html (renamed from themes/layouts/designs/terms.html) | 0 | ||||
-rw-r--r-- | layouts/index.html (renamed from themes/layouts/index.html) | 0 | ||||
-rw-r--r-- | layouts/partials/breadcrumb.html (renamed from themes/layouts/partials/breadcrumb.html) | 0 | ||||
-rw-r--r-- | layouts/partials/footer.html (renamed from themes/layouts/partials/footer.html) | 0 | ||||
-rw-r--r-- | layouts/partials/head/head.html (renamed from themes/layouts/partials/head/head.html) | 0 | ||||
-rw-r--r-- | layouts/partials/head/meta.html (renamed from themes/layouts/partials/head/meta.html) | 0 | ||||
-rw-r--r-- | layouts/partials/head/style.html (renamed from themes/layouts/partials/head/style.html) | 0 | ||||
-rw-r--r-- | layouts/partials/header.html (renamed from themes/layouts/partials/header.html) | 0 | ||||
-rw-r--r-- | layouts/partials/portfolio/item.html (renamed from themes/layouts/partials/portfolio/item.html) | 0 | ||||
-rw-r--r-- | layouts/partials/portfolio/tags.html (renamed from themes/layouts/partials/portfolio/tags.html) | 0 | ||||
-rw-r--r-- | layouts/partials/portfolio/testimonial.html (renamed from themes/layouts/partials/portfolio/testimonial.html) | 0 | ||||
-rw-r--r-- | layouts/partials/post/information.html (renamed from themes/layouts/partials/post/information.html) | 0 | ||||
-rw-r--r-- | layouts/partials/post/item.html (renamed from themes/layouts/partials/post/item.html) | 0 | ||||
-rw-r--r-- | layouts/partials/sidebar/menu.html (renamed from themes/layouts/partials/sidebar/menu.html) | 0 | ||||
-rw-r--r-- | layouts/partials/sidebar/sidebar.html (renamed from themes/layouts/partials/sidebar/sidebar.html) | 0 | ||||
-rw-r--r-- | layouts/partials/sidebar/social.html (renamed from themes/layouts/partials/sidebar/social.html) | 0 | ||||
-rw-r--r-- | layouts/partials/sidebar/style.html (renamed from themes/layouts/partials/sidebar/style.html) | 0 | ||||
-rw-r--r-- | layouts/partials/svg.html (renamed from themes/layouts/partials/svg.html) | 0 | ||||
-rw-r--r-- | layouts/portfolio/list.html (renamed from themes/layouts/portfolio/list.html) | 0 | ||||
-rw-r--r-- | layouts/portfolio/single.html (renamed from themes/layouts/portfolio/single.html) | 0 | ||||
-rw-r--r-- | layouts/post/list.html (renamed from themes/layouts/post/list.html) | 0 | ||||
-rw-r--r-- | layouts/post/single.html (renamed from themes/layouts/post/single.html) | 0 | ||||
-rw-r--r-- | layouts/robots.txt (renamed from themes/layouts/robots.txt) | 0 | ||||
-rw-r--r-- | layouts/shortcodes/emoji.html (renamed from themes/layouts/shortcodes/emoji.html) | 0 | ||||
-rw-r--r-- | layouts/shortcodes/tweet-single.html (renamed from themes/layouts/shortcodes/tweet-single.html) | 0 | ||||
-rw-r--r-- | layouts/techs/list.html (renamed from themes/layouts/techs/list.html) | 0 | ||||
-rw-r--r-- | layouts/techs/terms.html (renamed from themes/layouts/techs/terms.html) | 0 | ||||
-rw-r--r-- | package-lock.json (renamed from themes/package-lock.json) | 0 | ||||
-rw-r--r-- | package.json (renamed from themes/package.json) | 0 | ||||
-rw-r--r-- | static/images/default-sidebar.jpg (renamed from themes/static/images/default-sidebar.jpg) | bin | 77847 -> 77847 bytes | |||
-rw-r--r-- | static/images/edna-west.jpg (renamed from themes/static/images/edna-west.jpg) | bin | 3473 -> 3473 bytes | |||
-rw-r--r-- | static/images/gohper.png (renamed from themes/static/images/gohper.png) | bin | 61765 -> 61765 bytes | |||
-rw-r--r-- | theme.toml | 2 | ||||
-rw-r--r-- | themes/README.md | 2 |
75 files changed, 273 insertions, 398 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..fca36c5 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Personal Web + +Personal Web is a simple Hugo template to build a personal website including portfolio and blog sections. It will mainly suit freelancers who want to showcase their work. diff --git a/themes/archetypes/default.md b/archetypes/default.md index 1151933..1151933 100644 --- a/themes/archetypes/default.md +++ b/archetypes/default.md diff --git a/themes/archetypes/portfolio.md b/archetypes/portfolio.md index 44fc903..44fc903 100644 --- a/themes/archetypes/portfolio.md +++ b/archetypes/portfolio.md diff --git a/themes/archetypes/post.md b/archetypes/post.md index 0cb07c1..0cb07c1 100644 --- a/themes/archetypes/post.md +++ b/archetypes/post.md diff --git a/themes/assets/sass/_mixins.sass b/assets/sass/_mixins.sass index a5d575c..a5d575c 100644 --- a/themes/assets/sass/_mixins.sass +++ b/assets/sass/_mixins.sass diff --git a/themes/assets/sass/_variables.sass b/assets/sass/_variables.sass index c3deae8..c3deae8 100644 --- a/themes/assets/sass/_variables.sass +++ b/assets/sass/_variables.sass diff --git a/themes/assets/sass/custom.sass b/assets/sass/custom.sass index 48f2b8d..48f2b8d 100644 --- a/themes/assets/sass/custom.sass +++ b/assets/sass/custom.sass diff --git a/themes/assets/sass/scaffold.sass b/assets/sass/scaffold.sass index b061886..b061886 100644 --- a/themes/assets/sass/scaffold.sass +++ b/assets/sass/scaffold.sass diff --git a/themes/assets/syntax.css b/assets/syntax.css index 681758d..681758d 100644 --- a/themes/assets/syntax.css +++ b/assets/syntax.css diff --git a/config.toml b/config.toml deleted file mode 100644 index fc7f912..0000000 --- a/config.toml +++ /dev/null @@ -1,94 +0,0 @@ -baseURL = "https://example.com/" -languageCode = "en-us" -title = "Edna West" -theme = "" -copyright="© Edna West" -googleAnalytics = "" -enableEmoji=true -enableRobotsTXT=true -pygmentsUseClasses=true -pygmentsCodeFences=true - -[params.intro] - main = "Hi, I'm Edna :wave:" - sub = "I'm a Web Developer and Entrepreneur" - -[taxonomies] - design = "designs" - tech = "techs" - -[blackfriday] - hrefTargetBlank = true - -[params] - breadcrumb = true - accentColor = "#FD3519" - -[params.notFound] - gopher = "/images/gopher.png" # checkout https://gopherize.me/ - h1 = 'Bummer!' - p = "It seems that this page doesn't exist." - mainSection = 'portfolio' # values: [post, portfolio] only accept one section, to be displayed bellow 404 - -[params.sections] - # Define how your sections will be called - # when automatically pulled. For instance in the 404 page - post = "article" - portfolio = "project" - -[params.sidebar] - backgroundImage = '' # header background image - default "/images/default_sidebar.jpg" - Photo by Tim Marshall on Unsplash - gradientOverlay = '' # default: rgba(0,0,0,0.4),rgba(0,0,0,0.4) - logo = "" # - default "/images/edna-west.jpg" -[params.assets] - favicon = "" - customCSS = "" - -[params.social] - github = "https://github.com/" - twitter = "https://twitter.com/" - linkedin = "https://www.linkedin.com/in/" - -[params.contact] - email = "" - text= "" # text of the contact link in the sidebar. If email params.contact.email is defined - - -[menu] - -[[menu.main]] - identifier = "about" - name = "About" - title = "About section" - url = "/about/" - weight = -120 - -[[menu.main]] - identifier = "portfolio" - name = "Portfolio" - title = "Portfolio" - url = "/portfolio/" - weight = -110 - -[[menu.main]] - identifier = "blog" - name = "Post" - title = "Blog section" - url = "/post/" - weight = -100 - -[sitemap] - changefreq = "monthly" - filename = "sitemap.xml" - priority = 0.5 - -[privacy] - [privacy.googleAnalytics] - anonymizeIP = true - disable = true - respectDoNotTrack = true - useSessionStorage = false - [privacy.twitter] - disable = false - enableDNT = true - simple = false
\ No newline at end of file diff --git a/content/post/_index.md b/content/post/_index.md deleted file mode 100644 index ed1dc5f..0000000 --- a/content/post/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: POST -description: 'Posts Section' ---- - -You'll add here a general introduction of your posts.
\ No newline at end of file diff --git a/content/post/config-file.md b/content/post/config-file.md deleted file mode 100644 index 1c5de24..0000000 --- a/content/post/config-file.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "Config File" -date: 2019-04-20T16:18:12+01:00 -publishDate: 2019-04-20T19:12:12+01:00 ---- - -Here is the basic config file used for personal_web. - -You can use it as a base for your website. - -<!--more--> - -```TOML -baseURL = "https://example.com/" -languageCode = "en-us" -title = "Edna West" -theme = "personal_web" -copyright="© Edna West" -googleAnalytics = "" -enableEmoji=true -enableRobotsTXT=true -pygmentsUseClasses=true -pygmentsCodeFences=true - -[params.intro] - main = "Hi, I'm Edna :wave:" - sub = "I'm a Web Developer and Entrepreneur" - -[taxonomies] - design = "designs" - tech = "techs" - -[blackfriday] - hrefTargetBlank = true - -[params] - breadcrumb = true - accentColor = "#FD3519" - -[params.notFound] - gopher = "/images/gopher.png" - h1 = 'Bummer!' - p = "It seems that this page doesn't exist." - mainSection = 'portfolio' - -[params.sections] - post = "article" - portfolio = "project" - -[params.sidebar] - backgroundImage = '' - gradientOverlay = '' - logo = "" -[params.assets] - favicon = "" - customCSS = "" - -[params.social] - github = "https://github.com/" - twitter = "https://twitter.com/" - linkedin = "https://www.linkedin.com/in/" - -[params.contact] - email = "" - text= "" - - -[menu] - -[[menu.main]] - identifier = "about" - name = "About" - title = "About section" - url = "/about/" - weight = -120 - -[[menu.main]] - identifier = "portfolio" - name = "Portfolio" - title = "Portfolio" - url = "/portfolio/" - weight = -110 - -[[menu.main]] - identifier = "blog" - name = "Post" - title = "Blog section" - url = "/post/" - weight = -100 - -[sitemap] - changefreq = "monthly" - filename = "sitemap.xml" - priority = 0.5 - -[privacy] - [privacy.googleAnalytics] - anonymizeIP = true - disable = true - respectDoNotTrack = true - useSessionStorage = false - [privacy.twitter] - disable = false - enableDNT = true - simple = false - -```
\ No newline at end of file diff --git a/content/post/getting-started.md b/content/post/getting-started.md deleted file mode 100644 index afb1371..0000000 --- a/content/post/getting-started.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: -description: -date: "2019-05-03T09:37:55+02:00" -publishDate: "2019-05-03T09:37:55+02:00" ---- - - - -- copy content from exampleSite for structure -- create config file from sample -- write home -- create project -- create first blog post -- define menu diff --git a/content/post/portfolio-definition.md b/content/post/portfolio-definition.md deleted file mode 100644 index bea8e90..0000000 --- a/content/post/portfolio-definition.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Portfolio Definition -description: How to define your portfolio in FrontMatter -date: "2019-05-02T19:49:05+02:00" -publishDate: "2019-05-02T19:49:05+02:00" ---- - -A portfolio - -{{< figure src="/post/images/portfolio-example.png" caption="Exaxmple of Portfolio page" >}} - -<!--more--> - -```YAML ---- -title: -description: -date: "2019-05-02T19:47:09+02:00" -jobDate: 201 -work: [] -techs: [] -designs: [] -thumbnail: -projectUrl: -testimonial: - name: - role: - image: - text: ---- -```
\ No newline at end of file diff --git a/content/post/shortcodes.md b/content/post/shortcodes.md deleted file mode 100644 index 5629ec1..0000000 --- a/content/post/shortcodes.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Shortcodes -date: 2019-04-29T16:18:12+01:00 -publishDate: 2019-04-29T19:12:12+01:00 ---- - -Introduction of the shortcodes defined in the personal_web theme. - -<!--more--> - -## Add a figure -{{</* figure src="/post/images/sample_image.jpg" caption="Photo by Tim Mossholder on Unsplash" */>}} - -results in - -{{< figure src="/post/images/sample_image.jpg" caption="Photo by Tim Mossholder on Unsplash" >}} - -**Note:** files are kept in a `images` folder, directly in the post/portfolio folder. - - -## Add a single Tweet -{{</* tweet-single 1120412132036706305 */>}} - -results in -{{< tweet-single 1120412132036706305 >}} - -This shortcode is useful in case of multiple tweets in a thread. If you want to show a single tweet, use this shortcode, with the ID of the Tweet. The ID is the end of the tweet link. - -For example: \ -https://<span></span>twitter.com/BarackObama/status/**1120412132036706305** diff --git a/exampleSite/config.toml b/exampleSite/config.toml index bf5d98a..1623d24 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -6,6 +6,8 @@ copyright="© Edna West" googleAnalytics = "" enableEmoji=true enableRobotsTXT=true +pygmentsUseClasses=true +pygmentsCodeFences=true [params.intro] main = "Hi, I'm Edna :wave:" @@ -43,9 +45,9 @@ enableRobotsTXT=true customCSS = "" [params.social] - github = "https://github.com/bjacquemet" - twitter = "https://twitter.com/jacquemetb" - linkedin = "https://www.linkedin.com/in/baptistej" + github = "https://github.com/" + twitter = "https://twitter.com/" + linkedin = "https://www.linkedin.com/in/" [params.contact] email = "" diff --git a/content/_index.md b/exampleSite/content/_index.md index 9fd0aa2..9fd0aa2 100644 --- a/content/_index.md +++ b/exampleSite/content/_index.md diff --git a/content/about.md b/exampleSite/content/about.md index 76fb758..76fb758 100644 --- a/content/about.md +++ b/exampleSite/content/about.md diff --git a/exampleSite/content/portfolio/_index.md b/exampleSite/content/portfolio/_index.md new file mode 100644 index 0000000..ac007cc --- /dev/null +++ b/exampleSite/content/portfolio/_index.md @@ -0,0 +1,6 @@ +--- +title: PORTFOLIO +description: 'Portfolio Section' +--- + +You'll add here a general introduction of your portfolio page.
\ No newline at end of file diff --git a/content/portfolio/sample-project/index.md b/exampleSite/content/portfolio/sample-project/index.md index 0b1fb42..0b1fb42 100644 --- a/content/portfolio/sample-project/index.md +++ b/exampleSite/content/portfolio/sample-project/index.md diff --git a/content/portfolio/sample-project/john.jpg b/exampleSite/content/portfolio/sample-project/john.jpg Binary files differindex a6a39bf..a6a39bf 100644 --- a/content/portfolio/sample-project/john.jpg +++ b/exampleSite/content/portfolio/sample-project/john.jpg diff --git a/content/portfolio/sample-project/sample.jpg b/exampleSite/content/portfolio/sample-project/sample.jpg Binary files differindex 928d3f5..928d3f5 100644 --- a/content/portfolio/sample-project/sample.jpg +++ b/exampleSite/content/portfolio/sample-project/sample.jpg diff --git a/content/post/archetypes.md b/exampleSite/content/post/archetypes.md index e5f3a57..e5f3a57 100644 --- a/content/post/archetypes.md +++ b/exampleSite/content/post/archetypes.md diff --git a/exampleSite/content/post/config-file.md b/exampleSite/content/post/config-file.md new file mode 100644 index 0000000..090d707 --- /dev/null +++ b/exampleSite/content/post/config-file.md @@ -0,0 +1,176 @@ +--- +title: "Config File" +description: Some basics on the configuration of the theme +date: 2019-04-20T16:18:12+01:00 +publishDate: 2019-04-20T19:12:12+01:00 +--- + +Here is the basic config file used for personal_web. + +You can use it as a base for your website. + +<!--more--> + +```TOML +baseURL = "https://example.com/" +languageCode = "en-us" +title = "Edna West" +theme = "personal_web" +copyright="© Edna West" +googleAnalytics = "" +enableEmoji=true +enableRobotsTXT=true +pygmentsUseClasses=true +pygmentsCodeFences=true + +[params.intro] + main = "Hi, I'm Edna :wave:" + sub = "I'm a Web Developer and Entrepreneur" + +[taxonomies] + design = "designs" + tech = "techs" + +[blackfriday] + hrefTargetBlank = true + +[params] + breadcrumb = true + accentColor = "#FD3519" + +[params.notFound] + gopher = "/images/gopher.png" + h1 = 'Bummer!' + p = "It seems that this page doesn't exist." + mainSection = 'portfolio' + +[params.sections] + post = "article" + portfolio = "project" + +[params.sidebar] + backgroundImage = '' + gradientOverlay = '' + logo = "" + +[params.assets] + favicon = "" + customCSS = "" + +[params.social] + github = "https://github.com/" + twitter = "https://twitter.com/" + linkedin = "https://www.linkedin.com/in/" + +[params.contact] + email = "" + text= "" + + +[menu] + +[[menu.main]] + identifier = "about" + name = "About" + title = "About section" + url = "/about/" + weight = -120 + +[[menu.main]] + identifier = "portfolio" + name = "Portfolio" + title = "Portfolio" + url = "/portfolio/" + weight = -110 + +[[menu.main]] + identifier = "blog" + name = "Post" + title = "Blog section" + url = "/post/" + weight = -100 + +[sitemap] + changefreq = "monthly" + filename = "sitemap.xml" + priority = 0.5 + +[privacy] + [privacy.googleAnalytics] + anonymizeIP = true + disable = true + respectDoNotTrack = true + useSessionStorage = false + [privacy.twitter] + disable = false + enableDNT = true + simple = false + +``` + +## Sidebar + +The sidebar header is defined within the `params.intro` section. The `main` being the top header and `sub` the subheader + +```TOML +[params.intro] + main = "Hi, I'm Edna :wave:" + sub = "I'm a Web Developer and Entrepreneur" +``` + +You can also customize the params with the `params.sidebar` parameters. The `config.toml` file contains the default values as examples. +```TOML +[params.sidebar] + backgroundImage = '' + gradientOverlay = '' + logo = '' +``` + +## 404 + +The 404 page is defined within the `params.notFound` section. +The `gopher`, `h1` and `p` params define the image and texts displayed on the page. The `mainSection` params possible values are 'portfolio' or 'post': it defines the section highlighted on the page. + +NB: to see the 404 page from your development env, check `/404.html`. + +```TOML +[params.notFound] + gopher = "/images/gopher.png" + h1 = 'Bummer!' + p = "It seems that this page doesn't exist." + mainSection = 'portfolio' +``` + +You can also define how the post and portfolio sections will be named on the 404 page, thanks to the `params.sections` params. + +```TOML +[params.sections] + post = "article" + portfolio = "project" +``` + +## Customization + +You can define a custom CSS file in the `customCSS` param and a favicon. +```TOML +[params.assets] + favicon = "" + customCSS = "" +``` + +## Social + +You can define your social media usernames in the `params.social` and the `params.contact` paramaters. + +In this last section, the email expects your email address and the text is what will be displayed on the sidebar, right below the last item of the menu. If blank, nothing is displayed. + +```TOML +[params.social] + github = "https://github.com/" + twitter = "https://twitter.com/" + linkedin = "https://www.linkedin.com/in/" + +[params.contact] + email = "" + text= "" +```
\ No newline at end of file diff --git a/exampleSite/content/post/config_file.md b/exampleSite/content/post/config_file.md deleted file mode 100644 index 9fa886a..0000000 --- a/exampleSite/content/post/config_file.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "Config File" -date: 2019-04-20T16:18:12+01:00 -publishDate: 2019-04-20T19:12:12+01:00 ---- - -``` -baseURL = "https://example.com/" -languageCode = "en-us" -title = "Edna West" -theme = "personal_web" -copyright="© Edna West" -googleAnalytics = "" -enableEmoji=true -enableRobotsTXT=true - -[params.intro] - main = "Hi, I'm Edna :wave:" - sub = "I'm a Web Developer and Entrepreneur" - -[taxonomies] - design = "designs" - tech = "techs" - -[blackfriday] - hrefTargetBlank = true - -[params] - breadcrumb = true - accentColor = "#FD3519" - -[params.notFound] - gopher = "/images/gopher.png" # checkout https://gopherize.me/ - h1 = 'Bummer!' - p = "It seems that this page doesn't exist." - mainSection = 'portfolio' # values: [post, portfolio] only accept one section, to be displayed bellow 404 - -[params.sections] - # Define how your sections will be called - # when automatically pulled. For instance in the 404 page - post = "article" - portfolio = "project" - -[params.sidebar] - backgroundImage = '' # header background image - default "/images/default_sidebar.jpg" - Photo by Tim Marshall on Unsplash - gradientOverlay = '' # default: rgba(0,0,0,0.4),rgba(0,0,0,0.4) - logo = "" # - default "/images/edna-west.jpg" -[params.assets] - favicon = "" - customCSS = "" - -[params.social] - github = "https://github.com/bjacquemet" - twitter = "https://twitter.com/jacquemetb" - linkedin = "https://www.linkedin.com/in/baptistej" - -[params.contact] - email = "" - text= "" # text of the contact link in the sidebar. If email params.contact.email is defined - - -[menu] - -[[menu.main]] - identifier = "about" - name = "About" - title = "About section" - url = "/about/" - weight = -120 - -[[menu.main]] - identifier = "portfolio" - name = "Portfolio" - title = "Portfolio" - url = "/portfolio/" - weight = -110 - -[[menu.main]] - identifier = "blog" - name = "Post" - title = "Blog section" - url = "/post/" - weight = -100 - -[sitemap] - changefreq = "monthly" - filename = "sitemap.xml" - priority = 0.5 - -[privacy] - [privacy.googleAnalytics] - anonymizeIP = true - disable = true - respectDoNotTrack = true - useSessionStorage = false - [privacy.twitter] - disable = false - enableDNT = true - simple = false -```
\ No newline at end of file diff --git a/content/post/define-specific-og-image.md b/exampleSite/content/post/define-specific-og-image.md index 0b03312..0b03312 100644 --- a/content/post/define-specific-og-image.md +++ b/exampleSite/content/post/define-specific-og-image.md diff --git a/exampleSite/content/post/getting-started.md b/exampleSite/content/post/getting-started.md new file mode 100644 index 0000000..6b5c126 --- /dev/null +++ b/exampleSite/content/post/getting-started.md @@ -0,0 +1,18 @@ +--- +title: Getting started +description: Getting started with personal_web +date: "2019-05-03T09:37:55+02:00" +publishDate: "2019-05-03T09:37:55+02:00" +--- + +We'll assume here that you have a good understanding of Hugo and its structure. If you have any doubt, check the (https://gohugo.io/documentation/)[Hugo documentation]; it is pretty good and the community quite active! (thanks so much by the way! :muscle:) + +The first thing to do when starting your own website is to **copy the content of exampleSite** in your own root folder. This way, you can have a sample of `config.toml` file and a first structure. + +Browse the articles in the `content/post` folder to get any help during setup or using the theme. Please, (https://baptistej.com)[contact me] if you have any problem using the them. + +Then **configure the `config.toml` file** to match your need. + +You should then write you home (`/content/_index.md`), create your first project (see `/content/post/portfolio-definition.md`) and your first blogpost. + +Lastly, define the menu in the sidebar; you can get some help in the `/content/post/manage-your-menu.md` file.
\ No newline at end of file diff --git a/content/post/images/portfolio-example.png b/exampleSite/content/post/images/portfolio-example.png Binary files differindex e6e24e1..e6e24e1 100644 --- a/content/post/images/portfolio-example.png +++ b/exampleSite/content/post/images/portfolio-example.png diff --git a/content/post/images/sample_image.jpg b/exampleSite/content/post/images/sample_image.jpg Binary files differindex a3475cd..a3475cd 100644 --- a/content/post/images/sample_image.jpg +++ b/exampleSite/content/post/images/sample_image.jpg diff --git a/content/post/manage-your-menu.md b/exampleSite/content/post/manage-your-menu.md index 5a11a8e..8bc4bad 100644 --- a/content/post/manage-your-menu.md +++ b/exampleSite/content/post/manage-your-menu.md @@ -1,5 +1,6 @@ --- title: "Manage Your Menu" +description: Define a sidebar menu date: 2019-05-02T19:06:29+02:00 draft: true --- diff --git a/exampleSite/content/post/portfolio-definition.md b/exampleSite/content/post/portfolio-definition.md new file mode 100644 index 0000000..c7c3dd6 --- /dev/null +++ b/exampleSite/content/post/portfolio-definition.md @@ -0,0 +1,41 @@ +--- +title: Portfolio Definition +description: How to define your portfolio in FrontMatter +date: "2019-05-02T19:49:05+02:00" +publishDate: "2019-05-02T19:49:05+02:00" +--- + +A portfolio + +{{< figure src="/post/images/portfolio-example.png" caption="Example of Portfolio page" >}} + +<!--more--> + +```YAML +--- +title: +description: +date: "2019-05-02T19:47:09+02:00" +jobDate: 201 +work: [] +techs: [] +designs: [] +thumbnail: +projectUrl: +testimonial: + name: + role: + image: + text: +--- +``` + +Here are some explanations about the portfolio FrontMatter: +- `jobDate` is the year displayed on the list and show of your project +- `work` is displayed on the list of projects. It is an array of type of job that you did on the project. +- `techs` and `designs` are displayed on the show page of your project. It is an array of tools you used on the project +- `thumbnail` is a image file displayed both for the list and show of the project +- `projectUrl` is the URL to the project. +- The `testimonial` params define the person giving your a testimonial as well as the text of the testimonial. + +NB: if `techs`, `designs` or `projectUrl` is not defined, it will not be displayed at all. diff --git a/exampleSite/content/post/shortcodes.md b/exampleSite/content/post/shortcodes.md index 9c43147..060f704 100644 --- a/exampleSite/content/post/shortcodes.md +++ b/exampleSite/content/post/shortcodes.md @@ -1,18 +1,31 @@ --- -title: "Shortcodes" -date: 2019-04-19T16:18:12+01:00 -publishDate: 2019-04-19T19:12:12+01:00 +title: Shortcodes +description: Exaplanation on the shortcodes with personal_web +date: 2019-04-29T16:18:12+01:00 +publishDate: 2019-04-29T19:12:12+01:00 --- -Introduction of the shortcodes +Introduction of the shortcodes defined in the personal_web theme. <!--more--> -## Figure -check it -{{< figure src="/post/images/banner_etc.jpg" caption="Will you take the challenge?!">}} +## Add a figure +{{</* figure src="/post/images/sample_image.jpg" caption="Photo by Tim Mossholder on Unsplash" */>}} +results in -## Tweet Single -{{< tweet-single 1072826999562035200 >}} +{{< figure src="/post/images/sample_image.jpg" caption="Photo by Tim Mossholder on Unsplash" >}} +**Note:** files are kept in a `images` folder, directly in the post/portfolio folder. + + +## Add a single Tweet +{{</* tweet-single 1120412132036706305 */>}} + +results in +{{< tweet-single 1120412132036706305 >}} + +This shortcode is useful in case of multiple tweets in a thread. If you want to show a single tweet, use this shortcode, with the ID of the Tweet. The ID is the end of the tweet link. + +For example: \ +https://<span></span>twitter.com/BarackObama/status/**1120412132036706305** diff --git a/exampleSite/static/images/gopher.png b/exampleSite/static/images/gopher.png Binary files differnew file mode 100644 index 0000000..4fe5d6f --- /dev/null +++ b/exampleSite/static/images/gopher.png diff --git a/static/images/sample.jpg b/exampleSite/static/images/sample.jpg Binary files differindex 928d3f5..928d3f5 100644 --- a/static/images/sample.jpg +++ b/exampleSite/static/images/sample.jpg diff --git a/themes/layouts/404.html b/layouts/404.html index ddc4b8e..ddc4b8e 100644 --- a/themes/layouts/404.html +++ b/layouts/404.html diff --git a/themes/layouts/_default/baseof.html b/layouts/_default/baseof.html index 5f8e2ec..5f8e2ec 100644 --- a/themes/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html diff --git a/themes/layouts/_default/li.html b/layouts/_default/li.html index 91cbd22..91cbd22 100644 --- a/themes/layouts/_default/li.html +++ b/layouts/_default/li.html diff --git a/themes/layouts/_default/list.html b/layouts/_default/list.html index 9aff636..9aff636 100644 --- a/themes/layouts/_default/list.html +++ b/layouts/_default/list.html diff --git a/themes/layouts/_default/single.html b/layouts/_default/single.html index 5e27f0a..5e27f0a 100644 --- a/themes/layouts/_default/single.html +++ b/layouts/_default/single.html diff --git a/themes/layouts/designs/list.html b/layouts/designs/list.html index 09b0af5..09b0af5 100644 --- a/themes/layouts/designs/list.html +++ b/layouts/designs/list.html diff --git a/themes/layouts/designs/terms.html b/layouts/designs/terms.html index fd63e78..fd63e78 100644 --- a/themes/layouts/designs/terms.html +++ b/layouts/designs/terms.html diff --git a/themes/layouts/index.html b/layouts/index.html index ecb4b02..ecb4b02 100644 --- a/themes/layouts/index.html +++ b/layouts/index.html diff --git a/themes/layouts/partials/breadcrumb.html b/layouts/partials/breadcrumb.html index f752b5e..f752b5e 100644 --- a/themes/layouts/partials/breadcrumb.html +++ b/layouts/partials/breadcrumb.html diff --git a/themes/layouts/partials/footer.html b/layouts/partials/footer.html index b990df8..b990df8 100644 --- a/themes/layouts/partials/footer.html +++ b/layouts/partials/footer.html diff --git a/themes/layouts/partials/head/head.html b/layouts/partials/head/head.html index 92f9da1..92f9da1 100644 --- a/themes/layouts/partials/head/head.html +++ b/layouts/partials/head/head.html diff --git a/themes/layouts/partials/head/meta.html b/layouts/partials/head/meta.html index a5c2753..a5c2753 100644 --- a/themes/layouts/partials/head/meta.html +++ b/layouts/partials/head/meta.html diff --git a/themes/layouts/partials/head/style.html b/layouts/partials/head/style.html index c5a3586..c5a3586 100644 --- a/themes/layouts/partials/head/style.html +++ b/layouts/partials/head/style.html diff --git a/themes/layouts/partials/header.html b/layouts/partials/header.html index 934ca5c..934ca5c 100644 --- a/themes/layouts/partials/header.html +++ b/layouts/partials/header.html diff --git a/themes/layouts/partials/portfolio/item.html b/layouts/partials/portfolio/item.html index 255c3c2..255c3c2 100644 --- a/themes/layouts/partials/portfolio/item.html +++ b/layouts/partials/portfolio/item.html diff --git a/themes/layouts/partials/portfolio/tags.html b/layouts/partials/portfolio/tags.html index 276c064..276c064 100644 --- a/themes/layouts/partials/portfolio/tags.html +++ b/layouts/partials/portfolio/tags.html diff --git a/themes/layouts/partials/portfolio/testimonial.html b/layouts/partials/portfolio/testimonial.html index 2170cf4..2170cf4 100644 --- a/themes/layouts/partials/portfolio/testimonial.html +++ b/layouts/partials/portfolio/testimonial.html diff --git a/themes/layouts/partials/post/information.html b/layouts/partials/post/information.html index 60928c2..60928c2 100644 --- a/themes/layouts/partials/post/information.html +++ b/layouts/partials/post/information.html diff --git a/themes/layouts/partials/post/item.html b/layouts/partials/post/item.html index 634cbbc..634cbbc 100644 --- a/themes/layouts/partials/post/item.html +++ b/layouts/partials/post/item.html diff --git a/themes/layouts/partials/sidebar/menu.html b/layouts/partials/sidebar/menu.html index 464fb92..464fb92 100644 --- a/themes/layouts/partials/sidebar/menu.html +++ b/layouts/partials/sidebar/menu.html diff --git a/themes/layouts/partials/sidebar/sidebar.html b/layouts/partials/sidebar/sidebar.html index b4829d6..b4829d6 100644 --- a/themes/layouts/partials/sidebar/sidebar.html +++ b/layouts/partials/sidebar/sidebar.html diff --git a/themes/layouts/partials/sidebar/social.html b/layouts/partials/sidebar/social.html index 21dccdf..21dccdf 100644 --- a/themes/layouts/partials/sidebar/social.html +++ b/layouts/partials/sidebar/social.html diff --git a/themes/layouts/partials/sidebar/style.html b/layouts/partials/sidebar/style.html index 43318c9..43318c9 100644 --- a/themes/layouts/partials/sidebar/style.html +++ b/layouts/partials/sidebar/style.html diff --git a/themes/layouts/partials/svg.html b/layouts/partials/svg.html index cc06b37..cc06b37 100644 --- a/themes/layouts/partials/svg.html +++ b/layouts/partials/svg.html diff --git a/themes/layouts/portfolio/list.html b/layouts/portfolio/list.html index a411a39..a411a39 100644 --- a/themes/layouts/portfolio/list.html +++ b/layouts/portfolio/list.html diff --git a/themes/layouts/portfolio/single.html b/layouts/portfolio/single.html index 953b3bd..953b3bd 100644 --- a/themes/layouts/portfolio/single.html +++ b/layouts/portfolio/single.html diff --git a/themes/layouts/post/list.html b/layouts/post/list.html index 3cc3cd8..3cc3cd8 100644 --- a/themes/layouts/post/list.html +++ b/layouts/post/list.html diff --git a/themes/layouts/post/single.html b/layouts/post/single.html index f9a6dcc..f9a6dcc 100644 --- a/themes/layouts/post/single.html +++ b/layouts/post/single.html diff --git a/themes/layouts/robots.txt b/layouts/robots.txt index 7d329b1..7d329b1 100644 --- a/themes/layouts/robots.txt +++ b/layouts/robots.txt diff --git a/themes/layouts/shortcodes/emoji.html b/layouts/shortcodes/emoji.html index 4eb8053..4eb8053 100644 --- a/themes/layouts/shortcodes/emoji.html +++ b/layouts/shortcodes/emoji.html diff --git a/themes/layouts/shortcodes/tweet-single.html b/layouts/shortcodes/tweet-single.html index cb59946..cb59946 100644 --- a/themes/layouts/shortcodes/tweet-single.html +++ b/layouts/shortcodes/tweet-single.html diff --git a/themes/layouts/techs/list.html b/layouts/techs/list.html index 09b0af5..09b0af5 100644 --- a/themes/layouts/techs/list.html +++ b/layouts/techs/list.html diff --git a/themes/layouts/techs/terms.html b/layouts/techs/terms.html index 2ef9be6..2ef9be6 100644 --- a/themes/layouts/techs/terms.html +++ b/layouts/techs/terms.html diff --git a/themes/package-lock.json b/package-lock.json index 822a9c3..822a9c3 100644 --- a/themes/package-lock.json +++ b/package-lock.json diff --git a/themes/package.json b/package.json index 82af49a..82af49a 100644 --- a/themes/package.json +++ b/package.json diff --git a/themes/static/images/default-sidebar.jpg b/static/images/default-sidebar.jpg Binary files differindex a6d8bc0..a6d8bc0 100644 --- a/themes/static/images/default-sidebar.jpg +++ b/static/images/default-sidebar.jpg diff --git a/themes/static/images/edna-west.jpg b/static/images/edna-west.jpg Binary files differindex d4ec655..d4ec655 100644 --- a/themes/static/images/edna-west.jpg +++ b/static/images/edna-west.jpg diff --git a/themes/static/images/gohper.png b/static/images/gohper.png Binary files differindex 84f30ce..84f30ce 100644 --- a/themes/static/images/gohper.png +++ b/static/images/gohper.png @@ -4,7 +4,7 @@ name = "Personal_web" license = "MIT" licenselink = "https://github.com/bjacquemet/personal-web/blob/master/LICENSE" -description = "Personal Web is a simple Hugo template to build a personal website including portfolio and blog sections" +description = "Personal Web is a simple Hugo template to build a personal website including portfolio and blog sections. It will mainly suit freelancers who want to showcase their work." homepage = "http://example.com/" tags = ["portfolio", "blog", "post", "personal", "freelancer", "developer"] features = [] diff --git a/themes/README.md b/themes/README.md deleted file mode 100644 index 56ba6ca..0000000 --- a/themes/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Personal Web -Personal Web Template for Hugo |