diff --git a/config.toml b/config.toml index 2cb9e72..aef7131 100644 --- a/config.toml +++ b/config.toml @@ -1,35 +1,146 @@ -baseurl = "https://ghp.chubachi.net/" +baseURL = "http://www.example.com" title = "YC's Blog" -languageCode = "en-us" -paginate = "10" # Number of posts per page -theme = "Mainroad" -disqusShortname = "" # Enable comments by entering your Disqus shortname -googleAnalytics = "" # Enable Google Analytics by entering your tracking id - -[Author] - name = "YC" - bio = "YC's true identity is unknown. Maybe he is a successful blogger or writer. Nobody knows it." - avatar = "img/avatar.png" - -[Params] - description = "YC's Personal blog about everything" # Description of your site - opengraph = true - twitter_cards = false - readmore = false # Show "Read more" button in list if true - authorbox = true - pager = true - post_meta = ["date", "categories"] # Order of post meta information - -[Params.logo] - subtitle = "My blog about everything" # Logo subtitle - -[Params.sidebar] - home = "right" # Configure layout for home page - list = "right" # Configure layout for list pages - single = "right" # Configure layout for single pages - # Enable widgets in given order - widgets = ["search", "recent", "categories", "taglist"] - -[Params.widgets] - recent_num = 3 # Set the number of articles in the "Recent articles" widget - tags_counter = false # Enable counter for each tag in "Tags" widget (disabled by default) +# for smart copyright line, leave this blank and check [params.copyright] +# copyright = "" + +theme = "minimo" + +disqusShortname = "" +googleAnalytics = "" + +Paginate = 5 +preserveTaxonomyNames = true + +enableRobotsTXT = true # generate robots.txt + +# Syntax Highlighting ( https://gohugo.io/content-management/syntax-highlighting/ ) +pygmentsCodefences = true + +enableEmoji = true + +# Missing translations will default to this content language +defaultContentLanguage = "en" + +[params.info] +description = "My Blog for Everything" +title404 = "Nothing's here!" + +[params.assets] +favicon = "favicon.ico" +customCSS = ["css/custom.css"] +customJS = ["js/custom.js"] +gopher = "" # used in 404 template ( Generator: https://gopherize.me ) + +[params.copyright] +prefix = "" +holder = "ychubachi" +startYear = "2021" +suffix = "" + +[params.settings] +# date & time format: https://golang.org/pkg/time/ +# dateFormat = "2006, Jan 02" +dateFormat = "2006-01-02" +listDateFormat = "2006-01-02" +archiveDateFormat = "Jan 02" +hideEntryNavigation = ["page"] # boolean / array of sections +hideEntryMeta = ["page"] # boolean / array of sections +showReadingTime = true +showLastmod = true +taxonomyCloudShuffle = true +accentColor = "#ffcd00" +hideMainMenu = true + +[params.sidebar] +enable = false + +[params.widgets] +header = ["breadcrumbs"] +homepage = ["recent_posts"] +sidebar = ["about","search","sidebar_menu","taxonomy_cloud"] +footer = ["taxonomy_cloud", "social_menu"] + +[params.opengraph.facebook] +admins = [] # array of Facebook IDs +appID = "" +pageID = "" + +[params.opengraph.twitter] +page = "" # Twitter page username + +[params.seo] +# Title Separator: - – — · • * ⋆ | ~ « » < > +titleSeparator = "•" + +[params.social] +# codepen = "MunifTanjim" +# email = "contact@example.com" +facebook = "ychubachi" +github = "ychubachi" +# gitlab = "MunifTanjim" +# instagram = "MunifTanjim" +# linkedin = "muniftanjim" +twitter = "ychubachi" +# telegram = "MunifTanjim" +# google_scholar = "qc6CJjYAAAAJ" +# youtube = "UCT-U0rNerYxItGcuoPX-WYA" + +[params.comments] +enable = false + +# Isso: https://posativ.org/isso/ +[params.comments.isso] +enable = false +scriptSrc = "" # "https://isso.example.com/js/embed.min.js" +dataAttrs = "" # "data-isso='https://isso.example.com' data-isso-require-author='true'" + +[params.comments.staticman] +enable = true +apiEndpoint = "https://api.staticman.net/v2/entry" +maxDepth = 2 +username = "MunifTanjim" +repository = "minimo" + +# Utterances: https://utteranc.es +[params.comments.utterances] +enable = false +issueTerm = "pathname" # pathname / url / title / og:title / +label = "" +theme = "github-light" + +[params.comments.utterances.github] +username = "MunifTanjim" +repository = "minimo" + +[params.search] +client = "fuse" # algolia / fuse / lunr + +[params.search.algolia] +appId = "" +indexName = "" +searchApiKey = "" + +[taxonomies] +author = "authors" +category = "categories" +series = "series" +tag = "tags" + +[permalinks] +page = "/:slug/" + +[[menu.main]] +name = "Repo" +weight = -10 +identifier = "repository" +url = "https://github.com/MunifTanjim/minimo" + +[blackfriday] +hrefTargetBlank = true + +[languages] +# edit this block for your own language +[languages.en] +lang = "en" +languageName = "English" +weight = 1 diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..593b7cd --- /dev/null +++ b/content/_index.md @@ -0,0 +1,9 @@ +--- +title: Home +menu: + - main + - sidebar +weight: -270 +--- +> Minimalism is not a lack of something. It’s simply the perfect amount of something. +> — Nicholas Burroughs diff --git a/content/authors/_index.md b/content/authors/_index.md new file mode 100644 index 0000000..c19d421 --- /dev/null +++ b/content/authors/_index.md @@ -0,0 +1,3 @@ +--- +title: Authors +--- diff --git a/content/docs/_index.md b/content/docs/_index.md new file mode 100644 index 0000000..4d1c768 --- /dev/null +++ b/content/docs/_index.md @@ -0,0 +1,10 @@ +--- +title: Documentation +linkTitle: Docs +menu: + main: + sidebar: + identifier: docs +weight: -250 +slug: docs +--- diff --git a/content/docs/authors.md b/content/docs/authors.md new file mode 100644 index 0000000..3be830d --- /dev/null +++ b/content/docs/authors.md @@ -0,0 +1,48 @@ +--- +date: 2017-09-26T06:00:00+06:00 +lastmod: 2017-10-11T17:30:00+06:00 +title: Authors Setup Guide +authors: ["muniftanjim"] +categories: + - features +tags: + - authors +slug: authors +--- +Minimo supports multiple authors for your site. Just make sure you have the following configuration in your site's **`config.toml`**: + +```toml +[taxonomies] +author = "authors" +``` + +Minimo treats Authors as a [Hugo Taxonomy](https://gohugo.io/content-management/taxonomies/). + +## Author's Profile + +For adding an author to your site: + +- Create **`data/authors`** folder in your site's root directory +- Create a file with the filename format: **`.toml`** + +Now, add information about the author using the structure below: + +**/data/authors/muniftanjim.toml** + +{{< file "data/authors/muniftanjim.toml" >}} + +_You can use either the `[email]` fields or the `[social.email]` field. You don't need to fill them both. However, it is encouraged to use `[email]` instead of `[social.email]`._ + +## Adding Authors to Contents + +For adding authors to your content include the following option in your content's front-matter: + +```yaml +--- +authors: ["muniftanjim"] +--- +``` + +- `authors` [`Array` of `String`s]: username of authors + +That's all. diff --git a/content/docs/comments-support.md b/content/docs/comments-support.md new file mode 100644 index 0000000..13336e5 --- /dev/null +++ b/content/docs/comments-support.md @@ -0,0 +1,153 @@ +--- +date: 2018-03-29T09:00:00+06:00 +lastmod: 2020-08-10T22:00:00+06:00 +title: Comments Support +authors: ['muniftanjim'] +categories: + - features +tags: + - config +slug: comments-support +comments: true +toc: true +--- + +Minimo has support for comments baked into it. + +## Enable/Disable Comments + +### Globally + +For enabling or disabling comments globally, check the following setting in your `config.toml` file: + +```toml +[params.comments] +enable = false +``` + +- `params.comments` [`Map`]: + - `enable` [`Boolean`]: Enable/Disable comments globally + +### For Specific Posts + +The global `.Site.Params.comments.enable` setting can be overridden for specific posts in their content's frontmatter with this option: + +```yaml +--- +comments: true +--- + +``` + +- `comments` [`Boolean`]: Enable/Disable comments for specific posts + +_Of course, you'll also need to setup a comment system ( [Disqus](#disqus) or [Staticman](#staticman) )._ + +## Setting Up Comment System + +Minimo currently supports **[Disqus](https://disqus.com/)**, **[Isso](https://posativ.org/isso/)**, **[Staticman](https://staticman.net/)** and **[Utterances](https://utteranc.es)** to be used as your site's comment system. + +### Disqus + +Disqus comments require you set a single value to the following option in your `config.toml` file: + +```toml +disqusShortname = "" +``` + +- `disqusShortname` [`String`]: Shortname for you site's Disqus account + +And that's all! + +### Isso + +Isso is a lightweight alternative to Disqus. You need to have a Isso server running somewhere, then set up the following options in your `config.toml` file: + +```toml +[params.comments.isso] +enable = true +scriptSrc = "https://isso.example.com/js/embed.min.js" +dataAttrs = "data-isso='https://isso.example.com data-isso-require-author='true'" +``` + +- `params.comments.isso` [`Map`]: + - `enable` [`Boolean`]: Enable Isso + - `scriptSrc` [`String`]: URL of the Isso integration script. + - `dataAttrs` [`String`]: Data attributes to add to the Isso `