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

Adding PDF Building #350

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
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
18 changes: 18 additions & 0 deletions .github/workflows/link_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# from: https://github.com/gaurav-nelson/github-action-markdown-link-check

name: Check Markdown links

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
2 changes: 1 addition & 1 deletion docs/ReDU.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## "What is ReDU?"
**Finding and reusing data is hard.** ReDU aims to make that easier. **[ReDU](https://redu.ucsd.edu/)** is a community-minded approach to find and reuse public data containing tandem MS data at the repository scale. ReDU is the bridge between the Global Natural Product Social Molecular Networking Analysis Platform [(GNPS)](https://gnps.ucsd.edu/ProteoSAFe/static/gnps-splash.jsp) and [MassIVE](https://massive.ucsd.edu/ProteoSAFe/static/massive.jsp), a public data repository for mass spectrometry data. The key to making this work is a systemic way of capturing basic information about each file contributed to ReDU (*i.e.* sample information aka metadata). Using the sample information, users can select public data for re-analysis in GNPS or provide their own data along with public data to perform co-analysis. Our aim is to empower researchers to put their data in the context of public data as well as explore questions using public data at the repository scale.

![image](https://github.com/mwang87/ReDU-MS2-Documentation/tree/master/docs/images/image_doc.png)
![image](https://github.com/mwang87/ReDU-MS2-Documentation/raw/master/docs/images/image_doc.png)

!!! question "How do I contribute to ReDU?"
**This is a community effort and everyone is encouraged to participate by submitting their own data and sample information [instructions](https://mwang87.github.io/ReDU-MS2-Documentation/HowtoContribute/).**
Expand Down
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ plugins:
- git-revision-date-localized:
type: datetime
- mermaid2
- with-pdf:
output_path: documentation.pdf
show_anchors: true


markdown_extensions:
- toc:
Expand Down
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ pymdown-extensions>=7.0
mkdocs-material-extensions>=1.0
mkdocs-git-revision-date-localized-plugin
mkdocs-git-authors-plugin
mkdocs-mermaid2-plugin
mkdocs-mermaid2-plugin
mkdocs-with-pdf