andreas/agdamsbo.github.io
1
0
Fork 0
mirror of https://github.com/agdamsbo/agdamsbo.github.io.git synced 2024-11-24 05:01:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README to be a tuto

Browse Source
This commit is contained in:
Florian 2016-08-14 00:39:13 +02:00
parent 54a48d2b94
commit d50cec7639
1 changed files with 42 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -1,7 +1,45 @@
# privefl.github.io
# Make your website with R Markdown in minutes
This is my githup repo for creating and hosting my personal website on GitHub.
This is a template (and tutorial) for creating your website with R Markdown in minutes.
I moved from [Jekyll](https://jekyllrb.com/) to [R Markdown](http://rmarkdown.rstudio.com/rmarkdown_websites.html), mostly because I'm an R enthusiast and an RStudio fanatic :').
The official document from RStudio can be found [here](http://rmarkdown.rstudio.com/rmarkdown_websites.html).
## Procedure
### Prerequisites
- Make sure that you have the latest versions of R, RStudio and package rmarkdown. I had problems of encoding because of that.
- Make sure that you have enabled Git in RStudio. More information can be found [here](https://support.rstudio.com/hc/en-us/articles/200532077-Version-Control-with-Git-and-SVN).
- You need a GitHub account.
### Make the first version of your website
- Fork this repo and rename it to be 'YOURGITHUB.github.io' (in Settings of your brand new repo).
- Get the link from cloning the repo. Then, go to RStudio, create a New Project > Version Control > Git and copy this link. You have cloned your new repo as an R project.
- Use `rmarkdown::render_site(encoding = "UTF-8")` in the console.
- Commit and push everything from RStudio.
- Go see your new website at https://YOURGITHUB.github.io/.
### Change the content of your website
- Modify `_site.yml`, `index.Rmd`, `about.Rmd`, `cv.Rmd` and `CV.pdf` with your own content.
- Use `rmarkdown::render_site(encoding = "UTF-8")` again. At any moment, you can preview your website locally, by rendering your site and viewing any of your local html file in your Web Browser.
- Commit and push everything from RStudio.
- Go see your new website with your own content at https://YOURGITHUB.github.io/.
### The blog part
For now, the 'Blog' link is giving a 404 page.
I will introduce how to create your own blog in a future tuto.
## An example
You can see for example [my own website](https://privefl.github.io/).
## Conclusion
As a reminder, all credit goes to the geniuses at RStudio. I just made some small modifications and made a tuto about how to use all this together.
If anything is false or not clear enough, feel free to contact me or open an issue.
I now use [Jekyll Now](https://github.com/privefl/blog/tree/gh-pages) for my blog.