-
Notifications
You must be signed in to change notification settings - Fork 16
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
Move to mkdocs #66
Conversation
There was a problem hiding this 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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
@EverVino CI is working |
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.