Skip to content

Commit f614c5e

Browse files
Update styling and add getting started.
1 parent e7dc65a commit f614c5e

File tree

9 files changed

+320
-57
lines changed

9 files changed

+320
-57
lines changed

docs/mkdocs.yaml

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ site_name: DataJoint Python
44
repo_url: https://github.com/datajoint/datajoint-python
55
repo_name: datajoint/datajoint-python
66
nav:
7-
- DataJoint Python: getting_started.md
8-
- Getting Started: getting_started.md
7+
- DataJoint Python: getting_started/index.md
8+
- Getting Started: getting_started/index.md
99
- Concepts: concepts.md
1010
- Tutorials: tutorials.md
1111
- About:
@@ -17,9 +17,13 @@ nav:
1717
edit_uri: ./edit/master/docs/src
1818
docs_dir: ./src
1919
theme:
20+
font:
21+
text: Roboto Slab
22+
code: Source Code Pro
2023
name: material
2124
custom_dir: src/.overrides
22-
logo: assets/images/project-logo-black.png
25+
icon:
26+
logo: main/project-logo-black
2327
favicon: assets/images/project-logo-color.png
2428
features:
2529
- toc.integrate
@@ -38,7 +42,7 @@ plugins:
3842
- search
3943
- redirects:
4044
redirect_maps:
41-
"index.md": "getting_started.md"
45+
"index.md": "getting_started/index.md"
4246
- mkdocstrings:
4347
default_handler: python
4448
- gen-files:
@@ -54,10 +58,16 @@ markdown_extensions:
5458
- toc:
5559
permalink: true
5660
- pymdownx.emoji:
61+
emoji_index: !!python/name:materialx.emoji.twemoji
62+
emoji_generator: !!python/name:materialx.emoji.to_svg
5763
options:
5864
custom_icons:
5965
- .overrides/.icons
6066
- mdx_truly_sane_lists
67+
- pymdownx.tabbed:
68+
alternate_style: true
69+
- admonition
70+
- pymdownx.details
6171
- pymdownx.superfences:
6272
custom_fences:
6373
- name: mermaid
@@ -68,8 +78,10 @@ extra:
6878
version:
6979
provider: mike
7080
social:
71-
- icon: datajoint/company-logo
81+
- icon: main/company-logo
7282
link: https://www.datajoint.com/
83+
- icon: fontawesome/solid/ticket
84+
link: https://support.djneuro.io/portal/en/home
7385
- icon: fontawesome/brands/slack
7486
link: https://datajoint.slack.com
7587
- icon: fontawesome/brands/linkedin
@@ -78,6 +90,10 @@ extra:
7890
link: https://twitter.com/DataJointIO
7991
- icon: fontawesome/brands/github
8092
link: https://github.com/datajoint
93+
- icon: fontawesome/brands/docker
94+
link: https://hub.docker.com/u/datajoint
95+
- icon: fontawesome/brands/python
96+
link: https://pypi.org/user/datajointbot
8197
- icon: fontawesome/brands/stack-overflow
8298
link: https://stackoverflow.com/questions/tagged/datajoint
8399
- icon: fontawesome/brands/youtube

docs/src/.overrides/.icons/datajoint/company-logo.svg

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Loading
Lines changed: 22 additions & 0 deletions
Loading
Binary file not shown.
Lines changed: 54 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,59 @@
1-
[data-md-color-scheme="datajoint"] {
2-
3-
--dj-yellow: #fcb954;
4-
5-
--md-primary-fg-color: var(--dj-yellow);
6-
--md-primary-bg-color: #000000;
7-
--md-primary-fg-color--dark: var(--dj-yellow);
8-
9-
--md-accent-fg-color: var(--dj-yellow);
10-
11-
--md-code-bg-color: #e4f3f6;
1+
:root {
2+
--dj-primary: #00a0df;
3+
--dj-secondary: #ff5113;
4+
--dj-background: #808285;
5+
--dj-black: #000000;
6+
--dj-white: #ffffff;
7+
}
128

13-
--md-footer-fg-color: var(--dj-yellow);
9+
[data-md-color-scheme="datajoint"] {
10+
/* ribbon */
11+
/* ribbon + markdown heading expansion */
12+
--md-primary-fg-color: var(--dj-black);
13+
/* ribbon text */
14+
--md-primary-bg-color: var(--dj-primary);
15+
16+
/* navigation */
17+
/* navigation header + links */
18+
--md-typeset-a-color: var(--dj-primary);
19+
/* navigation on hover + diagram outline */
20+
--md-accent-fg-color: var(--dj-secondary);
21+
22+
/* main */
23+
/* main header + already viewed*/
24+
--md-default-fg-color--light: var(--dj-background);
25+
/* primary text */
26+
--md-typeset-color: var(--dj-black);
27+
/* code comments + diagram text */
28+
--md-code-fg-color: var(--dj-secondary);
29+
30+
/* footer */
31+
/* previous/next text */
32+
--md-footer-fg-color: var(--dj-primary);
1433
}
1534

1635
[data-md-color-scheme="slate"] {
17-
18-
--dj-yellow: #fcb954;
19-
20-
--md-typeset-color: #e4f3f6;
21-
--md-typeset-a-color: #17b2ff;
22-
23-
--md-default-fg-color: #e4f3f6;
24-
--md-default-fg-color--light: var(--dj-yellow);
25-
26-
--md-primary-fg-color: var(--dj-yellow);
27-
--md-primary-bg-color: #000000;
28-
--md-primary-fg-color--dark: var(--dj-yellow);
29-
30-
--md-accent-fg-color: var(--dj-yellow);
31-
32-
--md-code-fg-color: #76c9e9;
33-
--md-code-hl-comment-color: #ffd28d;
34-
35-
--md-footer-fg-color: var(--dj-yellow);
36+
/* ribbon */
37+
/* ribbon + markdown heading expansion */
38+
--md-primary-fg-color: var(--dj-primary);
39+
/* ribbon text */
40+
--md-primary-bg-color: var(--dj-white);
41+
42+
/* navigation */
43+
/* navigation header + links */
44+
--md-typeset-a-color: var(--dj-primary);
45+
/* navigation on hover + diagram outline */
46+
--md-accent-fg-color: var(--dj-secondary);
47+
48+
/* main */
49+
/* main header + already viewed*/
50+
--md-default-fg-color--light: var(--dj-background);
51+
/* primary text */
52+
--md-typeset-color: var(--dj-white);
53+
/* code comments + diagram text */
54+
--md-code-fg-color: var(--dj-secondary);
55+
56+
/* footer */
57+
/* previous/next text */
58+
--md-footer-fg-color: var(--dj-white);
3659
}

docs/src/getting_started.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)