mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-14 19:07:41 +01:00
2bb907d0d9
* added first draft of instructions for pull requests * added a diagram to explain process * added description of the process, moved specific instructions - split the diagram into two parts to easy comperehension and allow people to better follow the process - added descriptions of the conceptual steps, keeping them separate from specific instructions - moved the specific instructions under a common heading to make the ToC more readable * added explanations - added link to GitHub docu on forks - added note on philosophy followed - improved ToC structure * tried to finalize process description (see below) - added airline-style "pay attention to the instructions" tip - added bit about testing with Material for MkDocs documentation and examples from the examples repo - added note on being respectful in discussion and on how sometimes PRs do not get accepted for good reason - improvements for readability * moved the "philosophy" bit to the steps IMHO this is a better place to make this point as the comments are mainly about what tools are used, which is more relevant to the instructions, not the 30k ft view process * added more text to steps guidance, dos and don'ts - added more text to pretty much every section under 'steps' - added a section with dos and don'ts - left some questions for @squidfunk to ponder * addressing first set of comments * addressed further comments In particular: - removed the bits about linters and - about dealing with merge conflicts These may perhaps need attention in the future. * removing question about PR template
272 lines
8.8 KiB
YAML
Executable File
272 lines
8.8 KiB
YAML
Executable File
# Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
|
||
|
||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
# of this software and associated documentation files (the "Software"), to
|
||
# deal in the Software without restriction, including without limitation the
|
||
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
||
# sell copies of the Software, and to permit persons to whom the Software is
|
||
# furnished to do so, subject to the following conditions:
|
||
|
||
# The above copyright notice and this permission notice shall be included in
|
||
# all copies or substantial portions of the Software.
|
||
|
||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||
# IN THE SOFTWARE.
|
||
|
||
# Project information
|
||
site_name: Material for MkDocs
|
||
site_url: https://squidfunk.github.io/mkdocs-material/
|
||
site_author: Martin Donath
|
||
site_description: >-
|
||
Write your documentation in Markdown and create a professional static site in
|
||
minutes – searchable, customizable, in 60+ languages, for all devices
|
||
|
||
# Repository
|
||
repo_name: squidfunk/mkdocs-material
|
||
repo_url: https://github.com/squidfunk/mkdocs-material
|
||
|
||
# Copyright
|
||
copyright: Copyright © 2016 - 2023 Martin Donath
|
||
|
||
# Configuration
|
||
theme:
|
||
name: material
|
||
custom_dir: material/overrides
|
||
features:
|
||
- announce.dismiss
|
||
- content.action.edit
|
||
- content.action.view
|
||
- content.code.annotate
|
||
- content.code.copy
|
||
# - content.code.select
|
||
# - content.tabs.link
|
||
- content.tooltips
|
||
# - header.autohide
|
||
# - navigation.expand
|
||
- navigation.footer
|
||
- navigation.indexes
|
||
# - navigation.instant
|
||
# - navigation.instant.prefetch
|
||
# - navigation.instant.progress
|
||
# - navigation.prune
|
||
- navigation.sections
|
||
- navigation.tabs
|
||
# - navigation.tabs.sticky
|
||
- navigation.top
|
||
- navigation.tracking
|
||
- search.highlight
|
||
- search.share
|
||
- search.suggest
|
||
- toc.follow
|
||
# - toc.integrate
|
||
palette:
|
||
- media: "(prefers-color-scheme)"
|
||
toggle:
|
||
icon: material/link
|
||
name: Switch to light mode
|
||
- media: "(prefers-color-scheme: light)"
|
||
scheme: default
|
||
primary: indigo
|
||
accent: indigo
|
||
toggle:
|
||
icon: material/toggle-switch
|
||
name: Switch to dark mode
|
||
- media: "(prefers-color-scheme: dark)"
|
||
scheme: slate
|
||
primary: black
|
||
accent: indigo
|
||
toggle:
|
||
icon: material/toggle-switch-off
|
||
name: Switch to system preference
|
||
font:
|
||
text: Roboto
|
||
code: Roboto Mono
|
||
favicon: assets/favicon.png
|
||
icon:
|
||
logo: logo
|
||
|
||
# Plugins
|
||
plugins:
|
||
- blog
|
||
- search:
|
||
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
||
- minify:
|
||
minify_html: true
|
||
|
||
# Hooks
|
||
hooks:
|
||
- material/overrides/hooks/shortcodes.py
|
||
- material/overrides/hooks/translations.py
|
||
|
||
# Additional configuration
|
||
extra:
|
||
status:
|
||
new: Recently added
|
||
deprecated: Deprecated
|
||
analytics:
|
||
provider: google
|
||
property: !ENV GOOGLE_ANALYTICS_KEY
|
||
social:
|
||
- icon: fontawesome/brands/github
|
||
link: https://github.com/squidfunk
|
||
- icon: fontawesome/brands/docker
|
||
link: https://hub.docker.com/r/squidfunk/mkdocs-material/
|
||
- icon: fontawesome/brands/python
|
||
link: https://pypi.org/project/mkdocs-material/
|
||
- icon: fontawesome/brands/mastodon
|
||
link: https://fosstodon.org/@squidfunk
|
||
- icon: fontawesome/brands/twitter
|
||
link: https://twitter.com/squidfunk
|
||
|
||
# Extensions
|
||
markdown_extensions:
|
||
- abbr
|
||
- admonition
|
||
- attr_list
|
||
- def_list
|
||
- footnotes
|
||
- md_in_html
|
||
- toc:
|
||
permalink: true
|
||
- pymdownx.arithmatex:
|
||
generic: true
|
||
- pymdownx.betterem:
|
||
smart_enable: all
|
||
- pymdownx.caret
|
||
- pymdownx.details
|
||
- pymdownx.emoji:
|
||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||
- pymdownx.highlight:
|
||
anchor_linenums: true
|
||
line_spans: __span
|
||
pygments_lang_class: true
|
||
- pymdownx.inlinehilite
|
||
- pymdownx.keys
|
||
- pymdownx.magiclink:
|
||
normalize_issue_symbols: true
|
||
repo_url_shorthand: true
|
||
user: squidfunk
|
||
repo: mkdocs-material
|
||
- pymdownx.mark
|
||
- pymdownx.smartsymbols
|
||
- pymdownx.snippets:
|
||
auto_append:
|
||
- includes/mkdocs.md
|
||
- pymdownx.superfences:
|
||
custom_fences:
|
||
- name: mermaid
|
||
class: mermaid
|
||
format: !!python/name:pymdownx.superfences.fence_code_format
|
||
- pymdownx.tabbed:
|
||
alternate_style: true
|
||
combine_header_slug: true
|
||
slugify: !!python/object/apply:pymdownx.slugs.slugify
|
||
kwds:
|
||
case: lower
|
||
- pymdownx.tasklist:
|
||
custom_checkbox: true
|
||
- pymdownx.tilde
|
||
|
||
# Page tree
|
||
nav:
|
||
- Home: index.md
|
||
- Getting started:
|
||
- Installation: getting-started.md
|
||
- Creating your site: creating-your-site.md
|
||
- Publishing your site: publishing-your-site.md
|
||
- Customization: customization.md
|
||
- Conventions: conventions.md
|
||
- Browser support: browser-support.md
|
||
- Enterprise feedback: enterprise-support.md
|
||
- Philosophy: philosophy.md
|
||
- Alternatives: alternatives.md
|
||
- License: license.md
|
||
- Changelog:
|
||
- changelog/index.md
|
||
- How to upgrade: upgrade.md
|
||
- Contributing:
|
||
- contributing/index.md
|
||
- Reporting a bug: contributing/reporting-a-bug.md
|
||
- Reporting a docs issue: contributing/reporting-a-docs-issue.md
|
||
- Requesting a change: contributing/requesting-a-change.md
|
||
- Adding translations: contributing/adding-translations.md
|
||
- Making a pull request: contributing/making-a-pull-request.md
|
||
- Asking a question: https://github.com/squidfunk/mkdocs-material/discussions
|
||
- Guides:
|
||
- Creating a reproduction: guides/creating-a-reproduction.md
|
||
- Setup:
|
||
- setup/index.md
|
||
- Changing the colors: setup/changing-the-colors.md
|
||
- Changing the fonts: setup/changing-the-fonts.md
|
||
- Changing the language: setup/changing-the-language.md
|
||
- Changing the logo and icons: setup/changing-the-logo-and-icons.md
|
||
- Ensuring data privacy: setup/ensuring-data-privacy.md
|
||
- Setting up navigation: setup/setting-up-navigation.md
|
||
- Setting up site search: setup/setting-up-site-search.md
|
||
- Setting up site analytics: setup/setting-up-site-analytics.md
|
||
- Setting up social cards: setup/setting-up-social-cards.md
|
||
- Setting up a blog: setup/setting-up-a-blog.md
|
||
- Setting up tags: setup/setting-up-tags.md
|
||
- Setting up versioning: setup/setting-up-versioning.md
|
||
- Setting up the header: setup/setting-up-the-header.md
|
||
- Setting up the footer: setup/setting-up-the-footer.md
|
||
- Adding a git repository: setup/adding-a-git-repository.md
|
||
- Adding a comment system: setup/adding-a-comment-system.md
|
||
- Building an optimized site: setup/building-an-optimized-site.md
|
||
- Building for offline usage: setup/building-for-offline-usage.md
|
||
- Extensions:
|
||
- setup/extensions/index.md
|
||
- Python Markdown: setup/extensions/python-markdown.md
|
||
- Python Markdown Extensions: setup/extensions/python-markdown-extensions.md
|
||
- Plugins:
|
||
- plugins/index.md
|
||
- Blog: plugins/blog.md
|
||
- Group: plugins/group.md
|
||
- Info: plugins/info.md
|
||
- Meta: plugins/meta.md
|
||
- Offline: plugins/offline.md
|
||
- Optimize: plugins/optimize.md
|
||
- Privacy: plugins/privacy.md
|
||
- Projects: plugins/projects.md
|
||
- Search: plugins/search.md
|
||
- Social: plugins/social.md
|
||
- Tags: plugins/tags.md
|
||
- Typeset: plugins/typeset.md
|
||
- Requirements:
|
||
- Image processing: plugins/requirements/image-processing.md
|
||
- Caching: plugins/requirements/caching.md
|
||
- Reference:
|
||
- reference/index.md
|
||
- Admonitions: reference/admonitions.md
|
||
- Annotations: reference/annotations.md
|
||
- Buttons: reference/buttons.md
|
||
- Code blocks: reference/code-blocks.md
|
||
- Content tabs: reference/content-tabs.md
|
||
- Data tables: reference/data-tables.md
|
||
- Diagrams: reference/diagrams.md
|
||
- Footnotes: reference/footnotes.md
|
||
- Formatting: reference/formatting.md
|
||
- Grids: reference/grids.md
|
||
- Icons, Emojis: reference/icons-emojis.md
|
||
- Images: reference/images.md
|
||
- Lists: reference/lists.md
|
||
- Math: reference/math.md
|
||
- Tooltips: reference/tooltips.md
|
||
- Insiders:
|
||
- insiders/index.md
|
||
- Getting started: insiders/getting-started.md
|
||
- FAQ: insiders/faq/sponsoring.md
|
||
- Changelog:
|
||
- insiders/changelog/index.md
|
||
- How to upgrade: insiders/upgrade.md
|
||
- Community Experts Program:
|
||
- insiders/community-experts-program/index.md
|
||
- Blog:
|
||
- blog/index.md
|