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

New docs #1427

Closed
wants to merge 34 commits into from
Closed

New docs #1427

wants to merge 34 commits into from

Conversation

codecalm
Copy link
Member

@codecalm codecalm commented Jan 7, 2023

Todo:

  • new docs engine
  • better examples
  • search
  • better documentation

DEMO: https://dev-docs.tabler.io

Preview:
Screenshot 2023-01-07 at 01 51 44

@vercel
Copy link

vercel bot commented Jan 7, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
tabler ✅ Ready (Inspect) Visit Preview Feb 1, 2023 at 0:28AM (UTC)
tabler-docs ❌ Failed (Inspect) Feb 1, 2023 at 0:28AM (UTC)

@kevinpapst
Copy link
Collaborator

Pros: I like the look & search. Nextra has some nice features build in.

Cons: Feels weird to use something else than Tabler, like you don't trust your own framework.

Integrating a search is possible in other ways as well, which are even compatible with GH pages and markdown/liquid. I haven't used any of those solutions yet, but there are some if you google.

I am sorry for my downvote, but I feel that this move is not clever. Improve tabler with the missing bits instead of using an entirely different framework. To me, this feels a bit like cheating 😁 if you present the docs and users think that they can built something like it with Tabler.

Please don't be offended, I assume that was a couple of hours work ... and I don't want to sound harsh or like an ass, but my opinion: that is not Tabler anymore and I strongly suggest that Tabler docs are built with Tabler itself. Be proud of your fantastic framework!

If you need help building some of the Nextra features: ask. I think there are a couple of devs willing to help out.

@ollym
Copy link
Contributor

ollym commented Jan 7, 2023

I agree with @kevinpapst, whatever features you found in Nextra that you liked enough to make this PR, focus on adding those features back into tabler and use tabler for your docs.

@codecalm
Copy link
Member Author

codecalm commented Jan 7, 2023

@kevinpapst, @ollym yeah, I understand you, but my idea was that move docs from framework to https://tabler.io website, where I want to add more complicated things like interactive demos, advanced search, and I want to improve seo of Tabler.

It doesn't matter which framework will be on background, I just need .md or .mdx files with content. I've added nextra only for preview docs while development. In final version docs will be available on official tabler website.

There is very early preview:

Screenshot 2023-01-07 at 13 04 43

I have to improve PR with marketing page plugin (#1332) and create whole website only with tabler UI:

image

@kevinpapst
Copy link
Collaborator

Alright, thanks for the clarification 👍

I have some points I'd like to raise regarding the documentation, as I am managing a larger documentation project myself. Any chance we can join the discussion early?

@codecalm
Copy link
Member Author

codecalm commented Jan 7, 2023

yes, sure. If you have any ideas how to improve it give me know anytime :)

� Conflicts:
�	.gitignore
�	package.json
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

3 participants