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

Official Web Site #380

Closed
wants to merge 1 commit into from
Closed

Official Web Site #380

wants to merge 1 commit into from

Conversation

yangg
Copy link

@yangg yangg commented Jan 31, 2024

#356

vitepress is a good choice, as it can

  1. save most of the design and styles
  2. suitable for writing help documents.
  3. deploy to netlify, without need a server & domain. And acceptable speed in Mainland.
  4. easy for Internationalization

I created one: https://easydict.netlify.app/

Update:

All the document can be written in markdown format. like you write the readme.md
If you think it's ok, I will fill in some existing documents in the next few days, set up the basic structure, and then others can directly edit the markup

I've added

  • Internationalization folder structure
  • Installation doc
  • Migrate the "how tos" docs in old docs dir

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello yangg, Thank you for your first PR contribution 🎉 yangg

@tisfeng
Copy link
Owner

tisfeng commented Feb 1, 2024

@yangg Looks great, is the current https://easydict.netlify.app generated from this PR's documentation?

Can I now deploy this docs directly to other platforms?

@yangg
Copy link
Author

yangg commented Feb 1, 2024

@yangg Looks great, is the current https://easydict.netlify.app generated from this PR's documentation?

Can I now deploy this docs directly to other platforms?

@tisfeng Yes, it just works in vercel without any extra config. here is a demo https://easydict-demo.vercel.app/

@CanglongCl
Copy link
Collaborator

Looks great. But should we use another repo instead of put it here?

@phlpsong
Copy link
Collaborator

phlpsong commented Feb 2, 2024

Looks great. But should we use another repo instead of put it here?

Agree, using a separate repo is better.

@tisfeng
Copy link
Owner

tisfeng commented Feb 2, 2024

@yangg That's great, thank you very much!

We can try to complete the missing docs in https://easydict.netlify.app

@AkaShark
Copy link
Collaborator

AkaShark commented Feb 2, 2024

Looks great. But should we use another repo instead of put it here?

+1

@AkaShark
Copy link
Collaborator

AkaShark commented Feb 2, 2024

Other than that we will merge in main ?
CleanShot 2024-02-02 at 11 28 59@2x

@yangg
Copy link
Author

yangg commented Feb 2, 2024

Looks great. But should we use another repo instead of put it here?

@AkaShark @CanglongCl

https://github.com/yangg/easydictdoc is ready for days before this pull request.

@tisfeng
Copy link
Owner

tisfeng commented Feb 2, 2024

Ok, I will create a new repo for docs later, let's keep this repo clean.

@tisfeng
Copy link
Owner

tisfeng commented Feb 3, 2024

Thanks @yangg

I created a new repo easydict-docs, which is imported from easydictdoc, we can continue to improve the docs on this repo.

@tisfeng tisfeng closed this Feb 3, 2024
@tisfeng
Copy link
Owner

tisfeng commented Feb 4, 2024

Hi @yangg

I just deployed easydict-docs on Vercel https://easydict-docs.vercel.app/ , but it seems to have some problems. Can you help me take a look?

image

@yangg
Copy link
Author

yangg commented Feb 4, 2024

@tisfeng

You may need to remove "docs" from vercel settings,
or move all the files except package.json into docs directory
image

@tisfeng
Copy link
Owner

tisfeng commented Feb 4, 2024

ok, it worked, thanks.

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.

5 participants