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

dev: Official Web Site #356

Open
17 tasks
CanglongCl opened this issue Jan 23, 2024 · 9 comments
Open
17 tasks

dev: Official Web Site #356

CanglongCl opened this issue Jan 23, 2024 · 9 comments

Comments

@CanglongCl
Copy link
Collaborator

As a part of project marketing #353 , we need a official website for users to check everything of our app and guide them to the download site.

TODO list:

Development

  • A person who is familiar to web development
  • Web Framework
  • Domain

Website design

  • Style design
  • Home page
  • Documents
    • Get Start
    • Project Introduction
    • Features
      • ...
    • Service and its configuration
  • Development Documents
    • Localization help wanted
    • ...
  • Download
  • Community (Discord? for CN mainland users? )
  • Support
@yangg
Copy link

yangg commented Jan 30, 2024

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

@tisfeng
Copy link
Owner

tisfeng commented Jan 30, 2024

Looks great, but I'm not familiar web, can anyone follow up?

@tisfeng
Copy link
Owner

tisfeng commented Jan 31, 2024

vitepress is a good choice to write documentation websites.

Could you refer to here and open a PR to upload the relevant files in our project directory? This makes it easier for us to manage and improve the documentation together.

@tisfeng
Copy link
Owner

tisfeng commented Jan 31, 2024

I don't like this third party service that has a lot of weird account censorship, or bugs, maybe later we can try to deploy to Vercel, or our own servers.

image image

@yangg yangg mentioned this issue Jan 31, 2024
3 tasks
@yangg
Copy link

yangg commented Feb 1, 2024

@tisfeng If using Vercel, you also need to customize the domain name. Is there a domain name available for this project now? Netlify is the fastest of these services in China, and the official Vue website uses them. Deno.dev is also an option, and it's faster than Vercel.

@CanglongCl
Copy link
Collaborator Author

@tisfeng If using Vercel, you also need to customize the domain name. Is there a domain name available for this project now? Netlify is the fastest of these services in China, and the official Vue website uses them. Deno.dev is also an option, and it's faster than Vercel.

I think we should buy one. Do we have fund for this?

@tisfeng
Copy link
Owner

tisfeng commented Feb 1, 2024

I have a personal domain izual.me and I can add a subdomain if needed.

The domain name part is not very urgent, we can build the website first and improve the documentation to make sure it is accessible both in China and abroad.

I've only used Vercel and I'm not sure what the specific differences are between these hosting services, if Netlify is the best, it's ok for us to use it.

@Elreywad
Copy link

Do you want it with html css and js ?

@tisfeng
Copy link
Owner

tisfeng commented Sep 25, 2024

We have already built a simple official website using vitepress: https://github.com/tisfeng/easydict-docs, but we haven't had time to improve it yet.

If you are interested in it, you can refer to the current README on GitHub to help improve it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants