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

Choose the framework to build the doc #1

Open
bricefotzo opened this issue Jul 2, 2024 · 3 comments
Open

Choose the framework to build the doc #1

bricefotzo opened this issue Jul 2, 2024 · 3 comments

Comments

@bricefotzo
Copy link

Hugo

Pros:

  • Speed: Extremely fast build times.
  • Performance: Efficient due to being written in Go.
  • Customization: Highly customizable and flexible.
  • Scalability: Handles large sites well.

Cons:

  • Learning Curve: Steep, especially with Go templates.
  • Complexity: Setup and customization can be complicated.
  • Themes: Variety, but sometimes less professional.

MkDocs

Pros:

  • Ease of Use: Simple setup, especially for those familiar with Markdown.
  • Professional Look: Excellent default themes, like MkDocs Material.
  • Plugins: Extensive ecosystem for added functionality.
  • Accessibility: Written in Python, making it approachable for Python developers.

Cons:

  • Speed: Slower build times compared to Hugo.
  • Scalability: May struggle with very large sites.
  • Dependency: Relies on Python, which might be a drawback for non-Python users.
@bricefotzo
Copy link
Author

Given those insights I would suggest to use MkDocs as the ease of use, flexibility and extensibility are more important than the speed build in this case

@bricefotzo
Copy link
Author

@ajeetraina to keep a track of why we are chosing MkDocs

@ajeetraina
Copy link
Contributor

Thanks for bringing this discussion. Also, I have put it at the right discussion forum https://github.com/kubetoolsca/docs/discussions/3

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

No branches or pull requests

2 participants