publik-base-theme/README

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

472 lines
15 KiB
Plaintext
Raw Permalink Normal View History

Base theme for Publik
=====================
Variables
---------
- css_variant: this is the main variable, it is used to build the path to the
CSS file. (/static/{{css_variant}}/style.css)
- favicon: path to favicon file, relative to /static/ directory.
- logo_link_url: link to be used for the top logo, defaults to the site root.
2021-01-11 19:11:05 +01:00
Code Style
----------
2021-07-08 11:57:26 +02:00
black is used to format the Python code, using these parameters:
2021-01-11 19:11:05 +01:00
black --target-version py37 --skip-string-normalization --line-length 110
2021-07-08 11:57:26 +02:00
Similarly, isort is used for imports, using these parameters:
isort --profile black --line-length 110
2022-09-29 12:11:13 +02:00
djhtml is used to automatically indent html files, using those parameters:
djhtml --tabwidth 2
2022-09-29 12:11:13 +02:00
There is .pre-commit-config.yaml to use pre-commit to automatically run black,
isort and djhtml before commits. (execute `pre-commit install` to install the
git hook.)
2021-01-11 19:11:05 +01:00
2015-09-03 16:50:36 +02:00
License
-------
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.
You should have received a copy of the GNU Affero General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>.
This program incorporates independent elements, with their own authors and
copyright notices:
* Yanone Kaffeesatz font
# https://www.fontsquirrel.com/fonts/yanone-kaffeesatz
#
# Licensed under the SIL Open Font License, Version 1.1.
# https://www.fontsquirrel.com/license/yanone-kaffeesatz
2018-04-16 18:19:03 +02:00
* Ubuntu font
# https://www.fontsquirrel.com/fonts/ubuntu
#
# Licensed under the Ubuntu Font License, Version 1.0.
# https://www.fontsquirrel.com/license/ubuntu
2018-04-17 18:35:20 +02:00
* D-Din font
# https://www.fontsquirrel.com/fonts/d-din
#
# Licensed under the SIL Open Font License v1.10
# https://www.fontsquirrel.com/license/d-din
* Source Sans Pro
# https://www.fontsquirrel.com/fonts/source-sans-pro
#
# Licensed under the SIL Open Font License v1.10
# https://www.fontsquirrel.com/license/source-sans-pro
2018-05-04 18:16:31 +02:00
* Asap fonts
# Copyright (c) 2019, Omnibus-Type (www.omnibus-type.com | omnibus.type@gmail.com).
# https://github.com/Omnibus-Type/Asap/
2018-06-12 17:40:44 +02:00
#
# Licensed under the SIL Open Font License v1.10
# https://github.com/Omnibus-Type/Asap/blob/master/LICENSE.md
2018-05-04 18:16:31 +02:00
2018-06-12 17:36:39 +02:00
* Raleway font
# Copyright (c) 2010, Matt McInerney (matt@pixelspread.com),
# Copyright (c) 2011, Pablo Impallari (www.impallari.com|impallari@gmail.com),
# Copyright (c) 2011, Rodrigo Fuenzalida (www.rfuenzalida.com|hello@rfuenzalida.com),
# with Reserved Font Name Raleway
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/raleway
2018-06-12 17:36:16 +02:00
* Oswald font
# Copyright (c) 2012, Vernon Adams (vern@newtypography.co.uk),
# with Reserved Font Name Oswald
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/oswald
2018-07-12 22:35:07 +02:00
* Bitter font
# Copyright (c) 2011, Sol Matas (www.huertatipografica.com.ar),
# with Reserved Font Name “Bitter”
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/bitter
2018-09-17 14:26:04 +02:00
* Cantarell font
# Copyright © 2009-2011, Understanding Limited <dave@understandinglimited.com>
# Copyright © 2010-2011, Jakub Steiner <jimmac@gmail.com>
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://gitlab.gnome.org/GNOME/cantarell-fonts/blob/master/COPYING
2018-09-17 16:19:23 +02:00
* Barlow font
# Copyright 2017 The Barlow Project Authors (https://github.com/jpt/barlow)
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/barlow
2018-10-03 17:52:59 +02:00
* Titillium font
# Copyright (c) 2008-2010, Accademia di Belle Arti di Urbino
# (www.campivisivi.net|direzione@accademiadiurbino.it),
# with Reserved Font Name Titillium.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/Titillium
* Montserrat & Montserrat Alternates fonts
# Copyright 2011 The Montserrat Project Authors
# (https://github.com/JulietaUla/Montserrat)
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/montserrat
2019-02-14 20:09:30 +01:00
* Khand font
# Copyright (c) 2014, Indian Type Foundry (info@indiantypefoundry.com).
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/khand
2022-11-21 22:00:41 +01:00
* Archivo Black
# Copyright (c) 2012-2015, Omnibus-Type (www.omnibus-type.com|omnibus.type@gmail.com)
# with Reserved Font Name "Archivo Black";
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/archivo-black
2019-02-14 20:17:34 +01:00
* Archivo Narrow
# Copyright (c) 2012, Omnibus-Type (omnibus.type@gmail.com),
# with Reserved Font Name "Archivo";
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/archivo-narrow
2019-02-28 21:23:03 +01:00
* Roboto Slab
# Font data copyright Google 2013
#
# Apache License
#
# https://www.fontsquirrel.com/license/roboto-slab
2019-02-15 16:59:17 +01:00
* Lato font
# Copyright (c) 2014, Typoland
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# http://www.latofonts.com/
2015-09-03 16:50:36 +02:00
2019-03-26 11:09:43 +01:00
* Cabin
# Copyright (c) 2011, Pablo Impallari (www.impallari.com|impallari@gmail.com),
# Copyright (c) 2011, Igino Marini. (www.ikern.com|mail@iginomarini.com),
# with Reserved Font Name Cabin.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1
#
# https://www.fontsquirrel.com/license/cabin
2019-04-15 11:45:41 +02:00
* Poppins
# Copyright (c) 2014, Indian Type Foundry (info@indiantypefoundry.com).
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1
#
# https://www.fontsquirrel.com/license/poppins
2019-06-24 13:03:39 +02:00
* Now Alt
# Copyright (c) 2015, Alfredo Marco Pradil
# (<http://behance.net/pradil | ammpradil@gmail.com>),
# with Reserved Font Name Now Alt.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1
2019-08-06 09:44:32 +02:00
* Abel
# Copyright (c) 2011, Matthew Desmond (http://www.madtype.com | mattdesmond@gmail.com),
# with Reserved Font Name Abel.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/abel
2019-08-09 17:05:20 +02:00
* Work Sans
# Copyright (c) 2014-2015 Wei Huang (wweeiihhuuaanngg@gmail.com)
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/work-sans
2019-08-15 17:59:16 +02:00
* Exo 2
# Copyright (c) 2013, Natanael Gama (www.ndiscovered.com . info(at)ndiscovered.com), with Reserved Font Name Exo.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/exo-2
* Droid Sans
# Copyright © 2006, 2007, 2008, 2009, 2010 Google Corp.
# Droid is a trademark of Google Corp.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
2019-08-29 12:46:46 +02:00
* Carme
# Copyright (c) 2010-2011, Rubén Prol (ipanemagrafica@gmail.com|www.ipanemagrafica.com), with Reserved Font Name Carme.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# This license is available with a FAQ at: http://scripts.sil.org/OFL
2019-08-29 13:19:51 +02:00
* PT Sans
# Copyright © 2009 ParaType Ltd.
# with Reserved Names "PT Sans" and "ParaType".
#
# Paratype PT Sans Free Font License v1.00.
#
# https://www.fontsquirrel.com/license/pt-sans
2019-08-29 13:31:09 +02:00
* Catamaran
# Copyright 2014 Pria Ravichandran (pria.ravichandran@gmail.com)
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/catamaran
2019-08-29 14:34:08 +02:00
* Quattrocento Sans
# Copyright (c) 2011, Pablo Impallari (www.impallari.com|impallari@gmail.com),
# Copyright (c) 2011, Igino Marini. (www.ikern.com|mail@iginomarini.com),
# with Reserved Font Name Quattrocento Sans.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/quattrocento-sans
2019-10-30 15:18:56 +01:00
* Muli
# Copyright (c) 2011 by vernon adams (vern@newtypography.co.uk),
# with Reserved Font Name “Muli”.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/muli
* Open Sans Condensed
# Copyright Ascender Corp.
#
# Apache License
#
# https://www.fontsquirrel.com/license/open-sans-condensed
2019-12-10 12:03:59 +01:00
* Noto Sans
# Copyright 2012 Google Inc. All Rights Reserved.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/noto-sans
* Abril Fatface
# Copyright (c) 2011, Copyright (c) 2011, TypeTogether
# (www.type-together.com info@type-together.com),
# with Reserved Font Names “Abril” and “Abril Fatface”
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/abril-fatface
2020-03-31 09:32:44 +02:00
* Yantramanav
# Copyright 2014, Erin McLaughlin (hello@erinmclaughlin.com).
# Copyright 2010, Google Inc. All Rights Reserved.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/yantramanav
2020-04-02 17:11:51 +02:00
* Fira Sans
# Copyright (c) 2014, Mozilla Foundation https://mozilla.org/
# with Reserved Font Name Fira Sans.
# Copyright (c) 2014, Telefonica S.A.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/fira-sans
2020-04-21 11:24:30 +02:00
* Josefin Sans
# Copyright (c) 2010 by Typemade (hi@typemade.mx). All rights reserved.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/josefin-sans
2020-08-11 11:32:33 +02:00
* Dancing Script
# Copyright 2016 The Dancing Script Project Authors (impallari@gmail.com)
# with Reserved Font Name 'Dancing Script.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://github.com/impallari/DancingScript
2021-02-11 12:56:05 +01:00
* Baloo 2
# Baloo 2 is Copyright (c) 2019 Ek Type (www.ektype.in)
# Licensed under the SIL Open Font License 1.1 (http://scripts.sil.org/OFL).
#
# https://github.com/EkType/Baloo2
2021-05-19 14:56:00 +02:00
* Krub
# Copyright 2018 The Krub Project Authors (https://github.com/cadsondemak/Krub)
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://github.com/cadsondemak/Krub/
2021-06-08 10:07:13 +02:00
* Orkney
# Concept Sketches: Samuel Oakes, font development: Alfredo Marco Pradil
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://fontlibrary.org/en/font/orkney
2021-11-21 12:23:04 +01:00
* Marianne
# To be licensed under the MIT license - http://opensource.org/licenses/MIT
#
# « L'équipe DSFR m'a fait un retour : la Marianne sera a priori aussi sous
# licence MIT. le sujet sera discuté bientôt. Dans tous les cas, la volonté est
# d'inscrire la police dans une logique de licence libre. »
# (November 18th 2021 - https://dev.entrouvert.org/issues/43470#note-32)
#
# TODO: update once the DSFR team gets back to it.
* Spectral
# Copyright 2017 Production Type (info@productiontype.com)
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/spectral
* Dosis
# Copyright (c) 2011, Edgar Tolentino and Pablo Impallari
# (www.impallari.com|impallari@gmail.com),
# Copyright (c) 2011, Igino Marini. (www.ikern.com|mail@iginomarini.com),
# with Reserved Font Names "Dosis".
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/dosis
* Playfair Display
# Copyright (c) 2010-2012 by Claus Eggers Sørensen (es@forthehearts.net),
# with Reserved Font Name Playfair
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/playfair-display
2022-05-11 12:34:09 +02:00
* Inter
# Copyright (c) 2016-2020 The Inter Project Authors.
# "Inter" is trademark of Rasmus Andersson.
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://github.com/rsms/inter
2022-05-31 10:49:22 +02:00
* IBM Plex Serif
# Copyright © 2017 IBM Corp. with Reserved Font Name "Plex".
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/fonts/ibm-plex
2022-11-23 16:11:56 +01:00
* RemixIcon
# Copyright (c) 2020 RemixIcon.com
#
# Released under the Apache License Version 2.0
#
# https://github.com/Remix-Design/RemixIcon
2022-08-12 11:46:24 +02:00
* Rubik
# Copyright (c) 2015 by Hubert & Fischer. All rights reserved
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/rubik
2022-11-21 22:00:41 +01:00
* Viga
# Copyright (c) 2011 Fontstage (info@fontstage.com), with Reserved Font Name “Viga”
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/viga
2022-10-04 11:09:13 +02:00
* Manrope
# Copyright 2018 The Manrope Project Authors. All rights reserved
#
# TThis Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://github.com/sharanda/manrope
2023-05-11 10:37:03 +02:00
* Butler Stencil
# Copyright (c) 2019 Fabian De Smet, with Reserved Font Name "Butler Stencil"
#
# This Font Software is licensed under the Creative Commons Attribution-ShareAlike License, version 4.00
#
# https://www.fontsquirrel.com/license/butler
2023-05-17 15:19:05 +02:00
* Public Sans
# Copyright (c) 2015 Impallari Type (www.impallari.com), with Reserved Font Name “Public Sans”
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/public-sans
* MuseoModerno
# Copyright (c) 2020, Omnibus-Type (www.omnibus-type.com|omnibus.type@gmail.com).
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://github.com/Omnibus-Type/MuseoModerno/blob/master/LICENSE.md
2023-09-11 15:10:23 +02:00
* Nunito Sans
# Copyright 2016 The Nunito Project Authors (contact@sansoxygen.com),
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://www.fontsquirrel.com/license/nunito-sans
2024-01-23 12:00:42 +01:00
* Arimo
# Copyright (c) 2013 Steve Matteson.
#
# This Font Software is licensed under the Apache License Version 2.0.
#
# https://www.fontsquirrel.com/license/arimo
2024-02-19 13:41:34 +01:00
* Kumbh Sans
# Copyright 2020 The KumbhSans Project Authors (https://github.com/xconsau/KumbhSans)
#
# This Font Software is licensed under the SIL Open Font License, Version 1.1.
#
# https://github.com/xconsau/KumbhSans/blob/master/OFL.txt
2019-03-26 11:09:43 +01:00
~~~~
Some theme variant files have their own specific licenses; refer to
static/$theme/README for details.