diff --git a/README.md b/README.md index 23aa316..c928e9d 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,12 @@ These settings apply to both site types (hub and project). tos_link: https://www.example.com/tos privacy_policy_link: https://www.example.com/privacy - # These are required for the theme to work: + # no_auto_fontawesome: yes + # Specify this only if you want to disable free Font Awesome CDN. + # IMPORTANT: In this case your site MUST specify include head.html with appropriate scripts. + # Theme design relies on Font Awesome “solid” and “brands” icon styles + # and expects them to be included in SVG mode. + # Without this setting, one-file FA distribution, all.js, is included from free FA CDN. theme: jekyll-theme-open-project permalink: /blog/:month-:day-:year/:title/ @@ -154,10 +159,10 @@ and name as word(s). Drop a file called `title.html` in the root of your site. In its contents you can go as simple as `{{ site.name }}` and as complex as a custom SVG shape. - + Note that it must look good when placed inside ~30px tall container. In case of SVG, SVG guidelines apply. - + Do not create custom CSS rules for .site-logo descendants: this may cause issues when one site’s logo is used in context of another site of the same hub. You can use inline styling, though. @@ -346,6 +351,7 @@ parent_hub: algolia_search: api_key: '' index_name: '' + # Only add this if you want to use Algolia’s search on your project site. tag_namespaces: @@ -508,7 +514,7 @@ external_links: # GitHub, Docs.rs, RubyDoc, # ietf.org/html/rfcN, datatracker.ietf.org/doc/… # * Order links according to importance for project site visitors. -# The first link will be highlighted as primary. +# The first link will be highlighted as primary. feature_with_priority: 1 # With this key, software or spec will be featured on home @@ -695,7 +701,7 @@ Commonly used layouts are: ### Page frontmatter -Typical expected page frontmatter is `title` and `description`. Those are +Typical expected page frontmatter is `title` and `description`. Those are also used by jekyll-seo-tag plugin to add the appropriate meta tags. Commonly supported in page frontmatter is the hero_include option, @@ -817,7 +823,7 @@ run `bundle install`. To experiment with this code, add content (projects, software, specs) and run `bundle exec jekyll serve`. This starts a Jekyll server -using this theme at `http://localhost:4000`. +using this theme at `http://localhost:4000`. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`. diff --git a/_config.yml b/_config.yml index ae1c3ee..a1e0809 100644 --- a/_config.yml +++ b/_config.yml @@ -41,6 +41,16 @@ collections: output: true permalink: /:name/ +fontawesome_cdn: + version: v5.8.1 + integrity: "sha384-g5uSoOSBd7KkhAMlnQILrecXvzst9TdC09/VM+pjDTCM+1il8RHz5fKANTFFb+gQ" +# Only applies if no_auto_fontawesome is not set. + +no_auto_fontawesome: false +# If set to yes, site (with default design) must specify + + {% unless site.no_auto_fontawesome %} + + {% endunless %} {% if site.algolia_search %} @@ -28,6 +35,8 @@ {% endif %} {% seo %} + + {% include head.html %} {% assign num_projects = site.projects | size %} @@ -99,14 +108,14 @@

{% include logo.html %}

{% endcomment %} + {% endif %} diff --git a/_layouts/docs-base.html b/_layouts/docs-base.html index ab421c6..bd830e8 100644 --- a/_layouts/docs-base.html +++ b/_layouts/docs-base.html @@ -24,8 +24,8 @@

{% if num_top_nav_items > 0 %} - - + + {% endif %}