Skip to content

pladias-cz/documentation

Repository files navigation

Pladias.cz documentation

Documentation of the project Pladias for the Pladias community

Build documentation

  1. create a file /scripts/local.R with content like this:
    dbUser <- 'pladias'
    dbPassword <- 'pladias'
  2. if you need a new chapter, do not forget to register it also in the ./bookdown.yml file
  3. run Rscript build.R
  4. check that you add also new files in the /docs directory to the commit
  5. commit&push
  6. in some minutes the content of https://pladias-cz.github.io/documentation/ is updated

One could need to store an information with limited audience, mostly focused only on developers and maintainers of the documentation. In such case, there are several options: 1) don't include the chapter file in bookdown file (it won't be rendered as a part of the GitHubPages) and 2) use a TeX macro \developers{}[Some text to be rendered] and decide its visibility in ./preamble.tex or 3) use a code chunk with commented content

About

documentation of/for project Pladias

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •