So far, the function takes just the Rmd documents. Given that we have nowadays the qmd file format, I can update the function to include in the processing these files.

readme
vignette
functions roxygen

I don't want to change everytime that I have a new note the link in the index. Could work for the initial stage of the blog, and not so good idea if there are a lot of notes given that we already have the index on the side.

Inside the function, there is code to check if the files in the docs folder have a recent day compared to the files in the root. This could be useful in the functions that render the rmd or qmd documents, so every time I want to update files, I will render just the documents with changes and not the complete files in the root path.

The idea is to compare dates. I'm not completely sure if this is a good idea given that the rmd/qmd file could have a date time and the render files can have another datetime value that differs by just a little.

Until now, this process is being designed to work as a local, personal repository, but things change if I want to integrate this in a organization, probably the best fit is the github workflow. This have some impacts in the design

https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript

After we use the function to render the notes and deploy the notes, if it is the first time creating the repo, we will need to go back to the cofiguration of the repo and change the main branch to deploy from to the gh-pages branch.

If I can find a way to automatize this will be awesone (and less tedious)

https://ronnyhdez.github.io/blog/posts/2021-12-11-usingmkdocsrmd/ that is in the last section of https://ronnyhdez.github.io/docmaker/articles/mkdocs_workflow.html

It can be useful to have a way to check which one of my notes are outdated in the docs folder. This folder is the one that github will take to create the webpage, so if I don't update the notes in that folder with any of the functions available, the webpage will not reflect the changes.

I created a file in drawer that document the steps to use mkdocs. This can work as a vignette in this package

The function clean_files() is working fine but it just erases the md files in the docs/ folder that are no longer in the root file.

Nonetheless, if one of this files included images, those images in their respective folder were saved in the docs/ folder. For our look they follow the pattern with the names of the file they were created from.

I need to update the clean function to erase also those folders.

There is one automated workflow to update the page in the documentation.

Probably, at some point one would like to erase a post.

I can create a function to delete any post, deploy the site with the new changes.

This can have two options: erase the posts from the page completely or to erase the post from the web site but not from the notes

Sometimes I'm going to write documents directly as .md documents, so I should include in the function, that if there is a md file, there is no need to render this one, but I need to copy this one to docs folder so it can be rendered.

I just erase one md file from the root of the directory and update another md with the new function update_md_document.

Nonetheless, given that I just erased one file in the root of the directory, the old md file copy is still in the docs folder. I need a function to delete old md files that are in the docs folder but not anymore in the root of the directory.

Given that I have a document with images, I need to copy the images in the docs folder:

Output created: 03-nicoya.md
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /home/ronny/Documents/repos/github/test_docmaker/site
WARNING  -  Documentation file '03-nicoya.md' contains a link to 'images/nicoya_wikipedia.png' which is not found in the documentation files.
WARNING  -  Documentation file '03-nicoya.md' contains a link to 'images/nicoya_sunset.jpg' which is not found in the documentation files.
WARNING  -  Documentation file '03-nicoya.md' contains a link to 'images/nicoya_lanscape.jpg' which is not found in the documentation files.
INFO     -  Documentation built in 0.18 seconds
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /home/ronny/Documents/repos/github/test_docmaker/site
WARNING  -  Documentation file '03-nicoya.md' contains a link to 'images/nicoya_wikipedia.png' which is not found in the documentation files.
WARNING  -  Documentation file '03-nicoya.md' contains a link to 'images/nicoya_sunset.jpg' which is not found in the documentation files.
WARNING  -  Documentation file '03-nicoya.md' contains a link to 'images/nicoya_lanscape.jpg' which is not found in the documentation files.

drawer is going to stay just as a notes repository and all the needed functions to make the process faster to publish the notes, will be here.

If we use the function rigth now, it will publish the site with the name Drawer on it for the site name. I need to add this as a third parameter

If the repo does not have this page, it will show as the first page the 404 error.

Now that I have changed the R notes to one file using a qmd document, the md render file that is being deployed with mkdocs, does not have the TOC.

The markdown files does contain the TOC just using the titles and subtitles md syntax.

This can be checked on the drawer repo.

If we dont have the credentials set up, the function will just hang up waiting for the credentials. The Rstudio dialog box will not show up and this is the process that hang up the complete process

Pasos en windows para docmaker

En command prompt (“Windows Key+R”)
python --version

Instalar pip:

Bajar archivo https://bootstrap.pypa.io/get-pip.py

Luego en el command prompt
py get-pip.py

Para instalar mkdocs en windows

py -m pip install mkdocs

Instalar tema matherial

py -m pip install mkdocs-material

Docmaker

para correr en windows tenemos que hacer:

py -m mkdocs serve

En el paquete lo tengo como:

• mkdocs build --config-file=mkdocs.yml
• mkdocs gh-deploy --strict --force

system("py -m mkdocs build --config-file=mkdocs.yml")

This will need to:

• Create docs folder
• Create YAML file
• Modify .gitignore to include site/

If I adopt the workflow from creating notes inside a particular folder, there should be one way to clean test files.

I have the error:

> make_all_docs(deploy = TRUE)
Error in files %>% purrr::map(make_doc) : could not find function "%>%"

usethis::create_package()