Use mdbook for docs

This commit is contained in:
Johannes Frohnmeyer 2022-09-06 16:03:17 +02:00
parent 1f9f56d413
commit 8445bce486
Signed by: Johannes
GPG Key ID: E76429612C2929F4
8 changed files with 36 additions and 68 deletions

3
.gitignore vendored
View File

@ -5,4 +5,5 @@ run*/
imgui.ini
hs_err_pid*
inceptum.log
bin
bin
public

View File

@ -1,10 +1,6 @@
variables:
GRADLE_OPTS: "-Dorg.gradle.daemon=false"
stages:
- build
- deploy
default:
image: gradle:jdk18
before_script:
@ -100,14 +96,5 @@ portable:
only:
- master
pages:
image: python:3.8-buster
stage: deploy
script:
- pip install mkdocs
- mkdocs build
artifacts:
paths:
- public
only:
- master
include:
- remote: 'https://jfmods.gitlab.io/scripts/docs.yml'

16
book.toml Normal file
View File

@ -0,0 +1,16 @@
[book]
authors = ["JFronny"]
language = "en"
multilingual = false
src = "docs"
title = "LibJF"
description = "Inceptum Docs"
[build]
build-dir = "public"
[output.html]
git-repository-url = "https://gitlab.com/jfmods/Inceptum"
git-repository-icon = "fa-gitlab"
edit-url-template = "https://gitlab.com/jfmods/Inceptum/edit/master/{path}"
site-url = "https://jfmods.gitlab.io/inceptum"

View File

@ -6,12 +6,7 @@ To view up-to-date information on the commands provided by Inceptum, run `incept
Inceptum Wrapper looks through the libraries dir and launches the latest available Inceptum version.
If it doesn't find a usable version, it will download the latest from GitLab.
Launching is performed through a custom ClassLoader and the wrapper command is prepended to the arguments provided by the user.
## The "wrapper" command
Inceptum internally uses this command to inform the main Inceptum jar that it was launched through the Inceptum Wrapper and should allow installing updates.
It sets an internal flag and launches the command provided in its arguments.
Manually invoking this command WILL cause problems, so a check has been implemented that should prevent this from starting Inceptum in unintended environments.
Launching is performed through a custom ClassLoader and an internal flag is set to inform the launched version about the wrappers' presence.
## The "batch" command
@ -21,14 +16,16 @@ The batch command has the additional advantage of allowing caches to stay loaded
For example,
```
git pull icesrv
mod update all icesrv
run server restart icesrv
run server restart server2
```
is equivalent to the bash script
```shell
#!/bin/sh
inceptum git pull icesrv
inceptum mod update all icesrv
inceptum run server restart icesrv
inceptum run server restart server2
```

View File

@ -21,32 +21,8 @@ All of these are subject to change, though automatic migrations will likely be p
// The update channel. Either "CI" or "Stable".
// I personally recommend the CI channel as it gets the latest fixes and features quicker
"channel": "CI",
// Configuration for the git integration.
// This is also used during instance creation, but you can pretty much ignore it if you use an external client or don't create modpacks
"git": {
// Authentication for git
// Used when pushing or pulling from remote repos
"instanceAuths": {
// The name of an instance. This is equal to its directory name
"someInstance": {
// The username to use for authentication
"username": "yourusername@gmail.com",
// The password to use for authentication
"password": "SomePassword"
},
"someOtherInstance": {
"username": "yourusername@gmail.com",
"password": "SomePassword"
}
},
// The username to use when creating commits
"commitUsername": "Inceptum",
// The E-Mail address to use when creating commits. This default address doesn't exist btw
"commitMail": "inceptum@jfronny.gitlab.io",
// Whether to sign commits.
// If you want this for additional security, don't use the git integration
"signCommits": false
}
// The author name to add to packs where the metadata format requires specifying one
"authorName": "Inceptum"
}
```

8
docs/SUMMARY.md Normal file
View File

@ -0,0 +1,8 @@
# Summary
- [About](./README.md)
- [Installing](./Installing.md)
- [CLI](./Commands.md)
- [Syncing instances](./Syncing.md)
- [File Formats](./FileFormats.md)
- [Modules](./Modules.md)

View File

@ -54,5 +54,5 @@ repository or using any graphical tool is enough to set this up.
Users can add an instance created this way in the GUI under File->New Instance->Inceptum.
To update the pack, simply create a new commit and push it to your repository.
Users can then update the pack under Edit->Git->Pull or using the Inceptum CLI.
Users can then update the pack by pulling the changes into their instance directory through the normal git CLI.
You may also export the pack to other formats to upload it on sites like CurseForge

View File

@ -1,17 +0,0 @@
site_name: Inceptum Docs
site_url: https://jfmods.gitlab.io/inceptum
theme:
name: readthedocs
hljs_languages:
- json5
site_dir: public
repo_url: https://gitlab.com/jfmods/Inceptum
site_description: Documentation for the Inceptum Launcher
site_author: JFronny
nav:
- 'README.md'
- 'Installing.md'
- 'Commands.md'
- 'Syncing.md'
- 'FileFormats.md'
- 'Modules.md'