Skip to content

Commit 3e0955a

Browse files
committed
mkdocs setup added
1 parent f50ff40 commit 3e0955a

File tree

5 files changed

+122
-0
lines changed

5 files changed

+122
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy MkDocs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- name: Configure Git Credentials
17+
run: |
18+
git config user.name github-actions[bot]
19+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
20+
- uses: actions/setup-python@v5
21+
with:
22+
python-version: 3.x
23+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
24+
- uses: actions/cache@v4
25+
with:
26+
key: mkdocs-material-${{ env.cache_id }}
27+
path: ~/.cache
28+
restore-keys: |
29+
mkdocs-material-
30+
- run: pip install mkdocs-material
31+
- run: mkdocs gh-deploy --force

2_Open_Git_Repo.bat

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
@echo off
2+
setlocal
3+
4+
REM Get the active folder name
5+
for %%F in ("%cd%") do set "folderName=%%~nxF"
6+
7+
REM Open the GitHub URL with the active folder name
8+
start https://github.com/NodesAutomations/%folderName%
9+
10+
endlocal

Docs/assets/favicon.png

1.17 KB
Loading

Docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Development
2+
3+
Developer Docs

mkdocs.yml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Site settings
2+
site_name: Development
3+
site_url: https://nodesautomations.com/Development/
4+
use_directory_urls: false
5+
# Navigation Tree
6+
nav:
7+
- Home:
8+
- index.md
9+
10+
# Theme
11+
theme:
12+
name: material
13+
logo: assets/favicon.png
14+
favicon: assets/favicon.png
15+
# Palette toggle for dark mode
16+
palette:
17+
# Palette toggle for dark mode
18+
- scheme: slate
19+
primary: black
20+
accent: indigo
21+
toggle:
22+
icon: material/brightness-4
23+
name: Switch to light mode
24+
- scheme: default
25+
primary: black
26+
accent: indigo
27+
toggle:
28+
icon: material/brightness-7
29+
name: Switch to dark mode
30+
features:
31+
- content.action.edit # Allows "Edit on GitHub" links
32+
- content.action.view # Allows "View on GitHub" links
33+
- content.code.copy # Allows code blocks to have a copy button
34+
- navigation.path # Enables path navigation top of docs for smaller screens
35+
- navigation.tabs # Enables tabbed navigation
36+
- navigation.indexes # Enables attachment of sub section index
37+
icon:
38+
repo: fontawesome/brands/git-alt
39+
edit: material/pencil
40+
view: material/eye
41+
42+
# Extensions
43+
markdown_extensions:
44+
- admonition # for Callout boxes
45+
- pymdownx.highlight:
46+
anchor_linenums: true
47+
line_spans: __span
48+
pygments_lang_class: true
49+
- pymdownx.inlinehilite
50+
- pymdownx.snippets
51+
- pymdownx.superfences:
52+
custom_fences:
53+
- name: mermaid
54+
class: mermaid
55+
format: !!python/name:pymdownx.superfences.fence_code_format
56+
- pymdownx.arithmatex: # for rendering math equations
57+
generic: true
58+
- def_list # List extensions
59+
- pymdownx.tasklist: # List extensions
60+
custom_checkbox: true
61+
62+
# Copyright
63+
copyright: Copyright © 2025 Nodes Automations
64+
65+
# Footer social links
66+
extra:
67+
generator: false # remove "Generated with MkDocs" footer
68+
social:
69+
- icon: fontawesome/solid/globe
70+
link: www.nodesautomations.com
71+
- icon: fontawesome/brands/youtube
72+
link: https://www.youtube.com/NodesAutomations
73+
- icon: fontawesome/brands/linkedin
74+
link: https://www.linkedin.com/in/vivekpatel-nodesautomations/
75+
- icon: fontawesome/brands/github
76+
link: https://github.com/orgs/NodesAutomations
77+
78+

0 commit comments

Comments
 (0)