zotero-docs/mkdocs.yml at main · zotero/zotero-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
site_name: Zotero Documentation
site_url: https://www.zotero.org/support/
repo_url: https://github.com/zotero/zotero-docs
edit_uri: edit/main/content/
docs_dir: content
site_dir: build

# Phase 1 of link validation: warn (not strict) on broken in-corpus references
# and missing anchors. Once the existing broken links are cleaned up, the CI
# can flip to `mkdocs build --strict` and these become hard errors.
# `/`-prefixed links pass through as external (e.g. /download/, /blog/...).
validation:
  links:
    not_found: warn
    absolute_links: ignore
    anchors: warn

theme:
  name: null
  custom_dir: theme

# Suppress the JS/CSS that MkDocs injects by default — the wrapping site
# chrome supplies its own.
extra_css: []
extra_javascript: []

# Use directory URLs (i.e., /support/quick_start_guide/, served by index.html)
# so links survive the move from Dokuwiki without trailing extensions.
use_directory_urls: true

hooks:
  - hooks.py

# Curated sidebar. Mirrors index.md's organization but trimmed of pages that
# don't belong in a navigation menu (footer/policy pages, link-only stubs like
# zotero_support, individual screencasts, etc.). Pages not listed here are
# still built and searchable — they're just not in the sidebar.
nav:
  - Home: index.md

  - Getting Started:
      - Installation: installation.md
      - Quick Start Guide: quick_start_guide.md
      - System Requirements: system_requirements.md
      - Frequently Asked Questions: frequently_asked_questions.md
      - Version History: changelog.md

  - Adding to Your Library:
      - Adding Items: adding_items_to_zotero.md
      - Adding Files: attaching_files.md
      - Feeds: feeds.md
      - Retrieve PDF Metadata: retrieve_pdf_metadata.md
      - Importing from Other Tools: moving_to_zotero.md

  - Organizing & Taking Notes:
      - Collections and Tags: collections_and_tags.md
      - Searching: searching.md
      - Sorting: sorting.md
      - PDF Reader: pdf_reader.md
      - Notes: notes.md
      - Related Items: related.md
      - Duplicate Detection: duplicate_detection.md

  - Citations & Bibliographies:
      - Creating Bibliographies: creating_bibliographies.md
      - Word Processor Integration: word_processor_integration.md
      - Citation Styles: styles.md
      - Reports: reports.md

  - Syncing & Collaboration:
      - Data and File Syncing: sync.md
      - Groups: groups.md
      - My Publications: my_publications.md

  - Preferences:
      - Preferences: preferences.md
      - Connector Preferences: connector_preferences.md
      - Languages: supported_languages.md

  - Knowledge Base: kb.md

  - Troubleshooting:
      - Getting Help: getting_help.md
      - Library Data Issues: zotero_data.md
      - Web Saving Issues: troubleshooting_translator_issues.md
      - Word Processor Plugin Issues: word_processor_plugin_troubleshooting.md
      - Data Sync Issues: kb/changes_not_syncing.md
      - File Sync Issues: kb/files_not_syncing.md
      - File Handling Issues: kb/file_handling_issues.md

  - Developers: dev/index.md

markdown_extensions:
  - admonition
  - tables
  - fenced_code
  - attr_list
  - md_in_html
  - codehilite:
      guess_lang: false
  - toc:
      permalink: '#'
      # Use underscores in heading IDs to match Dokuwiki convention, so
      # existing in-page anchor links (e.g. `#saving_webpages`) still work.
      separator: '_'
  # Build-time typography: straight quotes → curly, ... → ellipsis. Smart
  # dashes are disabled because pandoc emitted some prose em-dashes as plain
  # `--`, which smarty would turn into en-dashes (the wrong direction).
  - smarty:
      smart_dashes: false
      smart_quotes: true
      smart_ellipses: true
      substitutions:
        left-single-quote: "‘"
        right-single-quote: "’"
        left-double-quote: "“"
        right-double-quote: "”"
        ellipsis: "…"