refactor: update pre-commit config to exclude assets directory; enhan…

…ce README link and remove demo from navigation
zotko · Nov 25, 2024 · 39c04b9 · 39c04b9
1 parent 3e6030d
commit 39c04b9
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,4 +1,4 @@
-exclude: '^(examples/|docs/demo.html)'
+exclude: '^(examples/|docs/assets/)'
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v5.0.0

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ A Python package for converting XYZ molecular files into interactive 3D visualiz
  <img src="https://raw.githubusercontent.com/zotko/xyz2graph/main/.github/images/mol.gif" width="1024">
 </div>
 
-✨ [Try it live!](https://zotko.github.io/xyz2graph/demo)
+<a href="https://zotko.github.io/xyz2graph/demo" target="_blank">Try it live 🚀</a>
 
 ## Features
 

diff --git a/docs/demo.html → docs/assets/demo.html b/docs/demo.html → docs/assets/demo.html
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -36,7 +36,6 @@ nav:
   - Getting Started: getting-started.md
   - Python API: python.md
   - Command Line: cli.md
-  - Demo: demo.html
   - License: license.md
 
 
@@ -49,6 +48,9 @@ markdown_extensions:
   - admonition
   - pymdownx.details
 
+extra_templates:
+  - assets/demo.html
+
 plugins:
   - search
   - include-markdown