From 9e2a23e83b153f40c33741b8a3923b1ab22e9f79 Mon Sep 17 00:00:00 2001 From: Junyi Hou Date: Wed, 13 Mar 2024 16:38:52 +0800 Subject: [PATCH] remove config file exmaple --- README.md | 96 ------------------------------------------------------- 1 file changed, 96 deletions(-) diff --git a/README.md b/README.md index 145401f..d68c266 100644 --- a/README.md +++ b/README.md @@ -47,102 +47,6 @@ For more information read the official [setup guide](https://gohugo.io/overview/ ## Getting started After installing the theme successfully it requires a just a few more steps to get your site running. -### Update config file -If you have toml config (which is by default), you should rename it to config.yaml or adapt this config for toml syntax. - -Example of config.yaml: -```yaml -languageCode: "en-us" -baseUrl: "" -title: "Anubis" -theme: "anubis" -paginate: 10 -disqusShortname: "yourdiscussshortname" -googleAnalytics: "G-12345" -enableRobotsTXT: true - -menu: - main: - - identifier: archive - name: Archive - title: Archive - url: /posts/ - weight: 0 - -params: - author: "John Doe" - email: mail@example.org # used for microformats - avatar: "/images/me.png" # used for microformats - description: "" - # Uncomment if you need this - # images: - # - images/og-featured.png # relative path to "static" directory - # customCSS: - # - css/my.css # relative path to "assets" directory (don't use main.css filename) - # customJS: - # - js/main.js # relative path to "assets" directory - dateFormat: "2006-01-02" - paginationSinglePost: true - style: light-without-switcher - mainSections: [ "posts" ] # which sections should be on index/main page - sectionsWithFullContentOnListPage: [ "notes" ] # for which sections content should be displayed on list pages - readMore: false # show read more button - readNextPosts: 5 # show 5 related posts, 0 by default - disableSummary: false - toc: true # display Table of Contents - tocWordCount: 300 # ...when a post is longer than 300 words - copyCodeButton: true # true by default - rssAsSocialIcon: true - mathjax: false # https://www.mathjax.org/ loading cost 257.4KiB network traffic - # utteranc.es support - utterancesRepo: "" # mandatory - utterancesTheme: "" # optional - utterancesIssue: "" # optional - utterancesLabel: "" # optional - # isso support - isso: - enabled: true # mandatory - data: "https://comments.example.com/" # mandatory - jsLocation: "https://comments.example.com/js/embed.min.js" # mandatory - css: true # optional - lang: "de" # optional - replyToSelf: true # mandatory - requireAuthor: true # mandatory - requireEmail: true # mandatory - id: "thread-id" # optional - avatar: true # optional - avatar-bg: "#f0f0f0" # optional - feed: false # optional - UmamiAnalytics: - enabled: true # mandatory - dnt: true # optional - id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # mandatory - datacache: false # optional - url: "https://abc.example.com/umami.js" # mandatory - graphcommentId: "" - # giscus support - GiscusRepo: "" # mandatory - GiscusRepoId: "" # mandatory - GiscusCategory: "Announcements" # mandatory - GiscusCategoryId: "" # mandatory - GiscusLazyLoad: false # optional - webmentions: - url: https://yourdomain.com/webemntions/receive - login: hugo-theme-anubis - pingback: true - social: - - id: github - name: gohugoio -# - id: hugo -# url: "https://gohugo.io/" -# icon: "hugo" - -markup: - goldmark: - renderer: - unsafe: true # enable raw HTML in Markdown -``` - ### Check your site In order to see your site in action, run Hugo's built-in local server.