-
Notifications
You must be signed in to change notification settings - Fork 273
Write docs using vitepress #898
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
Conversation
Signed-off-by: ajiho <lujiahao@88.com>
Signed-off-by: ajiho <lujiahao@88.com>
Can you take some time to review it? Can't wait to show people new beautiful documents Three script commands have been added to the packagis.json file
Therefore, I need you to take some time to make some modifications to the wording of the sentence, so that I can contribute a Chinese document based on the latest document content |
Thanks for pushing this forwards. Will make maintianing the docs easier. Looks like we may need to update the GitHub Actions to run on a later version of Node? |
There is another way, we can directly create a Since we primarily present information about Twig through documentation, I believe it is necessary to simplify the description section of the README.md file as they are redundant. A clean README.md can also look more comfortable I think I will handle this part in the next few days |
…ite-docs-using-vitepress
@RobLoach We can merge now |
@ajiho can you include some screenshots of what it will look like when built? |
Co-authored-by: Will Rowe <willrowe@users.noreply.github.com>
Co-authored-by: Will Rowe <willrowe@users.noreply.github.com>
Signed-off-by: ajiho <lujiahao@88.com>
You can also directly access this page If you need to adjust the sidebar and top navigation, just modify the content of the en.mjs#L10 section, which corresponds to the directory structure of/docs/en/. Vitepress is very simple, you can check vitepress.dev or contact me directly |
@RobLoach if this looks good to you, then I think it should be fine to merge. |
See#730
preview
Because my native language is not English, I basically just copied the documents from the wiki, so Chinese translation is a pending task. If you feel that some adjustments need to be made, you can modify the content in the en folder,and then I will do Chinese translation based on the latest content
Reference to the content of file
deploy.yml
:https://vitepress.dev/guide/deploy#github-pagesSo, if you want to continue using GitHub pages for deployment, you just need to change
branches: [write-docs-using-vitepress]
tobranches: [master]
Don't forget
If you have any questions, feel free to continue asking me