Skip to content

Setup mkdocs#2

Merged
thompsonmj merged 21 commits intoImageomics:mainfrom
thompsonmj:setup-mkdocs
Nov 15, 2024
Merged

Setup mkdocs#2
thompsonmj merged 21 commits intoImageomics:mainfrom
thompsonmj:setup-mkdocs

Conversation

@thompsonmj
Copy link
Copy Markdown
Contributor

This PR produces a static website of the repository contents formatted with MkDocs and the Material for MkDocs theme.

After merging, the site may be deployed through the repo Settings -> Pages, Deploy from a branch, gh-pages, / (root).

The site can be tested locally by cloning, setting an environment with requirements.txt, and running mkdocs serve.

Copy link
Copy Markdown
Member

@egrace479 egrace479 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some formatting is rendering a bit odd (mainly on the Two Repo Problem page). Otherwise just some other suggestions and a couple notes for later.

thompsonmj and others added 14 commits November 15, 2024 08:19
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Copy link
Copy Markdown
Member

@egrace479 egrace479 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple more things looking over this again.

thompsonmj and others added 3 commits November 15, 2024 15:51
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Copy link
Copy Markdown
Member

@egrace479 egrace479 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@thompsonmj thompsonmj merged commit eca9e5a into Imageomics:main Nov 15, 2024
egrace479 added a commit that referenced this pull request Oct 8, 2025
* Reformat based on tool use-case
Add more tools we use, re-orient, ref #2

Co-authored-by: Matt Thompson <thompson.4509@osu.edu>

* Add short marimo description

* Add short description of Markdownlint
remove some redundancy

* Add creator preface for all GH links

---------

Co-authored-by: Matt Thompson <thompson.4509@osu.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants