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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert docs to use mdbook #3212

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Convert docs to use mdbook #3212

wants to merge 1 commit into from

Conversation

maxbrunsfeld
Copy link
Contributor

@maxbrunsfeld maxbrunsfeld commented Mar 24, 2024

This will make the docs easier to read, because MDBook provides a search tool, light and dark themes, and convenient navigation, and a standard UI that people are used to from other projects.

It will also make it easier to navigate the docs, and maintain them, because the layout can accommodate a larger number of smaller pages.

馃毀 WIP 馃毀

  • fix all of the links
  • make the playground look good
  • make sure the GitHub action correctly deploys the GitHub pages site

Wizking217

This comment was marked as spam.

- [Rust](https://github.com/tree-sitter/tree-sitter/tree/master/lib/binding_rust)
- [Swift](https://github.com/ChimeHQ/SwiftTreeSitter)

### Parsers
Copy link
Member

Choose a reason for hiding this comment

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

Can this list be removed and replaced with a link to this (or copied to the wiki)?

Copy link
Contributor

@clason clason Apr 11, 2024

Choose a reason for hiding this comment

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

https://github.com/nvim-treesitter/nvim-treesitter/wiki/List-of-parsers is more up to date (feel free to steal and maintain)

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.

None yet

4 participants