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

add mkdocs first draft #1382

Merged
merged 3 commits into from
Dec 21, 2024
Merged

add mkdocs first draft #1382

merged 3 commits into from
Dec 21, 2024

Conversation

oregonpillow
Copy link

Closes #1380

@@ -0,0 +1,4 @@
mkdocs==1.6.1
Copy link
Owner

Choose a reason for hiding this comment

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

Are mkdocs releases variable enough that this is needed over just pip install --no-cache-dir mkdocs as mentioned in their docs?

Copy link
Author

Choose a reason for hiding this comment

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

Sorry i don't understand exactly what you mean and i couldn't find reference to the mkdocs "release variable"?

You could install with pip install --no-cache-dir mkdocs mkdocs-meterial or you could install using the requirements file: pip install -r requirements.txt.
I just realized that some of the requirements I had were not needed and I've just simplified it to:

mkdocs==1.6.1
mkdocs-material==9.5.49

mkdocs-material is the theme being used. I tried it without and readability is objectively worse with default mkdocs theme, which is probably why the material theme seems to be a ubiquitous choice for many mkdocs sites.

mkdocs/mkdocs.yml Outdated Show resolved Hide resolved
@oregonpillow oregonpillow marked this pull request as draft December 17, 2024 21:34
@oregonpillow oregonpillow marked this pull request as ready for review December 17, 2024 21:34
@trapexit trapexit merged commit 50fa7ac into trapexit:master Dec 21, 2024
24 of 41 checks passed
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