Skip to content

Commit 348aeea

Browse files
committed
docs
1 parent 9307252 commit 348aeea

File tree

5 files changed

+152
-0
lines changed

5 files changed

+152
-0
lines changed

docs/assets/elements-logo.png

47.2 KB
Loading

docs/index.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Welcome to Docs Hub
2+
3+
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4+
5+
## Projects
6+
7+
<script>
8+
function includeHTML() {
9+
var z, i, elmnt, file, xhttp;
10+
/*loop through a collection of all HTML elements:*/
11+
z = document.getElementsByTagName("*");
12+
for (i = 0; i < z.length; i++) {
13+
elmnt = z[i];
14+
/*search for elements with a certain atrribute:*/
15+
file = elmnt.getAttribute("w3-include-html");
16+
if (file) {
17+
/*make an HTTP request using the attribute value as the file name:*/
18+
xhttp = new XMLHttpRequest();
19+
xhttp.onreadystatechange = function() {
20+
if (this.readyState == 4) {
21+
if (this.status == 200) {elmnt.innerHTML = this.responseText;}
22+
if (this.status == 404) {elmnt.innerHTML = "Page not found.";}
23+
/*remove the attribute, and call this function once more:*/
24+
elmnt.removeAttribute("w3-include-html");
25+
includeHTML();
26+
}
27+
}
28+
xhttp.open("GET", file, true);
29+
xhttp.send();
30+
/*exit the function:*/
31+
return;
32+
}
33+
}
34+
};
35+
</script>
36+
37+
<body>
38+
<div w3-include-html="sub_docs.html"></div>
39+
<script>
40+
includeHTML();
41+
</script>
42+
</body>
43+
44+
## Commands
45+
46+
* `mkdocs new [dir-name]` - Create a new project.
47+
* `mkdocs serve` - Start the live-reloading docs server.
48+
* `mkdocs build` - Build the documentation site.
49+
* `mkdocs -h` - Print help message and exit.
50+
51+
## Project layout
52+
53+
mkdocs.yml # The configuration file.
54+
docs/
55+
index.md # The documentation homepage.
56+
... # Other markdown pages, images and other files.

docs/stylesheets/extra.css

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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;
12+
13+
--md-footer-fg-color: var(--dj-yellow);
14+
}
15+
16+
[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+
}

docs/stylesheets/styles.css

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
section {
2+
max-width: 44.5rem;
3+
padding: 0;
4+
color: #3c4043;
5+
line-height: 1.25rem;
6+
}
7+
8+
section ul {
9+
margin: 0;
10+
outline: 0;
11+
padding: 0;
12+
display: inline-block;
13+
max-width: 44.5rem;
14+
}
15+
16+
section li {
17+
min-height: 3.125rem;
18+
vertical-align: top;
19+
display: inline-block;
20+
}
21+
22+
section li > a {
23+
max-height: 7rem;
24+
padding: 0.5rem;
25+
margin: 0.5rem;
26+
border: .0625rem solid #dadce0;
27+
border-radius: .5rem;
28+
display: block;
29+
}
30+
31+
section li img {
32+
width: 4rem;
33+
height: auto;
34+
display: block;
35+
margin-left: auto;
36+
margin-right: auto;
37+
}
38+
39+
section li span {
40+
height: auto;
41+
display: block;
42+
margin: .5rem 0;
43+
text-align: center;
44+
}

docs/sub_docs.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<head>
2+
<link href="stylesheets/styles.css" rel="stylesheet" type="text/css" />
3+
</head>
4+
5+
<body>
6+
<section id="multirepo">
7+
<ul>
8+
<li>
9+
<a href="/element-array-ephys">
10+
<img src="assets/elements-logo.png" />
11+
<span>Element Array Ephys</span>
12+
</a>
13+
</li>
14+
</ul>
15+
</section>
16+
</body>

0 commit comments

Comments
 (0)