Welcome to the InfoMagnus GitHub Training repository!
The content is all written in Markdown, and the scripts are shell scripts.
These manuals are designed to be generated using docsify. To get your own manuals up and running, all you have to do is:
- Fork this repository
- In your fork, click on Settings
- Scroll down to the GitHub Pages section, and set Source: to
main branch /docs folder. - Click Save.
- Return to the GitHub Pages section of Settings, and you'll receive the URL of your published manual.
In general, you'll find all of the manual content in the docs/ folder of this repository. All content is written in Markdown, and it's all stitched together in docs/_sidebar.md, which specifies the order and hierarchy of the content.
The repository includes a .devcontainer which makes editing the documentation in vscode easy.
When you first open the workspace, you should get the following pop-up:
Select Reopen in Container.
Alternatively,type Ctrl+Shift+P and select Dev Containers: Reopen in Container.
The workspace's .vscode/settings.json includes the following setting, which allows you to Ctrl+V images right into your .md files!
"markdown.copyFiles.destination": {
"**/*": "img/"
}You shouldn't need to, but if you need to mess around with the docsify configuration, the official docsify documentation is your best bet for getting up to speed.
The .devcontainer is setup with the VSCodeExt-docsify-Preview Visual Studio Code extension.
To open a preview window in vscode type Ctrl+Shift+P and select docsify: Open the full Preview.
You can install, and serve the contents of the docs/ folder locally with minimal setup. The steps are thoroughly described in the doscify quick start guide.
You can also simply run the following:
docsify serve docsPlease see the license for detailed information. When using the GitHub logos, be sure to follow the GitHub Logos and Usage guidelines.