-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Implement GitHub page for docs #1312
Conversation
@gpibarra Thanks for this, give me some time to familiarize with this tool and update the |
@resslinger What do you think about this? |
@gpibarra I worked some time on this, and now is ready to go, some questions first: What will be the address of the site holding the online docs? I guess it will be published on the github pages of |
the url will be The user
|
@gpibarra OK, I do not have admin access on this repo. @jeroennoten could you please perform the previous mentioned task on the repo, or allow me for admin access in this repo? |
@gpibarra The owner of this package didn't answer to my request (I mailed him without getting an answer too). What do you think if we move the documentation to another new repository (I can create one for this under my user namespace if you agree)? |
I think that's ok. It would be a shame if the repository were abandoned. In any case, if the owner is not going to be able to continue providing support, he should give you administration permissions on the repository. |
@gpibarra I finally managed to contact with the owner, unfortunately there's no way to give me admin access on this repository, there's no such thing on Github for personal repositories, but the owner changed the configuration as required, so let's try this out... |
It works!!! Thanks for the management! |
Enable Github Pages Build for Documentation
In your repository's settings under "Pages" menu item, select "GitHub Actions" in "Build and deployment > Source".
Push your changes to the main branch and wait for the GitHub Actions workflow to complete. You should see your site deployed to https://.github.io/[repository]/ or https:/// depending on your settings. Your site will automatically be deployed on every push to the main branch.
More details
VitePress - Github Pages
View result doc