Skip to content
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
49 changes: 49 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Deploy Documentation

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: 3.x

- name: Install dependencies
run: pip install mkdocs-material

- name: Build documentation
run: mkdocs build

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: site

deploy:
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Binary file added docs/assets/images/File-menu.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/assets/images/ItemMenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/assets/images/annotating-paper-form.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/assets/images/attach-nanopub-menu.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/assets/images/cito-form.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/assets/images/cito-view-from-zotero.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/assets/images/comment-form.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/assets/images/import-nanopub-dialog.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/assets/images/nanopub-view.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/assets/images/note-added.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/assets/images/pdf-annotation-form.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/assets/images/pdf-annotation-linked.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/assets/images/pdf-annotation-menu.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/assets/images/pdf-highlight-text.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/assets/images/plugin-installation.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/assets/images/profile-orcid.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/assets/images/search-menu.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/assets/images/search-results.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/assets/images/setup-profile-name.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/assets/images/success-published-nanopub.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
201 changes: 201 additions & 0 deletions docs/assets/stylesheets/science-live.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
/* Science Live Brand Colors */
:root {
--sl-navy: #1e3a5f;
--sl-pink: #e91e8c;
--sl-light-blue: #5fb3d9;
--sl-white: #ffffff;
--sl-light-pink: #f5a3d0;
--sl-dark-pink: #c91677;
}

/* Primary color scheme - Navy Blue */
[data-md-color-scheme="default"] {
--md-primary-fg-color: var(--sl-navy);
--md-primary-fg-color--light: #2d4a6b;
--md-primary-fg-color--dark: #152e47;
--md-accent-fg-color: var(--sl-pink);
--md-accent-fg-color--transparent: rgba(233, 30, 140, 0.1);
}

/* Dark mode - Keep the navy but adjust for readability */
[data-md-color-scheme="slate"] {
--md-primary-fg-color: var(--sl-navy);
--md-primary-fg-color--light: #2d4a6b;
--md-primary-fg-color--dark: #152e47;
--md-accent-fg-color: var(--sl-light-pink);
--md-accent-fg-color--transparent: rgba(245, 163, 208, 0.1);
}

/* Header styling */
.md-header {
background: linear-gradient(135deg, var(--sl-navy) 0%, #2d4a6b 100%);
}

/* Tab styling */
.md-tabs {
background: linear-gradient(to right, var(--sl-navy), #2d4a6b);
}

/* Tab links - WHITE text for good contrast on navy background */
.md-tabs__item {
color: var(--sl-white);
}

.md-tabs__link {
color: var(--sl-white) !important;
opacity: 0.8;
}

.md-tabs__link:hover {
color: var(--sl-white) !important;
opacity: 1;
}

.md-tabs__link--active {
color: var(--sl-white) !important;
opacity: 1;
border-bottom: 2px solid var(--sl-pink);
}

/* Header elements */
.md-header__title {
color: var(--sl-white) !important;
}

.md-header__button {
color: var(--sl-white) !important;
}

.md-header__source {
color: var(--sl-white) !important;
}

.md-source {
color: var(--sl-white) !important;
}

.md-source__repository {
color: var(--sl-white) !important;
}

.md-source__fact {
color: var(--sl-white) !important;
opacity: 0.8;
}

/* MORE PINK ACCENTS */

/* Main headings with pink accent */
.md-typeset h1 {
border-bottom: 3px solid var(--sl-pink);
padding-bottom: 0.5rem;
color: var(--sl-navy);
}

/* Secondary headings with pink left border */
.md-typeset h2 {
border-left: 4px solid var(--sl-pink);
padding-left: 1rem;
color: var(--sl-navy);
}

/* Third level headings with pink text */
.md-typeset h3 {
color: var(--sl-pink);
}

/* Bold text in pink */
.md-typeset strong {
color: var(--sl-dark-pink);
}

/* Table headers with pink background */
.md-typeset table:not([class]) th {
background: linear-gradient(135deg, var(--sl-pink), var(--sl-dark-pink));
color: var(--sl-white);
}

/* Code blocks with pink accents */
.md-typeset .highlight {
border-left: 4px solid var(--sl-pink);
}

.md-typeset p code,
.md-typeset li code {
background-color: rgba(233, 30, 140, 0.15);
color: var(--sl-dark-pink);
padding: 0.1em 0.3em;
border-radius: 3px;
}

/* Enhanced buttons */
.md-button {
border: 1px solid var(--sl-pink);
color: var(--sl-pink);
transition: all 0.3s ease;
}

.md-button:hover {
background-color: var(--sl-pink);
color: var(--sl-white);
transform: translateY(-1px);
box-shadow: 0 4px 12px rgba(233, 30, 140, 0.3);
}

.md-button--primary {
background-color: var(--sl-pink);
color: var(--sl-white);
border-color: var(--sl-pink);
}

.md-button--primary:hover {
background-color: var(--sl-dark-pink);
border-color: var(--sl-dark-pink);
transform: translateY(-1px);
box-shadow: 0 4px 12px rgba(233, 30, 140, 0.4);
}

/* Links */
a {
color: var(--sl-pink);
}

a:hover {
color: var(--sl-dark-pink);
}

/* Navigation */
.md-nav__item .md-nav__link--active {
color: var(--sl-pink);
font-weight: bold;
}

.md-nav__item .md-nav__link:hover {
color: var(--sl-light-blue);
}

/* Admonitions */
.md-typeset .admonition.tip {
border-color: var(--sl-light-blue);
}

.md-typeset .admonition.tip > .admonition-title {
background-color: rgba(95, 179, 217, 0.1);
border-color: var(--sl-light-blue);
}

.md-typeset .admonition.info {
border-color: var(--sl-pink);
}

.md-typeset .admonition.info > .admonition-title {
background-color: rgba(233, 30, 140, 0.1);
border-color: var(--sl-pink);
color: var(--sl-dark-pink);
}

/* Footer with pink accent */
.md-footer {
background: linear-gradient(135deg, var(--sl-navy) 0%, #152e47 100%);
border-top: 3px solid var(--sl-pink);
}
3 changes: 3 additions & 0 deletions docs/development/build-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Build Process

Build instructions coming soon.
41 changes: 41 additions & 0 deletions docs/development/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing

Contribution guidelines coming soon.


## Install documentation locally

- The first step is to create a python environment:

```
python3 -m venv sciencelive
```

- The second step is to activate the sciencelive python environment:


```
source sciencelive/bin/activate
```

- The third step is to install dependencies:


```
pip install mkdocs-material
```

- Then you can generate the documentation:

```
mkdocs build
```

- And serve it to view it:

```
mkdocs serve
```

Open your favorite browser at [http://127.0.0.1:8000/science-live-platform/](http://127.0.0.1:8000/science-live-platform/) to view the documentation.

3 changes: 3 additions & 0 deletions docs/development/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Testing

Testing guidelines coming soon.
3 changes: 3 additions & 0 deletions docs/examples/literature-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Literature Review

Example workflow coming soon.
3 changes: 3 additions & 0 deletions docs/examples/research-collaboration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Research Collaboration

Collaborative research example coming soon.
3 changes: 3 additions & 0 deletions docs/examples/systematic-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Systematic Review

Systematic review workflow coming soon.
6 changes: 6 additions & 0 deletions docs/examples/video-tutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Video Tutorials


<iframe width="760" height="560" src="https://www.youtube.com/embed/BLeYIeLI6co?start=4&end=24" frameborder="0" allowfullscreen></iframe>
<iframe width="760" height="560" src="https://www.youtube.com/embed/N4swx_7GXRU" frameborder="0" allowfullscreen></iframe>
<iframe width="760" height="560" src="https://www.youtube.com/embed/X5BDU0N5sC4" frameborder="0" allowfullscreen></iframe>
3 changes: 3 additions & 0 deletions docs/getting-started/first-nanopub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Create your First Nanopub

Tutorial is coming soon!
40 changes: 40 additions & 0 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Installation

## Prerequisites
- Zotero 7.0 or later
- Active internet connection
- [ORCID](https://orcid.org) account (required for creating nanopublications)

## Download and Install

1. Download the latest `.xpi` file from [GitHub Releases](https://github.com/ScienceLiveHub/science-live-platform/releases)
2. In Zotero, go to `Tools > Add-ons`
3. Drag the `.xpi` file into the Add-ons window
4. Restart Zotero when prompted

![Nanopub Zotero plugin installation](../assets/images/plugin-installation.png)

Watch the step-by-step installation guide:

<iframe width="760" height="560" src="https://www.youtube.com/embed/BLeYIeLI6co?start=4&end=24" frameborder="0" allowfullscreen></iframe>


## Verify Installation

Right-click any item in your Zotero library and look for:

- "Create Nanopublication"
- "Attach Nanopublication"
- "Search Related Nanopublications"

![Nanopub Zotero Item Menu](../assets/images/ItemMenu.png){ width="300" }

Similar menu can be found from the "File" tab:

![Nanopub Zotero File Menu](../assets/images/File-menu.png)

If you see these options, the installation was successful!

## Next Steps

- [Quick Start Guide](quick-start.md)
Loading
Loading