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

If there are other language document plan? #242

Open
BigFaceMaster opened this issue Nov 15, 2019 · 12 comments
Open

If there are other language document plan? #242

BigFaceMaster opened this issue Nov 15, 2019 · 12 comments

Comments

@BigFaceMaster
Copy link

Chinese?

@yangyingwx
Copy link

wow! I expect Chinese document so much!

@asturur
Copy link
Member

asturur commented Nov 15, 2019

We do not have translatable docs.
Do you know some system that allow for that?
I tried to rework the website under https://docusaurus.io/ but it requires time that i do not have.

@BigFaceMaster
Copy link
Author

I just used: https://www.docz.site/,
If you want to recreate the website, if you need help, I can do my best to help you, and I also hope to provide a multi-language environment. When I use the fabricjs document, I find that the Chinese document is missing, and it is not friendly enough and brief.

@asturur
Copy link
Member

asturur commented Nov 16, 2019

I definitely want to redo fabricJS website.
Can look in any way as long as looks modern like any other js library.

Requirements are:

  • can be published with githubpages
  • there is a patter to import / rewrite easily the current documentation
  • there is space fore the current small advertisement
  • can take docs from fabricjs JSDOCS.

Plus:

  • it supports embedded snippets
  • it supports multi language docs with some kind of translations system, eventually community based.
  • better based on MD files than HTML

@BigFaceMaster
Copy link
Author

Awesome, it's sounds great. MD is very friendly to developers.

@BigFaceMaster
Copy link
Author

so, what's your plan? Could you give me some your ideas? I wanna join this job.

@BigFaceMaster
Copy link
Author

  1. New website
  2. Multi-language, English, Chinese(I'm Chinese, So I can translate and refactoring is, making it better for us)

@asturur
Copy link
Member

asturur commented Nov 17, 2019

The idea is getting a prototype up in a branch or in another repo. Just to see how the tech stack looks like. It has to be managed with github or i simply cannot do it. The default theme that any document platform offer could be ok.

@BigFaceMaster
Copy link
Author

It's a good idea. Have you started doing something? or starting it from 0? I wanna know more information about this, you can send mail to me([email protected]) or other, and we make a plan and start doing it.

@BigFaceMaster
Copy link
Author

By the way, I am good at react.

@asturur
Copy link
Member

asturur commented Nov 17, 2019

You can make a PR to this repository here:

https://github.com/fabricjs/fabricjs.github.io

You first clone it, you make a branch, you make an initial setup with a proof of concept of a single page ( take any existing documentation page ).

In this POC there should be an header, a footer, and the central page.

Take care that github i think prefers static generated sites, so as our website currently work, it starts from MD files, but then it creates plain html and just serves that.

Alternatively you can find a translation system that work with our current website, a plugin for jekyll.
Something that allow us to have a place to submit a page for translation and something that allow the user to move from a language to another.

Experiments can be visualized here once merged:
https://fabricjs.github.io/

Any improvement to docs and website is highly appreciated.

@BigFaceMaster
Copy link
Author

Ok, got it. let's me think twice

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

3 participants