search

ImranR98 / Obtainium

Get Android app updates straight from the source.
https://obtainium.imranr.dev
GNU General Public License v3.0
8.24k stars 179 forks source link

Add MkDocs Wiki #1979

Closed Hamster45105 closed 1 week ago

Hamster45105 commented 1 week ago

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

ImranR98 commented 1 week ago

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 commented 1 week ago

Done: https://github.com/ImranR98/Obtainium-Wiki/pull/1