diff --git a/.gitignore b/.gitignore index 773c59b..364fdec 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1 @@ -public -public/* - +public/ diff --git a/.gitmodules b/.gitmodules index 616f9a6..fb1b129 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,6 +1,6 @@ [submodule "themes/readable"] path = themes/readable - url = https://git.fbievan.live/fbievan/hugo-theme-readable + url = https://git.fbievan.live/fbievan/hugo-theme-readable.git [submodule "static/guestbook"] path = static/guestbook url = https://git.fbievan.live/fbievan/guestbook.git diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7cdbe0b --- /dev/null +++ b/LICENSE @@ -0,0 +1,438 @@ +Attribution-NonCommercial-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International +Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-NonCommercial-ShareAlike 4.0 International Public License +("Public License"). To the extent this Public License may be +interpreted as a contract, You are granted the Licensed Rights in +consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the +Licensor receives from making the Licensed Material available under +these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-NC-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution, NonCommercial, and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. NonCommercial means not primarily intended for or directed towards + commercial advantage or monetary compensation. For purposes of + this Public License, the exchange of the Licensed Material for + other material subject to Copyright and Similar Rights by digital + file-sharing or similar means is NonCommercial provided there is + no payment of monetary compensation in connection with the + exchange. + + l. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + m. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + n. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part, for NonCommercial purposes only; and + + b. produce, reproduce, and Share Adapted Material for + NonCommercial purposes only. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties, including when + the Licensed Material is used other than for NonCommercial + purposes. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-NC-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database for NonCommercial purposes + only; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..c0e81ed --- /dev/null +++ b/README.md @@ -0,0 +1,325 @@ +![logo](static/logo.svg) + +# Ficurinia + +A prickly blog theme for Hugo + +![](images/tn.png) + +# [Demo](https://gabmus.org) + +[Code for the demo website](https://gitlab.com/gabmus/gabmus.gitlab.io) (really my personal website) + +[Screenshot gallery](https://gabmus.gitlab.io/hugo-ficurinia-screenshots/) showcasing 256 of the possible configurations that Ficurinia offers. + +# Customization + +## Configuration + +These are some parameters you can use in your `config.toml` to customize Ficurinia: + +```toml +baseURL = "https://example.com/" +theme = "hugo-ficurinia" +title = "My nice blog" +languageCode = "en" +defaultContentLanguage = "en" + +# this will be included in the footer after the current year the site is last +# built, followed by the (c) symbol +# you can use markdown inside this field +copyright = "Some copyright notice - [my license](https://example.com/license)" + +paginate = 5 # number of articles per page in the index +summaryLength = 70 # number of words for article summaries + + +[params] + author = "Gabriele Musco" + description = "A description for my website" # this will be added as metadata + + posts = "posts" # content directory where to find home page posts; default searches in "posts" and "post" + showPostsLink = true # show or hide the link to the simple post list + extraContentDirs = [] # other content directories to render similarly to the home page + showcaseDir = "showcase" # create a content directory that shows a special showcase section in the home page + + # shows a specified single page as a home page, instead of the traditional articles list + # requires setting `homeSinglePage` + # goes well with extraContentDirs + showSinglePageAsHome = false + homeSinglePage = "/home" + + # It's best to put these icons in the "static" folder of your site + logo = "/logo.svg" + favicon = "/favicon.png" # 32x32 + faviconIco = "/favicon.ico" # 32x32 + appletouch = "/apple-touch-icon.png" # 180x180 + svgicon = "/logo.svg" + icon512 = "/icon512.png" # 512x512 png image + + logoRightOfTitle = false # positions the logo to the right of the title; default: false + + showTags = true # show the Tags menu item; default true + showRss = true # show the link for the RSS feed; default true + + imageInArticlePreview = false # show images in article preview; default false + fitImageInArticlePreview = false # make article preview images fit the article preview instead of getting cropped + articleSummary = true # show a summary in article preview; default true + + fontFamily = "JetBrains Mono" # changes the font, default "JetBrains Mono" + titleFontFamily = "JetBrains Mono" # font used for titles and headings + monospaceFontFamily = "JetBrains Mono" # changes the monospace font for code, default "JetBrains Mono" + + # multipliers applied to font sizes, useful for custom fonts that may be too big or too small + titleFontSizeMultiplier = 1.0 + mainFontSizeMultiplier = 1.0 + monoFontSizeMultiplier = 1.0 + + contentWidth = "1000px" # maximum width of the site content, css syntax + + paperCards = false # enable paper card style; default false + buttonTags = false # enable button tag style; default false + tagsInArticlePreview = true # enable tags list in the article preview card + gridView = false # show post list as a grid. goes well with paperCards + bigArticleTitle = false # makes the title in the single article view bigger + navtype = "standard" # changes the style of the pagination, available styles are: "standard", "circles" + enableShadow = false # shows a shadow around some elements + menuStyle = "standard" # changes the style of the main site navigation menu, available styles are: "standard", "buttons" + inputStyle = "standard" # changes the style of inputs (like the searchbar), available styles are: "standard", "buttons" + + enableSearch = true # enable search page + searchbarEverywhere = true # if the searchbar should be shown in every page; requires enableSearch + searchMenuLink = false # add a search link to the navigation menu; requires enableSearch + mobileHamburgerNav = false # alternative hamburger menu layout for the main nav menu when screen is small + + enableFeatured = false # enable a particular view for articles marked as featured (featured: true in the article frontmatter) + + underlineTitleLinks = false # show an underline also for links that are titles + + # enable comments support with commento using the script from your server + commento = "https://example.com/js/commento.js" + + # enable comments support with cactus comments (cactus.chat) + cactusCommentsSiteName = "example.com" + cactusCommentsServerName = "cactus.chat" + cactusCommentsHomeserver = "https://matrix.cactus.chat:8448" + + # enable analytics using Plausible + plausibleScriptUrl = "https://something.com/..." + plausibleDomain = "example.com" + + # enable analytics using Umami + umamiScriptUrl = "https://something.com/..." + umamiWebsiteId = "example-tracking-code" + + enableShareOnFediverse = false # enable a button at the end of an article to share it on the fediverse + tocBeforeImage = false # show the table of contents before the main article image; default false + + # WARNING: deprecated! Use [[menu.icons]] instead, look below + # links = [ + # ["GitLab", "https://gitlab.com/gabmus"], + # ["GNOME", "https://gitlab.gnome.org/gabmus"], + # ["YouTube", "https://youtube.com/TechPillsNet"] + # ] + + # you can customize all of the colors in this theme + # Colors are defined in data/colors.yml + + # alternative sidebar layout + enableSidebarLayout = false + tocInSidebar = false # if the sidebar is enbabled, show the TOC in the sidebar + + # redirect to baseURL if current URL host doesn't match + # useful if deploying in gitlab pages with custom domain and don't want + # the username.gitlab.io/website url to persist + # this requires you to set baseURL (see above) + forceRedirect = false + + infiniteScrolling = false # activates infinite scrolling instead of regular pagination + enableFooterColumns = false # activates footer columns, as described below + enableJumbotron = false # enables jumbotron, as described below + # related articles will be selected randomly based on tags and shown at + # the bottom of the article, after the comments + enableRelatedArticles = false + relatedArticlesNum = 2 # how many related articles to show + randomRelated = false # sorts related articles in random order (randomized at built time) + +[menu] + # these links will be added to the main navigation menu, sorted by weight + # other elements in this menu are added automatically from the "pages" folder + # the folder it will look into can be customized with the pages variable + # in params above + [[menu.main]] + identifier = "about" + name = "About" + url = "/about/" + weight = 10 + # these links (menu.icons) will be added as icon links below the main nav + [[menu.icons]] + identifier = "gitlab" + name = "GitLab" + url = "https://gitlab.com/gabmus" + weight = 10 + [[menu.icons]] + identifier = "gnome" + name = "GNOME GitLab" + url = "https://gitlab.gnome.org/gabmus" + weight = 20 + +# this section is necessary if you want infinite scrolling +# it allows to output the article list as paged JSON so that "pages" can be retrieved via javascript +[outputs] + home = ["HTML", "JSON"] +``` + +### Supported icons + +For the `[[menu.icons]]` menu. They match identifier, name and url can be whatever. Here's a list of supported identifiers: + +- discord +- email +- facebook +- github +- gitlab +- gnome +- instagram +- linkedin +- mastodon +- matrix +- peertube +- phone +- pleroma +- rss +- steam +- telegram +- twitter +- xmpp +- youtube + +## Colors + +Colors are completely customizable. They are defined in [`data/colors.yml`](data/colors.yml). Just copy that file over to `yoursite/data/colors.yml` and customize it to your liking. + +## Footer columns + +You can add various columns of links in the footer using the `data/footer_columns.yml` file. + +Following is an example configuration: + +```yaml +- title: My other projects + links: + - title: HydraPaper + link: https://hydrapaper.gabmus.org + - title: Ada UI + link: https://gitlab.com/gabmus/ada-ui +- title: About me + links: + - title: My personal website + link: https://gabmus.org + - title: My GitLab + link: https://gitlab.com/gabmus + - title: My GNOME GitLab + link: https://gitlab.gnome.org/gabmus +``` + +## Jumbotron + +You can add a jumbotron at the beginning of the home page using the `data/jumbotron.yml` file. + +Following is an example configuration: + +```yaml +title: My awesome website +hugeTitle: false +subtitle: Some fancy subtitle +image: /jumbotron_image.svg +imagePosition: left # values: left, right, top, bottom +background: /img/jumbotron_bg.png +backgroundVideo: /jumbotron_video.mp4 # will replace the background image +# it's best to provide both an mp4 and a web source for the video for better compatibility +backgroundVideoMp4: /jumbotron_video.mp4 +backgroundVideoWebm: /jumbotron_video.webm +videoOpacity: 1.0 +textShadow: false +fullscreen: false +downArrow: false +whiteText: false # force white text in the jumbotron +links: + - title: About me + link: /pages/about + - title: Read my blog + link: /posts +``` + +# Post parameters + +Every post can have various parameters in the frontmatter, here are some that you may find useful + +- `title`: the title of the article +- `date`: usually automatically populated, holds the date and time of the post creation +- `description`: a brief description of the post, useful for SEO optimization +- `tags`: an array of tags, useful for searching similar articles +- `image`: a link to a feature image for the article, shown in the preview as well +- `alt`: alternative text to be shown if image is not available or fails to download +- `imageCaption`: a markdown text rendered as a caption for the article image described above +- `featured`: boolean, indicate if the post should be shown as featured +- `comments`: boolean, if true it enables comments for the current post, if false it disables them (default is true) +- `showDate`: boolean, true by default, if false hides the date. Useful for non-article pages where the date isn't important +- `showTitle`: boolean, true by default, if false hides the title. +- `showShare`: boolean, true by default, if false hides the share button. +- `norss`: boolean, if set to true the page will be skipped in the rss feed +- `nosearch`: boolean, if set to true the page won't show up in searches +- `toc`: boolean, if set to true a table of contents will be shown for the article + +## Table of contents settings + +You can tweak the TOC settings in your `config.toml`: + +```toml +[markup] + [markup.tableOfContents] + endLevel = 5 + ordered = false + startLevel = 1 +``` + +# Generate icons + +It's best to use the provided `generate_icons.sh` script to generate all necessary icons for your website. This script requires ImageMagick, that you will need to install separately. + +For the best results, place your logo in svg format inside the `static` directory of your website, rename it to `logo.svg` and then call `./themes/hugo-ficurinia/generate_icons.sh static/logo.svg`. + +The script will take care of generating all the icons you need. + +Finally, make sure to edit your config.toml to include the following: + +```toml +# ... +[params] + logo = "/logo.svg" + logoAltText = "Logo" + favicon = "/favicon.png" + faviconIco = "/favicon.ico" + appletouch = "/apple-touch-icon.png" + svgicon = "/logo.svg" + # ... +``` + +# Inject custom content + +Ficurinia supports injecting custom content into the theme. There are several files you can create in `layouts/partials/inject` that will be included inside the theme in different places. + +| Partial | Placement | +|---------|-----------| +| `layouts/partials/inject/body.html` | Before closing the `body` tag | +| `layouts/partials/inject/content-after.html` | After a post or page content | +| `layouts/partials/inject/content-before.html` | Before a post or page content | +| `layouts/partials/inject/footer.html` | At the beginning of the footer | +| `layouts/partials/inject/head.html` | Before closing the `head` tag | +| `layouts/partials/inject/header-after.html` | Before closing the header | +| `layouts/partials/inject/header-before.html` | At the beginning of the header | + +# Does *Ficurinia* mean anything? + +It's Sicilian for Indian fig, also known as prickly pear cactus. diff --git a/archetypes/default.md b/archetypes/default.md index cae8048..decea26 100644 --- a/archetypes/default.md +++ b/archetypes/default.md @@ -1,5 +1,8 @@ -+++ -title = '{{ replace .File.ContentBaseName "-" " " | title }}' -date = {{ .Date }} -draft = false -+++ +title: "{{ replace (replace .Name "-" " ") "_" " " | title }}" +date: {{ .Date }} +tags: + - tag1 + - tag2 + - tag3 +image: +comments: true diff --git a/hugo.toml b/hugo.toml deleted file mode 100644 index a3e6974..0000000 --- a/hugo.toml +++ /dev/null @@ -1,27 +0,0 @@ -baseURL = 'https://testing.fbievan.live/' -languageCode = 'en-us' -title = "Fbi's Epic Blog" -theme= 'readable' -enableGitInfo= "true" -[params] - mainSections = ['posts'] -[menu] - # these links will be added to the main navigation menu, sorted by weight - # other elements in this menu are added automatically from the "pages" folder - # the folder it will look into can be customized with the pages variable - # in params above - [[menu.main]] - identifier = "home" - name = "Home" - url = "/" - weight = 1 - [[menu.main]] - identifier = "about" - name = "About" - url = "/about/" - weight = 3 - [[menu.main]] - identifier = "guestbook" - name = "GuestBook" - url = "/guestbook/" - weight = 2 diff --git a/static/cool.png b/static/cool.png deleted file mode 100644 index 57245ed..0000000 Binary files a/static/cool.png and /dev/null differ diff --git a/static/style.css b/static/style.css deleted file mode 100644 index d3b2088..0000000 --- a/static/style.css +++ /dev/null @@ -1,45 +0,0 @@ -body { - font-family: sans-serif ; - background: #110000 ; - color: #ccc ; -} - -main { - max-width: 800px ; - margin: auto ; -} - -img { - max-width: 100% ; -} - -header h1 { - text-align: center ; -} - -footer { - text-align: center ; - clear: both ; -} - -/* For TAGLIST.HTML */ -.taglist { - text-align: center ; - clear: both ; -} - -/* For NEXTPREV.HTML */ -#nextprev { - /* The container for both the previous and next articles. */ -} -#prevart { - float: left ; - text-align: left ; -} -#nextart { - float: right ; - text-align: right ; -} -#nextart,#prevart { - max-width: 33% ; -}