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

create a documentation site #356

Open
plastikfan opened this issue Nov 28, 2024 · 0 comments
Open

create a documentation site #356

plastikfan opened this issue Nov 28, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@plastikfan
Copy link
Contributor

plastikfan commented Nov 28, 2024

mkdocs/material looks to be a good opton, despite my disdain for material. I really wanted to use gitbook, but had a bad experience in the past when attempting to use it back then for a different project and discovered that even an innocent mistake can easily corrupt your git repo.

PS: I found this from the documentation for wezterm which I am considering using to replace Warp with because of its poor implementation of completions and its rejection of shell based completions.

Actually, the core site is mkdocs and you can choose a different theme to material.

Also see getting started with squidfunk, this might require the use of docker and a lot of python infrastructure, so I need urgently to get a new mac.

@plastikfan plastikfan added the documentation Improvements or additions to documentation label Nov 28, 2024
@plastikfan plastikfan self-assigned this Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant