Quickstart Guide

Setup repository

  1. On GitHub.com, navigate to the main page of the repository.
  2. Above the file list, click Use this template.
  3. Type a name for your repository, and an optional description, choose owner, repository visibility, etc.
  4. Edit book.toml: change authors, git-repository-url and title fields.
  5. Commit&Push your changes.
  6. Setup GitHub pages for your repository (quickstart guide can be found below).
  7. Enjoy! :)

How to add new page to your book

  1. Add new .md file to src folder, e.g 01_example.md
  2. Add new item to the list in SUMMARY.md, e.g - [Example Page](./01_example.md)
  3. Commit&Push your changes and enjoy the result :)

Useful links: