diff options
Diffstat (limited to 'exampleSite/config')
-rw-r--r-- | exampleSite/config/_default/config.toml | 110 | ||||
-rw-r--r-- | exampleSite/config/_default/languages.toml | 20 | ||||
-rw-r--r-- | exampleSite/config/_default/menus.toml | 41 | ||||
-rw-r--r-- | exampleSite/config/_default/params.toml | 290 |
4 files changed, 461 insertions, 0 deletions
diff --git a/exampleSite/config/_default/config.toml b/exampleSite/config/_default/config.toml new file mode 100644 index 00000000..5d5089e4 --- /dev/null +++ b/exampleSite/config/_default/config.toml @@ -0,0 +1,110 @@ +# Configuration of Hugo +# Guide: https://sourcethemes.com/academic/docs/get-started/ +# Hugo Documentation: https://gohugo.io/getting-started/configuration/#all-configuration-settings +# +# This file is formatted using TOML syntax - learn more at https://learnxinyminutes.com/docs/toml/ +# Each configuration section is defined by a name in square brackets (e.g. `[outputs]`). + +# Title of your site +title = "Academic" + +# The URL of your site. +# End your URL with a `/` trailing slash, e.g. `https://example.com/`. +baseurl = "/" + +# Enter a copyright notice to display in the site footer. +# To display a copyright symbol, type `©`. For current year, type `{year}`. +copyright = "" + +############################ +## Advanced options below ## +############################ + +# Get last modified date for content from Git? +enableGitInfo = false + +# Default language to use (if you setup multilingual support) +defaultContentLanguage = "en" +hasCJKLanguage = false # Set `true` for Chinese/Japanese/Korean languages. +defaultContentLanguageInSubdir = false +removePathAccents = true # Workaround for https://github.com/gohugoio/hugo/issues/5687 + +summaryLength = 30 # Listing summary length in words. Also, see `abstract_length` in `params.toml`. +paginate = 10 # Number of items per page in paginated lists. +enableEmoji = true +enableRobotsTXT = true +footnotereturnlinkcontents = "<sup>^</sup>" +ignoreFiles = ["\\.ipynb$", ".ipynb_checkpoints$", "\\.Rmd$", "\\.Rmarkdown$", "_files$", "_cache$"] + +# Workaround Hugo publishing taxonomy URLs as plurals - consistently use singular across Academic. +[permalinks] + authors = "/author/:slug/" + tags = "/tag/:slug/" + categories = "/category/:slug/" + publication_types = "/publication-type/:slug/" + +[outputs] + home = [ "HTML", "RSS", "JSON", "WebAppManifest" ] + section = [ "HTML", "RSS" ] + +[mediaTypes."application/manifest+json"] + suffixes = ["webmanifest"] + +[outputFormats.WebAppManifest] + mediaType = "application/manifest+json" + rel = "manifest" + +# Configure the Markdown renderer. +[markup] + defaultMarkdownHandler = "goldmark" + [markup.goldmark] + [markup.goldmark.renderer] + unsafe = true # Enable user to embed HTML snippets in Markdown content. + [markup.highlight] + codeFences = false # Disable Hugo's code highlighter as it conflicts with Academic's highligher. + [markup.tableOfContents] + startLevel = 2 + endLevel = 3 + +[imaging] + resampleFilter = "lanczos" + quality = 90 + anchor = "smart" # Anchor for cropping. Options include Smart and Center. + +# Taxonomies. +[taxonomies] + tag = "tags" + category = "categories" + publication_type = "publication_types" + author = "authors" + +# Related content. +[related] + threshold = 80.0 + includeNewer = true + toLower = true + + [[related.indices]] + name = "title" + weight = 60.0 + + [[related.indices]] + name = "summary" + weight = 50.0 + + [[related.indices]] + name = "tags" + weight = 80.0 + + [[related.indices]] + name = "categories" + weight = 70.0 + + [[related.indices]] + name = "authors" + weight = 20.0 + +# Install Wowchemy +[module] + [[module.imports]] + path = "github.com/wowchemy/wowchemy-hugo-modules/wowchemy" diff --git a/exampleSite/config/_default/languages.toml b/exampleSite/config/_default/languages.toml new file mode 100644 index 00000000..f7c6da68 --- /dev/null +++ b/exampleSite/config/_default/languages.toml @@ -0,0 +1,20 @@ +# Languages +# Create a `[X]` block for each language you want, where X is the language ID. +# Refer to https://sourcethemes.com/academic/docs/language/ + +# Configure the English version of the site. +[en] + languageCode = "en-us" + # contentDir = "content/en" # Uncomment for multi-lingual sites, and move English content into `en` sub-folder. + +# Uncomment the lines below to configure your website in a second language. +#[zh] +# languageCode = "zh-Hans" +# contentDir = "content/zh" +# title = "Chinese website title..." +# [zh.params] +# description = "Site description in Chinese..." +# [[zh.menu.main]] +# name = "Wo" +# url = "#about" +# weight = 1 diff --git a/exampleSite/config/_default/menus.toml b/exampleSite/config/_default/menus.toml new file mode 100644 index 00000000..45c2b8fc --- /dev/null +++ b/exampleSite/config/_default/menus.toml @@ -0,0 +1,41 @@ +# Navigation Links +# To link a homepage widget, specify the URL as a hash `#` followed by the filename of the +# desired widget in your `content/home/` folder. +# The weight parameter defines the order that the links will appear in. + +[[main]] + name = "Demo" + url = "#hero" + weight = 10 + +[[main]] + name = "Posts" + url = "#posts" + weight = 20 + +[[main]] + name = "Projects" + url = "#projects" + weight = 30 + +[[main]] + name = "Publications" + url = "#featured" + weight = 40 + +[[main]] + name = "Courses" + url = "courses/" + weight = 50 + +[[main]] + name = "Contact" + url = "#contact" + weight = 60 + +# Link to a PDF of your resume/CV from the menu. +# To enable, copy your resume/CV to `static/files/cv.pdf` and uncomment the lines below. +# [[main]] +# name = "CV" +# url = "files/cv.pdf" +# weight = 70 diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml new file mode 100644 index 00000000..70b67745 --- /dev/null +++ b/exampleSite/config/_default/params.toml @@ -0,0 +1,290 @@ +# SITE SETUP +# Guide: https://sourcethemes.com/academic/docs/get-started/ +# Documentation: https://sourcethemes.com/academic/docs/ +# +# This file is formatted using TOML syntax - learn more at https://learnxinyminutes.com/docs/toml/ +# Each configuration section is defined by a name in square brackets (e.g. `[search]`). + +############################ +## Theme +############################ + +# Choose a theme. +# Latest themes (may require updating): https://sourcethemes.com/academic/themes/ +# Browse built-in themes in `themes/academic/data/themes/` +# Browse user installed themes in `data/themes/` +theme = "minimal" + +# Enable users to switch between day and night mode? +day_night = true + +# Override the theme's font set (optional). +# Latest font sets (may require updating): https://sourcethemes.com/academic/themes/ +# Browse built-in font sets in `themes/academic/data/fonts/` +# Browse user installed font sets in `data/fonts/` +font = "" + +# Choose a font size. +# Sizes: XS (extra small), S (small), M (medium), L (large - DEFAULT), XL (extra large) +font_size = "L" + +############################ +## Basic Info +############################ + +# Website type +# Improve how search engines understand your site. +# For personal sites, choose "Person". +# For organizations and projects, choose from https://schema.org/Organization#subtypes +# E.g. Person, Organization, LocalBusiness, Project, EducationalOrganization +site_type = "Person" + +# Local business type (optional) +# If you entered "LocalBusiness" above, choose the type of business from https://schema.org/LocalBusiness#subtypes +local_business_type = "" + +# Organization name (optional) +# Enter an organization or project name. Defaults to the site title from `config.toml`. +org_name = "" + +# Description for social sharing and search engines. If undefined, superuser role is used in place. +description = "" + +############################ +## Site Features +############################ + +# Enable source code highlighting? true/false +# Documentation: https://sourcethemes.com/academic/docs/writing-markdown-latex/#highlighting-options +highlight = true +highlight_languages = ["r", "latex"] # Add support for highlighting additional languages +# highlight_style = "github" # For supported styles, see https://cdnjs.com/libraries/highlight.js/ + +# Enable LaTeX math rendering? true/false +# If false, you can enable math on a per page basis as needed. +math = false + +# Enable diagram rendering? true/false +# If false, you can enable diagrams on a per page basis as needed. +diagram = false + +# Privacy pack +# Show a cookie consent message to visitors +# Anonymize IP in Google Analytics (if enabled) +privacy_pack = false + +# Enable visitors to edit pages? +# `repo` defines the repository URL. `editable` defines which page types can be edited. +edit_page = {repo_url = "https://github.com/gcushen/hugo-academic", content_dir = "", repo_branch = "master", editable = {docs = true, page = false, post = false}} + +# Show related content at the bottom of pages? +show_related = {docs = true, page = false, post = true, project = true, publication = true, talk = true} + +############################ +## Contact details +## +## These details power the Contact widget (if enabled). +## Additionally, for organizations, these details may be used to enrich search engine results. +############################ + +# Enter contact details (optional). To hide a field, clear it to "". +email = "test@example.org" +phone = "888 888 88 88" + +# Address +# For country_code, use the 2-letter ISO code (see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ) +address = {street = "450 Serra Mall", city = "Stanford", region = "CA", postcode = "94305", country = "United States", country_code = "US"} + +# Geographic coordinates +# To get your coordinates, right-click on Google Maps and choose "What's here?". The coords will show up at the bottom. +coordinates = {latitude = "37.4275", longitude = "-122.1697"} + +# Directions for visitors to locate you. +directions = "Enter Building 1 and take the stairs to Office 200 on Floor 2" + +# Office hours +# A list of your office hours. To remove, set to an empty list `[]`. +office_hours = ["Monday 10:00 to 13:00", "Wednesday 09:00 to 10:00"] + +# Enter an optional link for booking appointments (e.g. calendly.com). +appointment_url = "https://calendly.com" + +# Contact links +# Set to `[]` to disable, or comment out unwanted lines with a hash `#`. +contact_links = [ + {icon = "twitter", icon_pack = "fab", name = "DM Me", link = "https://twitter.com/Twitter"}, + {icon = "skype", icon_pack = "fab", name = "Skype Me", link = "skype:echo123?call"}, + {icon = "keybase", icon_pack = "fab", name = "Chat on Keybase", link = "https://keybase.io/"}, + {icon = "comments", icon_pack = "fas", name = "Discuss on Forum", link = "https://discourse.gohugo.io"}, + # {icon = "telegram", icon_pack = "fab", name = "Telegram Me", link = "https://telegram.me/@Telegram"}, + ] + +############################ +## Social +############################ + +# Default image for social sharing and search engines. Place image in `static/media/` folder and specify image name here. +sharing_image = "" + +# Twitter username (without @). Used when a visitor shares your site on Twitter. +twitter = "" + +############################ +## Regional Settings +############################ + +# Date and time format (refer to https://sourcethemes.com/academic/docs/customization/#date-format ) +# Examples: "Mon, Jan 2, 2006" or "2006-01-02" +date_format = "Jan 2, 2006" +# Examples: "3:04 pm" or "15:04" +time_format = "3:04 PM" + +# Address format (en-us, en-gb, de, fr-fr, zh). +address_format = "en-us" + +############################ +## Advanced +############################ + +# Main menu alignment (l = left, c = center, r = right) and logo options. +main_menu = {enable = true, align = "l", show_logo = true, highlight_active_link = true, show_language = false} + +# Show estimated reading time for posts? (true/false) +reading_time = true + +# Display next/previous section pager? (true/false) +section_pager = false +docs_section_pager = true # Display pager in Docs layout (e.g. tutorials)? + +# Enable in-built social sharing buttons? (true/false) +sharing = true + +# Show a copyright license from creativecommons.org in the site footer? +# Page specific copyright licenses are also possible by adding this option to a page's front matter. +copyright_license = {enable = false, allow_derivatives = false, share_alike = true, allow_commercial = false, notice = "This work is licensed under {license}"} + +# Highlight the site author (superuser) in author lists? (true/false) +highlight_superuser = false + +# Link authors to their profile page? (true/false) +link_authors = true + +# Abstract length (characters) in the Compact and Portfolio Card list views. Also, see `summaryLength` in `config.toml`. +abstract_length = 135 + +# Load JS plugins +# E.g. To load `/assets/js/custom.js`, set `plugins_js = ["custom"]`. +plugins_js = [] + +# Avatars. +# An avatar is an image that appears next to a user's name. +# An avatar can be uploaded as an image named `avatar` to each user's profile or fetched from Gravatar.com. +[avatar] + # Get user avatars from Gravatar.com? (true/false) + gravatar = false + + # Choose a shape for avatar images. Options: circle, square. + shape = "circle" + +# Configuration of publication pages. +[publications] + # Date format (refer to https://sourcethemes.com/academic/docs/customization/#date-format ) + # Examples: "Mon, Jan 2, 2006" or "2006-01-02" + date_format = "January 2006" + + # Citation style ("apa" or "mla") + citation_style = "apa" + +# Configuration of project pages. +[projects] + # Views for associated content. + # 1: List + # 2: Compact + # 3: Card + # 4: Citation (publications only) + post_view = 2 + publication_view = 2 + talk_view = 2 + +############################ +## Comments +############################ +[comments] + # Comment provider: + # 0: Disabled + # 1: Disqus (https://disqus.com) + # 2: Commento (https://commento.io) + engine = 0 + + # Which page types are commentable? + commentable = {page = true, post = true, docs = true, project = true, publication = true, talk = true} + + # Configuration of Disqus. + [comments.disqus] + shortname = "" # Paste the shortname from your Disqus dashboard. + show_count = true # Show comment count in page header? (true/false) + + # Configuration of Commento. + [comments.commento] + # If self-hosting Commento, enter its URL here (e.g. "https://commento.?.com"), otherwise leave empty. + url = "" + +############################ +## Search +############################ +[search] + # Search provider: + # 0: No search engine + # 1: Academic (built-in) + # 2: Algolia (https://www.algolia.com) + engine = 1 + + # Configuration of Algolia search engine. + # Paste the values from your Algolia dashboard. + [search.algolia] + app_id = "" + api_key = "" + index_name = "" + show_logo = false + +############################ +## Maps +############################ +[map] + # To show your address on a map in the Contact widget, enter your latitude and longitude (above) + # and choose a map provider below. + # + # To use Google Maps, set `engine` to 1 and enter your API key that can be obtained here: + # https://developers.google.com/maps/documentation/javascript/get-api-key + # To use OpenStreetMap tiles, set `engine` to 2. + # To use OpenStreetMap on a high traffic site, set `engine` to 3 and enter your API key that can be obtained here: + # https://www.mapbox.com/studio/account/tokens + # + # Map provider: + # 0: No map + # 1: Google Maps + # 2: OpenStreetMap (Mapnik) + # 3: OpenStreetMap (Mapbox) + engine = 2 + api_key = "" + zoom = 15 + +############################ +## Marketing +############################ +[marketing] + google_analytics = "" + google_tag_manager = "" + +############################ +## Content Management System +############################ +[cms] + # See https://sourcethemes.com/academic/docs/install/#install-with-web-browser + netlify_cms = true + +############################ +## Icon Pack Extensions +############################ +[icon.pack] + ai = false # Academicons icon pack https://jpswalsh.github.io/academicons/ |