https://github.com/stuebersystems/doc.blackboard.en
Our CONFIRE BLACKBOARD Documentation (EN)
https://github.com/stuebersystems/doc.blackboard.en
documentation gitbook
Last synced: over 1 year ago
JSON representation
Our CONFIRE BLACKBOARD Documentation (EN)
- Host: GitHub
- URL: https://github.com/stuebersystems/doc.blackboard.en
- Owner: stuebersystems
- License: other
- Created: 2019-07-04T09:56:45.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-24T14:04:50.000Z (over 5 years ago)
- Last Synced: 2025-01-21T07:43:36.606Z (over 1 year ago)
- Topics: documentation, gitbook
- Language: PowerShell
- Homepage:
- Size: 1.17 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CONFIRE BLACKBOARD Documentation
This is the English documentation for CONFIRE BLACKBOARD. The documentation is Open Source and we have implemented it using [GitBook](https://github.com/GitbookIO/gitbook).
:fire: *The open source version of GitBook used here is no longer under active development. The current version of GitBook is not open source.*
## Install GitBook for Windows
1. [Install node.js](https://nodejs.org/de/download). Node.js includes allready the package manager npm.
2. Launch the installer and follow the on-screen instructions.
3. Run the command prompt as Administrator.
4. Enter the command `npm install gitbook-cli -g` to install a local copy of GitBook.
## Clone Repository
This repository is a Git repository. To clone the repository to a local commputer you will need a Git client. Either install [Git for Windows](https://gitforwindows.org/) and use the command prompt or install one of the many GUIs. We recommend [GitHub Desktop](https://desktop.github.com) or [SourceTree](https://www.sourcetreeapp.com).
1. Create a local directory for the documentation e.g. `c:\docs\blackboard`.
2. Open the command prompt and change to directory `c:\docs\blackboard`.
3. Enter the command `git clone https://github.com/stuebersystems/doc.blackboard.en.git` to clone the repository.
## Download Repository as Zip Archive
If you don't want to use Git you can even download the repository as a Zip Archive:
1. Open the URL `https://github.com/stuebersystems/doc.blackboard.en` in your web browser
2. Click on the `Clone or download` button then select `Download ZIP`.
3. Extract the Zip Archive to a local folder, e.g. `c:\docs\blackboard`.
## Using GitBook
You have installed node.js and the GitBook package, cloned the repository or downloaded it as a Zip Archive. Now you can generate the documentation locally on your computer:
1. Start the command prompt and change to the directory `c:\docs\blackboard\src`.
2. First you have to install all needed GitBook plugins. Enter the command `gitbook install`. GitBook plugins will be installed. This needs to be done only once for this documentation.
3. Enter the command `gitbook build`. CONFIRE BLACKBOARD documentation will be regenerated.
4. To display the result, change the folder to `c:\docs\blackboard\src\_book` and open the file `index.html` in your webbrowser.
The table of contents can be found in the `SUMMARY.md` file.
## Further Informationen
+ [Git - All you need to know](https://git-scm.com/book/en/v2)
+ [GitBook on GitHub](https://github.com/GitbookIO/gitbook)