Skip to content
Snippets Groups Projects
Commit 9563b184 authored by Dashamir Hoxha's avatar Dashamir Hoxha
Browse files

Small corrections

parent c67c5e08
No related branches found
No related tags found
No related merge requests found
...@@ -5,12 +5,14 @@ This is a minimal example of a book based on R Markdown and ...@@ -5,12 +5,14 @@ This is a minimal example of a book based on R Markdown and
## How to start your own book ## How to start your own book
1. Fork this project on GitLab. It will be immediately published on 1. Fork this project on GitLab. It will be automatically published on
the address `https://<username>.gitlab.io/bookdown-example/`. For the address `https://<username>.gitlab.io/bookdown-example/` (but
more details on how this works check the next section. you may have to wait for a few minutes). For more details on how
this works check the next section.
2. Go to the "Settings" of the projects and change the "Project 2. Go to the "Settings" of the project and change the "Project
name". Expand the "Advanced" section and change the path as well. name". Expand the "Advanced" section and change the project path as
well.
3. Edit `index.Rmd` and change any fields, like: `title:`, `author:`, 3. Edit `index.Rmd` and change any fields, like: `title:`, `author:`,
`date:`, `url:` and `description:`. `date:`, `url:` and `description:`.
...@@ -66,9 +68,9 @@ to do it. Basically, in plain English, it says something like this: ...@@ -66,9 +68,9 @@ to do it. Basically, in plain English, it says something like this:
container, container,
- then run the script `./render.sh` in it (which is expected to - then run the script `./render.sh` in it (which is expected to
generate the directory `public/` with the content of the website generate the directory `public/` with the content of the website
that is expected to be published), that should be published),
- then get the content of the directory `public/` and publish it on - then get the content of the directory `public/` and publish it on
the website of the project the website of the project:
`https://<username>.gitlab.io/<book-title>/` `https://<username>.gitlab.io/<book-title>/`
You can check the page "CI/CD -> Pipelines" to see more details about You can check the page "CI/CD -> Pipelines" to see more details about
...@@ -130,13 +132,13 @@ Let's summarize them quickly: ...@@ -130,13 +132,13 @@ Let's summarize them quickly:
``` ```
127.0.0.1 mybook.example.org 127.0.0.1 mybook.example.org
``` ```
Then open in browser: https://mybook.example.org Then open in browser: `https://mybook.example.org`.
You can edit `books/bookdown-example/` with any editor that you You can edit `books/bookdown-example/` with any editor that you
like. Then, to update the page with the latest changes you run again like. Then, to update the page with the latest changes you run again
`ds render books/bookdown-example/`. This will regenerate the content `ds render books/bookdown-example/`. This will regenerate the content
of the directory `books/bookdown-example/public/`, which is being of the directory `books/bookdown-example/public/`, which is being
served on https://mybook.example.org served on `https://mybook.example.org`.
Alternatively, you can update/regenerate it like this: Alternatively, you can update/regenerate it like this:
```bash ```bash
...@@ -196,8 +198,8 @@ It is also possible to build an auto-update system with Travis CI, ...@@ -196,8 +198,8 @@ It is also possible to build an auto-update system with Travis CI,
which would update the website of the book whenever some changes to which would update the website of the book whenever some changes to
the markdown files are committed and pushed to GitHub. This automated the markdown files are committed and pushed to GitHub. This automated
way is described in this [help way is described in this [help
page](https://bookdown.org/yihui/bookdown/github.html). However it a page](https://bookdown.org/yihui/bookdown/github.html). However it is
bit complex and maybe not worth the trouble. a bit complex and maybe not worth the trouble.
## The syntax of the markdown files ## The syntax of the markdown files
...@@ -206,7 +208,7 @@ Markdown syntax, which is described on this page as well: ...@@ -206,7 +208,7 @@ Markdown syntax, which is described on this page as well:
https://bookdown.org/yihui/bookdown/markdown-syntax.html https://bookdown.org/yihui/bookdown/markdown-syntax.html
However bookdown supports some further extensions, which are mainly However bookdown supports some further extensions, which are mainly
useful for math. These extension are described on this page: useful for math. These extensions are described on this page:
https://bookdown.org/yihui/bookdown/markdown-extensions-by-bookdown.html https://bookdown.org/yihui/bookdown/markdown-extensions-by-bookdown.html
Besides these, the syntax of GitLab markdown is a bit different from Besides these, the syntax of GitLab markdown is a bit different from
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment