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

docs: move gh wiki to mdBooks #211

Closed
wants to merge 20 commits into from
Closed

docs: move gh wiki to mdBooks #211

wants to merge 20 commits into from

Conversation

matt1432
Copy link
Contributor

@matt1432 matt1432 commented Dec 11, 2023

To make this I setup a GitHub action that compiles every markdown file in docs/src to a mdBooks instance hosted on this repo's GitHub Page.

All the markdown files should be almost identical to the ones in the current GitHub wiki since I cloned the ags.wiki repo. However, I did some changes to the landing page and had all the links to the wiki changed to relative paths. We might need to triple check if all of those work.

If you merge this you'll need to set this up: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token
That link wasn't too clear for me but basically, because the action makes a separate branch for the mdBooks, the Page needs to use that branch. So you just need to change the settings after it deploys once like so:
image

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.

1 participant