Merge pull request #22 from Imzxhir/main

LGTM

.github/workflows/deploy.yml

@@ -0,0 +1,22 @@
+name: Deploy the Docs
+on:
+ push:
+ branches:
+ - main
+permissions:
+ contents: write
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - uses: actions/cache@v3
+ with:
+ key: ${{ github.ref }}
+ path: .cache
+ - run: pip install mkdocs-material
+ - run: pip install mkdocs-glightbox
+ - run: mkdocs gh-deploy -f config/en/mkdocs.yml

.gitignore

@@ -1,25 +1,13 @@
-# Files generated by Jekyll
-_site/
-.sass-cache/
-.jekyll-cache/
-.jekyll-metadata
+# Project Files
+/.idea
+/.vscode
+/.vs
 
-# Files generated by Bundler
-.bundle/
-vendor/
-Gemfile.lock
-
-# Gems
-*.gem
-
-# Files generated by OS
+#OSX Stuff
 .DS_Store
 .DS_Store?
 ._*
 .Spotlight-V100
 .Trashes
 ehthumbs.db
-Thumbs.db
-
-# Files generated by VS Code
-.vscode
+Thumbs.db

config/en/mkdocs.yml

@@ -0,0 +1,61 @@
+site_name: SideStore Docs
+site_url: https://wiki.sidestore.io
+docs_dir: ../../docs/en
+
+theme:
+ logo: ../../img/icons/favicon-32x32.png
+ name: material
+ palette:
+ - scheme: default
+ primary: indigo
+ accent: deep purple
+ toggle:
+ icon: material/brightness-7
+ name: Switch to dark mode
+ - scheme: slate
+ primary: black
+ accent: deep purple
+ toggle:
+ icon: material/brightness-4
+ name: Switch to light mode
+
+extra:
+ generator: false
+ social:
+ - icon: fontawesome/brands/github
+ link: https://github.com/sidestore
+ - icon: fontawesome/brands/discord
+ link: https://discord.gg/sidestore-949183273383395328
+ - icon: fontawesome/brands/twitter
+ link: https://twitter.com/sidestore_io
+
+markdown_extensions:
+ - admonition
+ - attr_list
+ - def_list
+ - md_in_html
+ - pymdownx.caret
+ - pymdownx.details
+ - pymdownx.keys
+ - pymdownx.mark
+ - pymdownx.superfences
+ - pymdownx.tasklist:
+ custom_checkbox: true
+ - pymdownx.tilde
+ - def_list
+
+plugins:
+ - glightbox
+ - search:
+ separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+
+nav:
+ - Home: index.md
+ - FAQ: faq.md
+ - Guides:
+ - Getting Started: Guides/getting-started.md
+ - Create a Burner Apple ID: Guides/burner-apple-id.md
+ - Advanced:
+ - Custom Anisette Server: Advanced/anisette-server.md
+ - App Sources: Advanced/app-sources.md
+ - URL Schemes: Advanced/url-schemes.md

guides/custom-anisette.md → docs/en/Advanced/anisette-server.md

@@ -1,18 +1,12 @@
----
-layout: home
-title: Adv. Custom Anisette Server
-nav_order: 4
----
-
 # Custom Anisette Server
 
-{: .important-title }
-> Public anisette servers are now safe on SideStore 0.4.0
->
-> SideStore 0.4.0 introduced _anisette-v3_ servers, which are creating custom anisette data for each device, and thus are not subject to locking as the older servers were.
->
-> Thus, you can safely use SideStore without worrying about setting up a custom anisette server.
->
+!!! info
+
+ Public anisette servers are now safe on SideStore 0.4.0
+
+ SideStore 0.4.0 introduced _anisette-v3_ servers, which are creating custom anisette data for each device, and thus are not subject to locking as the older servers were.
+
+ Thus, you can safely use SideStore without worrying about setting up a custom anisette server.
 
 Anisette data is information used in the app signing process that needs to be generated each time you install or refresh apps. SideStore gets this information from a server that spoofs a Mac and sends you back the anisette data. No account info is sent to the server ever in this process.
 
@@ -30,6 +24,7 @@ Due to too many people using the same GitHub URL, you will have to fork the Git
 2. [Open](https://github.com/Dadoum/Provision) the Git repository.
 3. Click "Fork" in the top right, and fork the repository to your account.
 4. Once the forked repository is created, click the green "Code" dropdown in the top right, and copy the .git URL.
+
 * Save this for later.
 
 Once this is done, the Render server can be made.
@@ -38,21 +33,24 @@ Once this is done, the Render server can be made.
 2. Create a [New Web Service](https://dashboard.render.com/select-repo?type=web).
 3. Scroll down to **Public Git repository** and enter the URL you copied earlier.
 4. Click "Continue" and fill in the form:
-* **Name** - Does not matter
-* **Region** - Closest to you
-* **Branch** - main (default)
-* **Root Directory** - blank (default)
-* **Environment** - Docker (default)
-* **Instance Type** - Free
+ * **Name** - Does not matter
+ * **Region** - Closest to you
+ * **Branch** - main (default)
+ * **Root Directory** - blank (default)
+ * **Environment** - Docker (default)
+ * **Instance Type** - Free
 5. Wait for the server to build. You will see the following when it's done:
-```
+
+```text
 Machine requires provisioning... done !
 Your service is live 🎉
 ```
-* *If the build fails for any reason, click **Manual Deploy**, then **Deploy latest commit**.*
 
-6. Find the link for your new server at the top of the page:
-```
+*If the build fails for any reason, click **Manual Deploy**, then **Deploy latest commit**.*
+
+1. Find the link for your new server at the top of the page:
+
+```text
 https://[your-server-name].onrender.com
 ```
 
@@ -63,10 +61,9 @@ SideStore can be configured to use a custom Anisette server. We will use the one
 1. Open Settings.
 2. Scroll down and tap on SideStore.
 3. Within the Danger Zone:
- - **Use preferred servers** - Toggle off
- - **Anisette URL** - Enter your server URL
+  * **Use preferred servers** - Toggle off
+  * **Anisette URL** - Enter your server URL
 
 ## Done
 
 SideStore will now use your new custom anisette server, and your account should not get locked.
-