Skip to content

Internals: Public & The CMS

Edwin Shepherd edited this page Sep 1, 2019 · 1 revision

Public (.vuepress/public)

Any files in the public folder will be accessible under the route URL of the website. For instance, if a file named patch.zip was placed in this folder, it could be downloaded from https://hr-robocon.org/patch.zip.

This makes it a great place to upload:

  • Patches
  • PDFs (Datasheets, Rules, Instructions, etc)
  • Any other file that competitors need to access

The images folder is the destination of all content uploaded through the CMS. Images upload here are accessible in the same way (e.g. https://hr-robocon.org/images/imagename.jpg)

The _redirects file contains a list of Netlify redirects. Learn more about them here.

The CMS (.vuepress/public/admin)

The CMS is made up of two files.

index.html

This file loads the Netlify CMS files from a CDN and then registers the stylesheet for the website as a preview stylesheet so that the preview pane when writing posts/docs looks like the actual website.

config.yml

This file tells Netlify CMS how the post and doc files are structured so that they can be created and edited. This is done by defining widgets for each of the fields in the Markdown frontmatter (metadata for each file: title, date, category, etc...). You can read more about the different types of widgets here.