diff --git a/content/Configs/Guides/Guide Publisher.md b/content/Configs/Guides/Guide Publisher.md new file mode 100644 index 00000000..32295d92 --- /dev/null +++ b/content/Configs/Guides/Guide Publisher.md @@ -0,0 +1,286 @@ +--- +tags: + - guide +share: true +--- +## Setup + +https://squidfunk.github.io/mkdocs-material/setup/ + +## Share + +``` +share: false +path: +links: + mdlinks: false + convert: true + internals: false + nonShared: false +embed: + send: false + remove: keep + char: -%3E +attachment: + send: true + folder: +dataview: true +hardBreak: false +multipleRepo: + - owner: ThinkWithPbody + repo: TWP-Share + branch: main + autoclean: true + - owner: ThinkWithPbody + repo: TWP-Share + branch: temp + autoclean: true +copylink: + base: https://TWP-Share.github.io/TWP-Share +``` + +## mkdocs.yml + +``` +site_name: Notes by Yifu +site_description: Shared Obsidian Pages +site_url: https://thinkwithpbody.github.io/TWP-Obsidian-Share +site_author: Yifu Ding + +theme: + name: 'material' + logo: assets/meta/favicons.png + favicon: assets/meta/favicons.png + custom_dir: overrides + font: + text: Roboto + code: Roboto Mono + language: en + palette: + + # Light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: white + accent: deep purple + toggle: + icon: material/lightbulb + name: Switch to dark mode + + # Dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: black + accent: deep purple + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + features: + - navigation.indexes + - navigation.top + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + - navigation.expand + - navigation.footer + - search.suggest + - search.highlight + +# Extensions +markdown_extensions: + - footnotes + - nl2br + - attr_list + - sane_lists + - meta + - smarty + - tables + - mdx_breakless_lists + - def_list + - pymdownx.arithmatex: + generic: true + - pymdownx.details + - pymdownx.magiclink + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + - pymdownx.highlight: + use_pygments: true + anchor_linenums: true + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - admonition + - toc: + permalink: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format +plugins: + - search + - meta-descriptions + - git-revision-date-localized: + type: date + fallback_to_build_date: true + locale: en + custom_format: "%A %d %B %Y" + enable_creation_date: true + - ezlinks: + wikilinks: true + - awesome-pages + - embed_file: + callouts: true + custom-attributes: 'assets/css/custom_attributes.css' + - custom-attributes: + file: 'assets/css/custom_attributes.css' +# - tags: +# tags_file: tags.md + - encryptcontent: + title_prefix: '🔐' + summary: 'Private page' + placeholder: 'Password' + decryption_failure_message: 'Invalid password' + encryption_info_message: "You don't have access to this page." + search_index: 'encrypted' + password_button: True + password_button_text: '' + - callouts + - glightbox +hooks: + - overrides/hooks/on_page_markdown.py + - overrides/hooks/on_env.py + - overrides/hooks/on_files.py +extra_javascript: + - https://cdn.jsdelivr.net/gh/ObsidianPublisher/assets@main/dist/javascript.js + - https://polyfill.io/v3/polyfill.min.js?features=es6 + - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js +extra_css: + - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css + - https://cdn.jsdelivr.net/gh/ObsidianPublisher/assets@main/dist/styles.css + - assets/css/admonition.css + - assets/css/custom_attributes.css + - assets/css/customization.css +extra: + SEO: assets/meta/SEO.png + comments: False #disable comments globally + generate_graph: True #generate the graph of the site + attachments: 'assets/img' #path to the folder where the attachments are stored + no-auto-h1: True #disable the automatic generation of h1 if no h1 is found + blog_list: + pagination: true #enable pagination + pagination_message: true #display the message "Showing x posts out of y" + pagination_translation: 'posts in' #message to display before the number of posts ; Add your own translation! + no_page_found: "No pages found!" #message to display when no pages are found ; Add your own translation! + hooks: + strip_comments: true + fix_heading: true + social: + - icon: fontawesome/brands/instagram + link: https://www.instagram.com/yifu_ding_/ + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/in/yifu-ding/ +copyright: Copyright © 2024 Yifu Ding +``` + + +## Settings + +``` +{ + "github": { + "branch": "main", + "automaticallyMergePR": true, + "dryRun": { + "enable": false, + "folderName": "github-publisher" + }, + "tokenPath": "%configDir%/plugins/%pluginID%/env", + "api": { + "tiersForApi": "Github Free/Pro/Team (default)", + "hostname": "" + }, + "workflow": { + "commitMessage": "[PUBLISHER] Merge", + "name": "" + }, + "verifiedRepo": true + }, + "upload": { + "behavior": "obsidian", + "defaultName": "docs", + "rootFolder": "", + "yamlFolderKey": "", + "frontmatterTitle": { + "enable": false, + "key": "title" + }, + "replaceTitle": [], + "replacePath": [], + "autoclean": { + "enable": true, + "excluded": [] + }, + "folderNote": { + "enable": true, + "rename": "index.md", + "addTitle": { + "enable": false, + "key": "title" + } + }, + "metadataExtractorPath": "" + }, + "conversion": { + "hardbreak": false, + "dataview": true, + "censorText": [], + "tags": { + "inline": true, + "exclude": [], + "fields": [] + }, + "links": { + "internal": true, + "unshared": true, + "wiki": false, + "slugify": true + } + }, + "embed": { + "attachments": true, + "overrideAttachments": [], + "keySendFile": [], + "notes": true, + "folder": "", + "convertEmbedToLinks": "keep", + "charConvert": "->", + "useObsidianFolder": true + }, + "plugin": { + "shareKey": "share", + "excludedFolder": [ + "Configs/Templater", + "Family" + ], + "copyLink": { + "enable": true, + "links": "", + "removePart": [], + "transform": { + "toUri": true, + "slugify": "lower", + "applyRegex": [] + } + }, + "setFrontmatterKey": "Set" + } +} +``` \ No newline at end of file