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

Add MkDocs Wiki #1979

Closed
wants to merge 1 commit into from
Closed

Add MkDocs Wiki #1979

wants to merge 1 commit into from

Conversation

Hamster45105
Copy link
Contributor

@Hamster45105 Hamster45105 commented Nov 16, 2024

I have created a wiki site for Obtainium with Material for MkDocs. At the moment, it is functional and deploys automatically to GitHub pages. I haven't edited much of the actual content, I just copied the wiki on GitHub.

With this code it will be deployed at https://imranr98.github.io/Obtainium, however you could use a custom domain if you wanted to.

There is a demo here: https://hamster45105.github.io/Obtainium/

Setting the site up to be deployed

The site needs to be enabled via GitHub pages. To do this:

  1. Wait until the initial run of deploy-docs.yml is complete
  2. Go to the repos settings
  3. Go to the pages section
  4. Set source to Deploy from a branch
  5. Set branch to gh-pages
  6. Leave folder as /root
  7. Click save
  8. This will deploy the site

The wiki should probably then be deleted.

#1959

@Hamster45105 Hamster45105 marked this pull request as ready for review November 16, 2024 02:31
@ImranR98
Copy link
Owner

ImranR98 commented Nov 17, 2024

This looks pretty good, thanks! But I think it makes sense to put in a separate repo.
I've created an empty one, could you open a PR there instead?

@Hamster45105
Copy link
Contributor Author

Done: ImranR98/Obtainium-Wiki#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.

2 participants