diff --git a/src/styles/README.md b/src/styles/README.md index 3aed9fe..4135ffd 100644 --- a/src/styles/README.md +++ b/src/styles/README.md @@ -1 +1,9 @@ -Application styles +# Application styles + +## Naming Conventions: BEM + +TODO: Outline what BEM is and how to use/extend classes using it. + +## Recommendations on Folding In Third Party CSS + +TODO: Outline how/when/why to fold in third party css using npm or yarn. \ No newline at end of file diff --git a/src/styles/patterns/base/README.md b/src/styles/patterns/base/README.md new file mode 100644 index 0000000..f1ceef6 --- /dev/null +++ b/src/styles/patterns/base/README.md @@ -0,0 +1,3 @@ +# Base + +TODO: Outline what qualifies as a 'base' pattern. \ No newline at end of file diff --git a/src/styles/patterns/containers/README.md b/src/styles/patterns/containers/README.md new file mode 100644 index 0000000..b4017f4 --- /dev/null +++ b/src/styles/patterns/containers/README.md @@ -0,0 +1,3 @@ +# Containers + +TODO: Outline what qualifies as a 'container' pattern. \ No newline at end of file diff --git a/src/styles/patterns/layouts/README.md b/src/styles/patterns/layouts/README.md new file mode 100644 index 0000000..165ae0c --- /dev/null +++ b/src/styles/patterns/layouts/README.md @@ -0,0 +1,3 @@ +# Layouts + +TODO: Outline what qualifies as a 'layout' pattern. \ No newline at end of file diff --git a/src/styles/patterns/pages/README.md b/src/styles/patterns/pages/README.md new file mode 100644 index 0000000..b8a1095 --- /dev/null +++ b/src/styles/patterns/pages/README.md @@ -0,0 +1,7 @@ +# Pages + +A pages folder will not always be needed, and restraint should be used +in leveraging it. The most likely case of it being needed will be in the +event the homepage of a site is drastically different from other pages. + +TODO: Outline what qualifies as a 'page' pattern. \ No newline at end of file diff --git a/src/styles/vendor/README.md b/src/styles/vendor/README.md new file mode 100644 index 0000000..43d2081 --- /dev/null +++ b/src/styles/vendor/README.md @@ -0,0 +1,9 @@ +# Vendor Styles + +Optional folder. + +In cases where third party CSS needs to be included in the source files +of a project, this is where that third party code should go. + +However, it's strongly recommended to leverage npm or yarn to include +third party code that way instead. \ No newline at end of file