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

chore: follow up docs navigation update #673

Merged
merged 5 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Contributing
---

# Contributor Guide

Thank you for your interest in improving this project. This project is
Expand Down
39 changes: 39 additions & 0 deletions docs/css/github-permalink-style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.headerlink {
--permalink-size: 16px; /* for font-relative sizes, 0.6em is a good choice */
--permalink-spacing: 4px;

width: calc(var(--permalink-size) + var(--permalink-spacing));
height: var(--permalink-size);
vertical-align: middle;
background-color: var(--md-default-fg-color--lighter);
background-size: var(--permalink-size);
mask-size: var(--permalink-size);
-webkit-mask-size: var(--permalink-size);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
visibility: visible;
mask-image: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg>');
-webkit-mask-image: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg>');
}

[id]:target .headerlink {
background-color: var(--md-typeset-a-color);
}

.headerlink:hover {
background-color: var(--md-accent-fg-color) !important;
}

@media screen and (min-width: 76.25em) {
h1, h2, h3, h4, h5, h6 {
display: flex;
align-items: center;
flex-direction: row;
column-gap: 0.2em; /* fixes spaces in titles */
}

.headerlink {
order: -1;
margin-left: calc(var(--permalink-size) * -1 - var(--permalink-spacing)) !important;
}
}
3 changes: 3 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Examples
---

# Examples

Expand Down
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Welcome to DataChain
---
# <a class="main-header-link" href="/" ><img style="display: inline-block;" src="/assets/datachain.svg" alt="DataChain"> <span style="display: inline-block;"> DataChain</span></a>

<style>
Expand Down Expand Up @@ -83,7 +86,7 @@ The following pages provide detailed documentation on DataChain's features, arch
- [🏃🏼‍♂️ Quick Start](quick-start.md): Get up and running with DataChain in no time.
- [🎯 Examples](examples.md): Explore practical examples and use cases.
- [📚 Tutorials](tutorials.md): Learn how to use DataChain for specific tasks.
- [📚 API Reference](references/index.md): Dive into the technical details and API reference.
- [🐍 API Reference](references/index.md): Dive into the technical details and API reference.
- [🤝 Contributing](contributing.md): Learn how to contribute to DataChain.


Expand Down
4 changes: 4 additions & 0 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Quick Start
---

# Quick Start

## Installation
Expand Down
4 changes: 4 additions & 0 deletions docs/references/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: API Reference
---

# API Reference

DataChain's API is organized into several modules:
Expand Down
4 changes: 4 additions & 0 deletions docs/tutorials.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Tutorials
---

# Tutorials

* Multimodal: [GitHub](https://github.com/iterative/datachain-examples/blob/main/multimodal/clip_fine_tuning.ipynb) or [Google Colab](https://colab.research.google.com/github/iterative/datachain-examples/blob/main/multimodal/clip_fine_tuning.ipynb)
Expand Down
34 changes: 18 additions & 16 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ theme:
- navigation.tabs
- navigation.path
- navigation.top
- navigation.prune
- navigation.footer
- toc.follow
- content.action.edit
Expand All @@ -37,7 +36,6 @@ theme:
- content.tooltips
- search.highlight
- search.suggest
- navigation.sections

palette:
# Palette toggle for automatic mode
Expand All @@ -56,8 +54,8 @@ theme:
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: lime
primary: teal
accent: teal
toggle:
icon: material/weather-night
name: Switch to system preference
Expand All @@ -68,18 +66,18 @@ nav:
- 🏃🏼‍♂️ Quick Start: quick-start.md
- 🎯 Examples: examples.md
- 📚 Tutorials: tutorials.md
- 🐍 API Reference: references/index.md
- 🐍 API Reference:
- Overview: references/index.md
- DataChain: references/datachain.md
- DataType: references/datatype.md
- File: references/file.md
- UDF: references/udf.md
- Torch: references/torch.md
- SQL: references/sql.md
- 🤝 Contributing: contributing.md
- API Reference:
- references/index.md
- references/datachain.md
- references/datatype.md
- references/file.md
- references/udf.md
- references/torch.md
- references/sql.md
- DataChain Website: https://datachain.ai" target="_blank"
- Studio: https://studio.datachain.ai" target="_blank"

- DataChain Website ↗: https://datachain.ai" target="_blank"
- Studio ↗: https://studio.datachain.ai" target="_blank"

markdown_extensions:
- abbr
Expand All @@ -105,7 +103,11 @@ markdown_extensions:
- pymdownx.tilde
- tables
- toc:
permalink: true
permalink: ''

# Custom permalink style: https://github.com/squidfunk/mkdocs-material/discussions/3535
extra_css:
- css/github-permalink-style.css

extra:
social:
Expand Down
Loading