Skip to content

Commit

Permalink
Update theme for documentation (#348)
Browse files Browse the repository at this point in the history
closes: #332
  • Loading branch information
pankajastro authored Jan 9, 2025
1 parent 68407f2 commit 3ec3303
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
51 changes: 50 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
site_name: DAG Factory Documentation
site_name: DAG Factory
site_url: https://astronomer.github.io/dag-factory

repo_url: https://github.com/astronomer/dag-factory
repo_name: astronomer/dag-factory

edit_uri: "blob/main/docs"

theme:
name: material
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.sections
- navigation.tabs
- navigation.footer
- navigation.indexes
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow

extra:
version:
provider: mike
Expand All @@ -14,6 +41,28 @@ markdown_extensions:
base_path: [ "." ]
- pymdownx.superfences

nav:
- Home: index.md
- Getting started:
- getting-started/quick-start-airflow-standalone.md
- getting-started/quick-start-astro-cli.md
- Configuration:
- configuration/configuring_workflows.md
- configuration/environment_variables.md
- configuration/defaults.md
- Features:
- features/dynamic_tasks.md
- Comparison:
- comparison/index.md
- comparison/traditional_operators.md
- comparison/taskflow_api.md
- Contributing:
- contributing/code_of_conduct.md
- contributing/contributors.md
- contributing/howto.md
- contributing/roles.md

plugins:
- mike:
alias_type: symlink
- search
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ dependencies = [
"mkdocs",
"mike",
"pymdown-extensions",
"mkdocs-material",
]

[tool.hatch.envs.docs.scripts]
Expand Down

0 comments on commit 3ec3303

Please sign in to comment.