mkdocs_theme.yml 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. # Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>
  2. # Permission is hereby granted, free of charge, to any person obtaining a copy
  3. # of this software and associated documentation files (the "Software"), to
  4. # deal in the Software without restriction, including without limitation the
  5. # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  6. # sell copies of the Software, and to permit persons to whom the Software is
  7. # furnished to do so, subject to the following conditions:
  8. # The above copyright notice and this permission notice shall be included in
  9. # all copies or substantial portions of the Software.
  10. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  11. # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  12. # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
  13. # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  14. # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  15. # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  16. # IN THE SOFTWARE.
  17. # Language for theme localization
  18. language: en
  19. # Text direction (can be ltr or rtl), default: ltr
  20. direction:
  21. # Feature flags for functionality that alters behavior significantly, and thus
  22. # may be a matter of taste
  23. feature:
  24. # Another layer on top of the main navigation for larger screens in the form
  25. # of tabs, especially useful for larger documentation projects
  26. tabs: false
  27. # Sets the primary and accent color palettes as defined in the Material Design
  28. # documentation - possible values can be looked up in the getting started guide
  29. palette:
  30. # Primary color used for header, sidebar and links, default: indigo
  31. primary:
  32. # Accent color for highlighting user interaction, default: indigo
  33. accent:
  34. # Fonts used by Material, automatically loaded from Google Fonts - see the site
  35. # for a list of available fonts
  36. font:
  37. # Default font for text
  38. text: Roboto
  39. # Fixed-width font for code listings
  40. code: Roboto Mono
  41. # Favicon to be rendered
  42. favicon: assets/images/favicon.png
  43. # The logo of the documentation shown in the header and navigation can either
  44. # be a Material Icon ligature (see https://material.io/icons/) or an image URL
  45. logo:
  46. icon: "\uE80C"
  47. # Material includes the search in the header as a partial, not as a separate
  48. # template, so it's correct that search.html is missing
  49. include_search_page: false
  50. # Material doesn't use MkDocs search functionality but provides its own. For
  51. # this reason, only the search index needs to be built
  52. search_index_only: true
  53. # Static pages to build
  54. static_templates:
  55. - 404.html