Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
B
Bookdown Example
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Dutz, Gregor
Bookdown Example
Commits
9563b184
Commit
9563b184
authored
5 years ago
by
Dashamir Hoxha
Browse files
Options
Downloads
Patches
Plain Diff
Small corrections
parent
c67c5e08
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+15
-13
15 additions, 13 deletions
README.md
with
15 additions
and
13 deletions
README.md
+
15
−
13
View file @
9563b184
...
...
@@ -5,12 +5,14 @@ This is a minimal example of a book based on R Markdown and
## How to start your own book
1.
Fork this project on GitLab. It will be immediately published on
the address
`https://<username>.gitlab.io/bookdown-example/`
. For
more details on how this works check the next section.
1.
Fork this project on GitLab. It will be automatically published on
the address
`https://<username>.gitlab.io/bookdown-example/`
(but
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
name". Expand the "Advanced" section and change the path as well.
2.
Go to the "Settings" of the project and change the "Project
name". Expand the "Advanced" section and change the project path as
well.
3.
Edit
`index.Rmd`
and change any fields, like:
`title:`
,
`author:`
,
`date:`
,
`url:`
and
`description:`
.
...
...
@@ -66,9 +68,9 @@ to do it. Basically, in plain English, it says something like this:
container,
-
then run the script
`./render.sh`
in it (which is expected to
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
the website of the project
the website of the project
:
`https://<username>.gitlab.io/<book-title>/`
You can check the page "CI/CD -> Pipelines" to see more details about
...
...
@@ -130,13 +132,13 @@ Let's summarize them quickly:
```
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
like. Then, to update the page with the latest changes you run again
`ds render books/bookdown-example/`
. This will regenerate the content
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:
```
bash
...
...
@@ -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
the markdown files are committed and pushed to GitHub. This automated
way is described in this
[
help
page
](
https://bookdown.org/yihui/bookdown/github.html
)
. However it
a
bit complex and maybe not worth the trouble.
page
](
https://bookdown.org/yihui/bookdown/github.html
)
. However it
is
a
bit complex and maybe not worth the trouble.
## The syntax of the markdown files
...
...
@@ -206,7 +208,7 @@ Markdown syntax, which is described on this page as well:
https://bookdown.org/yihui/bookdown/markdown-syntax.html
However bookdown supports some further extensions, which are mainly
useful for math. These extension are described on this page:
useful for math. These extension
s
are described on this page:
https://bookdown.org/yihui/bookdown/markdown-extensions-by-bookdown.html
Besides these, the syntax of GitLab markdown is a bit different from
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment