Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix Mkdocs edit button #1642

Merged
merged 19 commits into from
Apr 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# Project info
site_name: IronOS
site_url: https://ralim.github.io/IronOS/
repo_url: https://github.com/ralim/IronOS/
site_description: "IronOS Open Source Soldering Iron firmware for Miniware and Pinecil"

# repo config
repo_url: https://github.com/ralim/IronOS/

docs_dir: Documentation
edit_uri: edit/dev/Documentation/

# Theme and config
theme:
name: readthedocs
highlightsjs: true
hljs_languages:
- yaml

nav:
- Home: index.md
- Getting Started: GettingStarted.md
Expand All @@ -26,5 +39,17 @@ nav:
- Known Hardware Issues: HardwareIssues.md
- Translations: Translation.md
- Development: Development.md

theme: readthedocs

# Plugins
plugins:
- autolinks
- awesome-pages
- git-revision-date
- search

# Markdown Extensions
markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg