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

Write docs using vitepress #898

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ajiho
Copy link

@ajiho ajiho commented Aug 8, 2024

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.ymlhttps://vitepress.dev/guide/deploy#github-pages

So, if you want to continue using GitHub pages for deployment, you just need to change branches: [write-docs-using-vitepress] to branches: [master]

Don't forget

image

If you have any questions, feel free to continue asking me

ajiho added 2 commits August 9, 2024 01:33
Signed-off-by: ajiho <lujiahao@88.com>
Signed-off-by: ajiho <lujiahao@88.com>
@ajiho
Copy link
Author

ajiho commented Aug 17, 2024

Can you take some time to review it? Can't wait to show people new beautiful documents
Here are some guidelines:

Three script commands have been added to the packagis.json file

# It will start a service, just update the md file in the docs directory to see the effect
npm run docs:dev
npm run docs:preview
# This command can package documents into browser executable HTML static files
npm run docs:build

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

@RobLoach
Copy link
Collaborator

RobLoach commented Aug 17, 2024

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?

@ajiho
Copy link
Author

ajiho commented Aug 18, 2024

There is another way, we can directly create a package.json file in the docs directory to manage document related dependencies separately This way, it won't damage any of the original code and testing related things

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

@iberdinsky-skilld
Copy link

iberdinsky-skilld commented Nov 1, 2024

@ajiho hello! i just pushed some fixes to your fork. Please review
ajiho#1

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.

3 participants