GitBook

The Git Book page: https://showmeyourcodeyoutube.gitlab.io/gitbook-demo/

Version: 0.0.1 Build: 8/10/2024, 5:42:05 AM

General remarks:

• Proposed convention: If there is only one file inside a directory, use content.md, otherwise use intro.md.
• Before adding a picture, compress it - https://tinypng.com/.
• Before adding a PDF, compress it - https://tinywow.com/pdf/compress.
• Add files with lowercase extension e.g. png instead of PNG.
• Allowed image extensions: png, jpg.
• Keep the repository size as small as possible to speed up searching.

GitLab CI

This project's static Pages are built by GitLab CI, following the steps defined in .gitlab-ci.yml.

Building locally

To work locally with this project, you'll have to follow the steps below:

1. Fork, clone or download this project
2. Install GitBook npm install gitbook-cli@2.3.2 -g
3. Fetch GitBook's latest stable version gitbook fetch latest
4. Preview your project: gitbook serve
5. Add content
6. Generate the website: gitbook build (optional)
7. Push your changes to the master branch: git push
8. Do not change any *-REPLACE variables as they are automatically replaced when running the build on Gitlab.