Directory Structure (WIP)
The NYP Framework contains the pages, scripts, and styles for the documentation as well as the core framework. This following is a tree of the most important directories related to the core only.
nyp-component-library-docs/
├── app/
│ ├── fonts/TheSans
│ ├── scripts/main/
│ ├── styles/nyp-core/
│ └── templates/
│ └── partials/docs/
│ ├── authorable-components/
│ ├── components/
│ ├── objects/
│ └── utilities/
└── dist/
├── fonts/TheSans/
├── scripts/main/
│ └── main.js
└── styles/
└── main.css
app/
The source files needed for the NYP Framework
fonts/TheSans
- The web version of TheSans font-face.
scripts/main
- The custom JavaScript for components. Each component will have a corresponding JS file as needed. The Bootstrap JavaScript lives in its package and gets bundled on build.
styles/nyp-core
- The core SCSS files for the NYP framework.
templates/pages/
- The documentation pages.
templates/partials/docs/
- The examples and code snippets that appear on each page.
dist/
The compiled files needed for the NYP Framework