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

Move to mkdocs #66

Merged
merged 12 commits into from
Nov 1, 2023
Merged

Move to mkdocs #66

merged 12 commits into from
Nov 1, 2023

Conversation

xmnlab
Copy link
Member

@xmnlab xmnlab commented Oct 31, 2023

hey @EverVino

I was thinking a bit, and maybe it would be better to move from hugo to mkdocs.

This is just an initial work , just to start a discussion and to check if it would be possible to make this migration.

Although hugo is very powerful, but I find the template language much more complex that it should be, also the experience for debugging is not that great.

For the other hand, mkdocs maybe it is not that powerful than mkdocs .. although it is very flexible and it is easy to create extensions.

the template here is the same used by hugo, so from the user experience, if we decide to change to mkdocs, there is no big impact.

@xmnlab xmnlab mentioned this pull request Nov 1, 2023
@xmnlab xmnlab marked this pull request as ready for review November 1, 2023 00:51
@xmnlab xmnlab requested a review from EverVino November 1, 2023 00:51
Copy link
Contributor

@EverVino EverVino left a comment

Choose a reason for hiding this comment

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

Looks great. The submenus looks cool as well.

Thanks @xmnlab

README.md Outdated

```bash
brew install hugo
git clone [email protected]:osl-incubator/opensciencelabs.github.io
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess we should change osl-incubator

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks for caching that. I am fixing that now. thanks!

```bash
cd osl-hugo.github.io
hugo server
makim pages.preview
Copy link
Contributor

Choose a reason for hiding this comment

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

This command is not working I used to start the preview mkdocs serve

Copy link
Member Author

Choose a reason for hiding this comment

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

weird .. that is working here XD
I will take a look into that .. also it is not working something on CI

Copy link
Member Author

Choose a reason for hiding this comment

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

@EverVino it seems it was installing python 3.12 and it was breaking the mkdocs command

@xmnlab
Copy link
Member Author

xmnlab commented Nov 1, 2023

@EverVino CI is working
thanks for reviewing this PR

@xmnlab xmnlab merged commit 19ee2e2 into OpenScienceLabs:main Nov 1, 2023
1 check passed
@xmnlab xmnlab deleted the move-to-mkdocs branch November 1, 2023 02:52
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