Skip to content

Commit

Permalink
Populate with default wiki contents
Browse files Browse the repository at this point in the history
  • Loading branch information
idechq-bot committed Jul 31, 2024
1 parent 14903f7 commit 3fd8385
Show file tree
Hide file tree
Showing 15 changed files with 547 additions and 2 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: ci
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force --config-file ./mkdocs.yml
397 changes: 397 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# 2024_NAU-CHINA-DE
Wiki repository for 2024 iDEC Team: NAU-CHINA-DE
# Wiki repoistory for iDEC 2024 | NAU-CHINA-DE

(This a temporary README file that needs to be updated before you submit the team wiki. Please stay tuned at [idec.io](https://idec.io) for future relevant announcements.)

This is the wiki repository for iDEC 2024, Team: NAU-CHINA-DE.

The wiki created from this repository is hosted at [idec-teams.github.io/2024_NAU-CHINA-DE](https://idec-teams.github.io/2024_NAU-CHINA-DE).

The default wiki layout is powered by [MkDocs](http://mkdocs.org) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.

## License

[MkDocs](http://mkdocs.org) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) are under the MIT Licence. Contents of this wiki are under the [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode) Copyright License.
2 changes: 2 additions & 0 deletions docs/documentation/notebook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Lab notebooks

1 change: 1 addition & 0 deletions docs/documentation/protocols.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Protocols
Binary file added docs/img/idec-wiki-logo-white-bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/idec-wiki-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# iDEC 2024 | NAU-CHINA-DE

This wiki template was built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). You are by no means confined to use this template. In fact, you are encouraged to build your own unique **static site** that best suits your project, and you are free to use any framework you like.

Should you decide to use this wiki, however, we have a [tutorial](https://wiki.idec.io/team_wiki/mkdocs/) to walk you through the basics.
12 changes: 12 additions & 0 deletions docs/javascripts/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
window.MathJax = {
tex: {
inlineMath: [["\\(", "\\)"]],
displayMath: [["\\[", "\\]"]],
processEscapes: true,
processEnvironments: true
},
options: {
ignoreHtmlClass: ".*|",
processHtmlClass: "arithmatex"
}
};
6 changes: 6 additions & 0 deletions docs/javascripts/tables.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
document$.subscribe(function() {
var tables = document.querySelectorAll("article table")
tables.forEach(function(table) {
new Tablesort(table)
})
})
1 change: 1 addition & 0 deletions docs/project/background.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Background
1 change: 1 addition & 0 deletions docs/project/results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Results
1 change: 1 addition & 0 deletions docs/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Our Team
43 changes: 43 additions & 0 deletions docs/useful_features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Useful features

Note: Please **remove this page from your repository** and the wiki by the time you submit your team wiki.

Below you can find some useful features for your project documentation.

## Mathematical equations input by LaTeX

Reference: [squidfunk.github.io/mkdocs-material/reference/mathjax/](https://squidfunk.github.io/mkdocs-material/reference/mathjax/)

Block style:

$$
f(x) = \frac{1}{\sigma\sqrt{2\pi}}
\exp\left( -\frac{1}{2}\left(\frac{x-\mu}{\sigma}\right)^{\!2}\,\right)
$$

Inline style: $E=mc^2$

## Sortable tables

Reference: [squidfunk.github.io/mkdocs-material/reference/data-tables/](https://squidfunk.github.io/mkdocs-material/reference/data-tables/)

Try clicking on the different table headers

| Task | Due Date | Priority |
| ------ | ---------- | -------- |
| Task A | 2024-06-01 | 3 |
| Task B | 2024-05-01 | 2 |
| Task C | 2024-07-01 | 1 |

## Markdown footnotes for citations

Reference: [squidfunk.github.io/mkdocs-material/reference/data-tables/](https://squidfunk.github.io/mkdocs-material/reference/footnotes/)

All footnotes will appear at the end of the page. For example:

The International Directed Evolution Competition (iDEC)[^1] is an international competition on directed evolution[^2].

[^1]: [iDEC Website About Us Page](https://idec.io/pages/about_us.html)
[^2]:
This is not a real citation.
Multiple line footnote is supported.
50 changes: 50 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
site_name: iDEC 2024 | NAU-CHINA-DE

theme:
name: material
logo: img/idec-wiki-logo-white-bg.png
favicon: img/idec-wiki-logo.png

palette:
primary: light blue
accent: blue

features:
- navigation.sections

markdown_extensions:
- footnotes

# For MathJax
- pymdownx.arithmatex:
generic: true

# For buttons and image control
- attr_list

extra_javascript:
# For MathJax: https://squidfunk.github.io/mkdocs-material/reference/mathjax/
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# For sortable data tables: https://squidfunk.github.io/mkdocs-material/reference/data-tables/
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- javascripts/tables.js

edit_uri: blob/main/docs/

repo_url: https://github.com/idec-teams/2024_NAU-CHINA-DE

copyright: Copyright © 2024 iDEC. CC-BY-4.0 | The International Directed Evolution Competition (iDEC) is a Scottish Charitable Incorporate Organisation (SCIO), registered in Scotland, with charity number:SC050826

nav:
- Home: index.md
- Team: team.md
- Project:
- Background: project/background.md
- Results: project/results.md
- Documentation:
- Protocols: documentation/protocols.md
- Lab notebook: documentation/notebook.md
- Some useful features: useful_features.md

0 comments on commit 3fd8385

Please sign in to comment.