diff --git a/archetypes/docs.md b/archetypes/docs.md deleted file mode 100644 index 4dd6fdc..0000000 --- a/archetypes/docs.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "{{ replace .Name "-" " " | title }}" -author: "{{ site.Params.contact.profileName }}" -date: {{ .Date }} -lastmod: {{ .Date }} -draft: true -description: "" # Brief summary of the post. -comments: false # Enable Remark42 comments by default -series: [] -# for more control: -# name: -# part: -# total: -tags: [] -categories: [] -slug: "{{ .Name | urlize }}" -toc: true -sidenotes: true -image: "images/{{ .Type }}/{{ .Name | urlize }}/{{ .Name | urlize }}.jpg" # make sure that the name corresponds to jpg, jpeg, png, etc. -alt: "" # Alt text for the header image (accessibility) ---- - -Add your post content here... diff --git a/archetypes/posts.md b/archetypes/posts.md index 4dd6fdc..975bd99 100644 --- a/archetypes/posts.md +++ b/archetypes/posts.md @@ -5,17 +5,20 @@ date: {{ .Date }} lastmod: {{ .Date }} draft: true description: "" # Brief summary of the post. -comments: false # Enable Remark42 comments by default +comments: true # Enable Remark42 comments by default for posts series: [] # for more control: # name: # part: # total: -tags: [] -categories: [] +tags: ["uncategorized"] +categories: ["general"] +keywords: [] slug: "{{ .Name | urlize }}" toc: true sidenotes: true +showReadingTime: true +showShareButtons: true image: "images/{{ .Type }}/{{ .Name | urlize }}/{{ .Name | urlize }}.jpg" # make sure that the name corresponds to jpg, jpeg, png, etc. alt: "" # Alt text for the header image (accessibility) --- diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index a01c33d..59e6eec 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -1,8 +1,9 @@ baseURL = 'https://example.org/' languageCode = 'en-us' -title = 'HUGO_site' +title = 'PKB Theme' enableGitInfo = true +enableRobotsTXT = true #relativeURLs = true #canonifyURLs = true @@ -87,132 +88,15 @@ enableGitInfo = true [markup.goldmark.renderHooks.link] enableDefault = true [markup.goldmark.renderer] - unsafe = true # This allows raw HTML in markdown files + # unsafe = true is required because the theme embeds inline SVGs and + # other raw HTML directly in markdown content (e.g., diagrams, icons). + unsafe = true [markup.goldmark.parser] [markup.goldmark.parser.attribute] block = true title = true -[mediaTypes] - [mediaTypes.'application/json'] - delimiter = '.' - suffixes = ['json'] - [mediaTypes.'application/manifest+json'] - delimiter = '.' - suffixes = ['webmanifest'] - [mediaTypes.'application/octet-stream'] - delimiter = '.' - [mediaTypes.'application/pdf'] - delimiter = '.' - suffixes = ['pdf'] - [mediaTypes.'application/rss+xml'] - delimiter = '.' - suffixes = ['xml', 'rss'] - [mediaTypes.'application/toml'] - delimiter = '.' - suffixes = ['toml'] - [mediaTypes.'application/wasm'] - delimiter = '.' - suffixes = ['wasm'] - [mediaTypes.'application/xml'] - delimiter = '.' - suffixes = ['xml'] - [mediaTypes.'application/yaml'] - delimiter = '.' - suffixes = ['yaml', 'yml'] - [mediaTypes.'font/otf'] - delimiter = '.' - suffixes = ['otf'] - [mediaTypes.'font/ttf'] - delimiter = '.' - suffixes = ['ttf'] - [mediaTypes.'image/bmp'] - delimiter = '.' - suffixes = ['bmp'] - [mediaTypes.'image/gif'] - delimiter = '.' - suffixes = ['gif'] - [mediaTypes.'image/jpeg'] - delimiter = '.' - suffixes = ['jpg', 'jpeg', 'jpe', 'jif', 'jfif'] - [mediaTypes.'image/png'] - delimiter = '.' - suffixes = ['png'] - [mediaTypes.'image/svg+xml'] - delimiter = '.' - suffixes = ['svg'] - [mediaTypes.'image/tiff'] - delimiter = '.' - suffixes = ['tif', 'tiff'] - [mediaTypes.'image/webp'] - delimiter = '.' - suffixes = ['webp'] - [mediaTypes.'text/asciidoc'] - delimiter = '.' - suffixes = ['adoc', 'asciidoc', 'ad'] - [mediaTypes.'text/calendar'] - delimiter = '.' - suffixes = ['ics'] - [mediaTypes.'text/css'] - delimiter = '.' - suffixes = ['css'] - [mediaTypes.'text/csv'] - delimiter = '.' - suffixes = ['csv'] - [mediaTypes.'text/html'] - delimiter = '.' - suffixes = ['html', 'htm'] - [mediaTypes.'text/javascript'] - delimiter = '.' - suffixes = ['js', 'jsm', 'mjs'] - [mediaTypes.'text/jsx'] - delimiter = '.' - suffixes = ['jsx'] - [mediaTypes.'text/markdown'] - delimiter = '.' - suffixes = ['md', 'mdown', 'markdown'] - [mediaTypes.'text/org'] - delimiter = '.' - suffixes = ['org'] - [mediaTypes.'text/pandoc'] - delimiter = '.' - suffixes = ['pandoc', 'pdc'] - [mediaTypes.'text/plain'] - delimiter = '.' - suffixes = ['txt'] - [mediaTypes.'text/rst'] - delimiter = '.' - suffixes = ['rst'] - [mediaTypes.'text/tsx'] - delimiter = '.' - suffixes = ['tsx'] - [mediaTypes.'text/typescript'] - delimiter = '.' - suffixes = ['ts'] - [mediaTypes.'text/x-sass'] - delimiter = '.' - suffixes = ['sass'] - [mediaTypes.'text/x-scss'] - delimiter = '.' - suffixes = ['scss'] - [mediaTypes.'video/3gpp'] - delimiter = '.' - suffixes = ['3gpp', '3gp'] - [mediaTypes.'video/mp4'] - delimiter = '.' - suffixes = ['mp4'] - [mediaTypes.'video/mpeg'] - delimiter = '.' - suffixes = ['mpg', 'mpeg'] - [mediaTypes.'video/ogg'] - delimiter = '.' - suffixes = ['ogv'] - [mediaTypes.'video/webm'] - delimiter = '.' - suffixes = ['webm'] - [mediaTypes.'video/x-msvideo'] - delimiter = '.' - suffixes = ['avi'] +# Hugo's built-in mediaTypes are sufficient; no overrides needed here. [minify] disableCSS = false diff --git a/config/_default/params.toml b/config/_default/params.toml index e733c3b..5c499b7 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -53,11 +53,15 @@ enableHDVoice = true pageNumberFontSize = "10pt" [contact] + # Replace with your contact phone — example only phone = '+1 206-555-1212' + # Replace with your name — example only profileName = "Your Name" + # Replace with your profile picture path — example only profilePicture = "images/profile.png" - + [social] + # Replace each URL with your handle/profile — examples only linkedin = "https://linkedin.com/in/your-profile" twitter = "https://twitter.com/your-profile" instagram = "https://instagram.com/your-profile" @@ -154,6 +158,7 @@ tagline = "Personal Knowledge Base" default_image = "/images/default-og.jpg" # Twitter specific (no duplication with [social]) + # Replace with your Twitter/X handle — example only twitter_creator = "@yourhandle" # Site Verification diff --git a/data/seo.yml b/data/seo.yml index 9f11580..ef18f6b 100644 --- a/data/seo.yml +++ b/data/seo.yml @@ -8,26 +8,26 @@ schema: organization: name: "PKB Theme" logo: "/images/logo.png" - url: "https://yoursite.com" + url: "https://example.com" # OVERRIDE in your site's data/seo.yml contactPoint: - telephone: "+1-000-000-0000" + telephone: "+1-000-000-0000" # OVERRIDE in your site's data/seo.yml contactType: "customer service" areaServed: "Global" availableLanguage: ["English"] foundingDate: "2024" description: "A Hugo theme for personal knowledge base and academic blogging" - + # Additional schema types for rich snippets website: potentialAction: - "@type": "SearchAction" - target: "https://yoursite.com/search?q={search_term_string}" + target: "https://example.com/search?q={search_term_string}" # OVERRIDE in your site's data/seo.yml "query-input": "required name=search_term_string" social: - twitter: "@yourhandle" - facebook: "yourpage" - linkedin: "yourprofile" + twitter: "@yourhandle" # OVERRIDE in your site's data/seo.yml + facebook: "yourpage" # OVERRIDE in your site's data/seo.yml + linkedin: "yourprofile" # OVERRIDE in your site's data/seo.yml performance: critical_css: true diff --git a/exampleSite/config/_default/hugo.toml b/exampleSite/config/_default/hugo.toml index 7aa9143..163b86d 100644 --- a/exampleSite/config/_default/hugo.toml +++ b/exampleSite/config/_default/hugo.toml @@ -1,7 +1,9 @@ baseURL = "https://stradichenko.github.io/PKB-theme/" -#languageCode = "en-us" +languageCode = "en-us" title = "PKB-theme Demo" +# publish the site into ../docs for GitHub Pages +#publishDir = "docs" [markup] [markup.goldmark] @@ -11,7 +13,9 @@ title = "PKB-theme Demo" [markup.goldmark.renderHooks.link] enableDefault = true [markup.goldmark.renderer] - unsafe = true # This allows raw HTML in markdown files + # unsafe = true is required because the theme embeds inline SVGs and + # other raw HTML directly in markdown content. + unsafe = true [module] [[module.imports]] @@ -20,7 +24,7 @@ title = "PKB-theme Demo" [[module.imports.mounts]] source = "static" # inside the theme repo - target = "static" # inject it into my site's + target = "static" # inject it into my site's [[module.imports.mounts]] source = "assets" @@ -41,4 +45,4 @@ title = "PKB-theme Demo" # Mount portfolio images to the correct assets path [[module.mounts]] source = "static/images/portfolio" - target = "assets/images/portfolio" \ No newline at end of file + target = "assets/images/portfolio" diff --git a/exampleSite/hugo.toml b/exampleSite/hugo.toml deleted file mode 100644 index c61e512..0000000 --- a/exampleSite/hugo.toml +++ /dev/null @@ -1,31 +0,0 @@ -baseURL = "https://stradichenko.github.io/PKB-theme/" -languageCode = "en-us" -title = "PKB-theme Demo" - -# publish the site into ../docs for GitHub Pages -#publishDir = "docs" - -[module] - [[module.imports]] - path = "github.com/stradichenko/PKB-theme" - # version = "v1.0.0" # optional pin once you have tags - - [[module.imports.mounts]] - source = "static" # inside the theme repo - target = "static" # inject it into my site’s - - [[module.imports.mounts]] - source = "assets" - target = "assets" - - [[module.imports.mounts]] - source = "content" - target = "content" - - [[module.imports.mounts]] - source = "layouts" - target = "layouts" - - [[module.imports.mounts]] - source = "archetypes" - target = "archetypes" \ No newline at end of file diff --git a/layouts/robots.txt b/layouts/robots.txt new file mode 100644 index 0000000..6b4c001 --- /dev/null +++ b/layouts/robots.txt @@ -0,0 +1,4 @@ +User-agent: * +Allow: / + +Sitemap: {{ "sitemap.xml" | absURL }}