/ehw-starter-site-notes

2024

Primary LanguageCSS

Project Name: EHW Starter: Site Notes
File Name README.md
Date Created 11/06/24
Date Modified 11/08/24
Version 0.0.1
Programmer / Student Eric Hepperle

GITHUB REPO

TECHNOLOGIES

HTML5

CSS3

WordPress



TAGS

Starter Repo, Notes, Changelog, Markdown

Purpose

Starter repo for ehw/site-notes. Documentation about site changes, but styled with CSS, and more than just a basic changelog. Used with DEV sites.

!!! #GOTCHA: Consider keeping only a summary of changes, not the whole repo when deploying to PROD

Requires

  • Browser with dev tools enabled OR
  • IDE (VSCode preferred) with nodejs installed

Skills Covered

Usage

  1. Copy the ehw/ folder into the root of the dev WordPress site
  2. Edit the site-notes.md folder as needed
  3. Export the MD file to PDF (which will preserve the images) and html (which won't) for archiving

!!! #GOTCHA: Don't upload sensitive info to PROD !!!!!!!!

Future

  • Create changelog.md file as a sanitized synopsis of site-notes.md

NOTES

Notes are located in /ehw/site-notes.md

RESOURCES & REFERENCE