jimmy/mkdocs.yml at master · marph91/jimmy · 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
site_name: Jimmy
site_description: Jimmy is tool to convert your notes from various formats to Markdown. This can be used to import to note applications such as Joplin and Obsidian.
# Needed to generate a sitemap.xml for search indexing.
# See: https://stackoverflow.com/a/59295885/7410886
# The autogenerated sitemap is available at https://marph91.github.io/jimmy/sitemap.xml
site_url: https://marph91.github.io/jimmy/

# Repository
repo_name: marph91/jimmy
repo_url: https://github.com/marph91/jimmy

# Generate URLs in the format "jimmy/formats/cherrytree/".
# Don't remove this as it would yield in many invalid links!
# https://zensical.org/docs/setup/basics/?h=use_directory_urls#use_directory_urls
use_directory_urls: true

theme:
  # https://github.com/squidfunk/mkdocs-material/blob/4c0004e16b1d51511fbd3c8537394069f004ecfe/material/templates/base.html
  name: material
  logo: images/favicon.png
  favicon: images/favicon.png
  # add open graph metadata (for example for discourse links)
  # https://mrkeo.github.io/reference/meta-tags/#customization
  custom_dir: docs/overrides
  features:
    # enable previous and next buttons: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#navigation
    - navigation.footer
    # index.html for collapsible sections
    - navigation.indexes
    # show breadcrumbs
    - navigation.path
    # use more space for content and less for the toc
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration
    - toc.integrate
  palette:
    # light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
    # dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/marph91/jimmy
    # TODO
    #- icon: fontawesome/brands/python
    #  link: https://pypi.org/project/jimmy
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/watch?v=54t6WalJUmo

plugins:
  # show last updated at bottom
  # TODO: https://github.com/zensical/backlog/issues/18
  # - git-revision-date-localized
  # open external links in a new tab
  # TODO: https://github.com/zensical/zensical/issues/447
  # - open-in-new-tab
  - search
markdown_extensions:
  - admonition
  # for image width
  - attr_list
  - footnotes
  # code block highlighting
  - pymdownx.superfences:
      custom_fences:
        # mermaid code blocks
        - name: mermaid
          class: mermaid
  # strikethrough
  - pymdownx.tilde
  # disable the toc, since there is not that much content
  # https://github.com/squidfunk/mkdocs-material/discussions/2644#discussioncomment-715040
  - toc:
      permalink: true
      toc_depth: 0

# Page tree
nav:
  - index.md
  - Using Jimmy: using_jimmy.md
  - Formats:
    - Default Conversion: formats/default.md
    - Anki: formats/anki.md
    - Anytype: formats/anytype.md
    - Bear: formats/bear.md
    - Cacher: formats/cacher.md
    - CherryTree: formats/cherrytree.md
    - Clipto: formats/clipto.md
    - ColorNote: formats/colornote.md
    - Day One: formats/day_one.md
    - Diaro: formats/diaro.md
    - Drafts: formats/drafts.md
    - Dynalist: formats/dynalist.md
    - Evernote: formats/evernote.md
    - Facebook: formats/facebook.md
    # fusebase == nimbus note
    - FuseBase: formats/nimbus_note.md
    # gnote == tomboy-ng
    - Gnote: formats/tomboy_ng.md
    - Google Docs: formats/google_docs.md
    - Google Keep: formats/google_keep.md
    - Joplin: formats/joplin.md
    - jrnl: formats/jrnl.md
    - Nimbus Note: formats/nimbus_note.md
    - Notion: formats/notion.md
    - Obsidian: formats/obsidian.md
    - OneNote: formats/onenote.md
    - QOwnNotes: formats/qownnotes.md
    - RedNotebook: formats/rednotebook.md
    - Reflect: formats/reflect.md
    - Roam Research: formats/roam_research.md
    - Samsung Notes: formats/samsung_notes.md
    - Signal: formats/signal.md
    - Simplenote: formats/simplenote.md
    - Standard Notes: formats/standard_notes.md
    - Synology Note Station: formats/synology_note_station.md
    - Telegram: formats/telegram.md
    - Textbundle: formats/textbundle.md
    - Tiddlywiki: formats/tiddlywiki.md
    # TODO
    # - Todo.txt: formats/todo.txt.md
    # - Todoist: formats/todoist.md
    - Tomboy-ng: formats/tomboy_ng.md
    # - Toodledo: formats/toodledo.md
    - Turtl: formats/turtl.md
    - UpNote: formats/upnote.md
    - Wordpress: formats/wordpress.md
    # - xit: formats/xit.md
    - Zettelkasten: formats/zettelkasten.md
    - Zim: formats/zim.md
    - Zoho Notebook: formats/zoho_notebook.md
  - Import Instructions: import_instructions.md
  - Additional features:
    - Customizing the Output: additional_features/output_customization.md
    - Filters: additional_features/filters.md
    - Show the Note Tree: additional_features/show_note_tree.md
    - Templates: additional_features/templates.md
    - Miscellaneous: additional_features/miscellaneous.md
  - Contributing:
    - How to Contribute?: contributing/contributing.md
    - How to get sample data?: contributing/get_sample_data.md
    - More Note Apps: contributing/more_note_apps.md
    - Development Considerations: contributing/development_considerations.md