search

matchai / spacefish

🚀🐟 The fish shell prompt for astronauts
https://spacefish.matchai.dev
MIT License
963 stars 79 forks source link

Revert "Fix cosmetic issues in tests and docs (#93)" #94

Closed matchai closed 5 years ago

matchai commented 5 years ago

This reverts commit d6983ae8f932f5ab65b03cffef2adf76fb347b02.

Though the links are broken in the GitHub markdown previews, they need to be this way for the GitBook generated website. As you can see here, the sidebar links no longer work after this commit: https://spacefish.netlify.com/

I plan on reworking the docs to no longer use GitBook in the future.

@jskrnbindra @Snuggle

Snuggle commented 5 years ago

Oh, darn, I was wondering why you seemed to leave them broken. Apologies for the early merge, it seemed like a small documentation change that was objectively better.

Any ideas for what you'd use instead of GitBook or why it behaves differently?

matchai commented 5 years ago

The main reason I'd want to stop using GitBook is because they officially no longer support self-built static websites. All GitBook sites should be built by them and hosted on their platform. In addition to that, the docs clutter the repo's root (SUMMARY.md, book.json) and simply aren't that nice looking. 🤷‍♂️

I was considering switching over to docz, but I'm open to proposals.

Snuggle commented 5 years ago

I have tried https://readthedocs.io before for automated documentation, they support .md and .rst, but it was a massive pain to set up with Sphinx and I'm not sure if it would even be appropriate for this project. :yum: