Skip to main content

Files And Folders

File Naming​

  • filenames never include whitespace IE (my_file.png, not my file.png)
  • file names should be descriptive (name_of_thing_in_image.png, not image.png)
  • file names should be lowercase
  • file names should be in snake_case (my_file.png, not myFile.png, my-file.png)

Directory/folder Naming​

  • directory names should be lowercase
  • directory names should be kebab-case (my-directory, not myDirectory, my_directory)

Organization​

  • For each subdirectory, if a page requires assets, there must be an assets folder, and the assets folder must be in the same directory as the page.

Page structure​

  • Each page should include the following:
    • a title
    • a sidebar_position

General Markdown​

Titles​

  • Good titles are descriptive, yet brief (Unit 1: Intro to Cybersecurity, not Unit 1)
  • Good title are in title case (Unit 1: Intro to Cybersecurity, not unit 1: intro to cybersecurity)

Headings​

  • Good headings are descriptive, yet brief (Intro to Cybersecurity, not Unit 1)
  • TODO: DECIDE CENTER OR NAH

Table of contents​

  • TODO: Investigate removing or ommiting certain items

Lists​

  • Just use markdown lists

Tables​