diff --git a/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview.md b/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview.md new file mode 100644 index 00000000..43717abd --- /dev/null +++ b/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview.md @@ -0,0 +1,220 @@ +--- +sidebar_position: 1 +--- + +# Overview + +## Intro + +Below is a summary of the files and folders found in the `spec-up-t` npm package. + +:::info + +It is important to understand: + +- that you will find the files and directories below in the `spec-up-t` npm package installed in de `node_modules` directory of a working **Spec-Up-T installation** +- that this working **Spec-Up-T installation** was created **from the boilerplate directory** inside this `spec-up-t` npm package via NPX + +::: + + + +## Abstracted overview + +Abstracted overview of files and directories in the Spec-Up-T GitHub repository (and npm package). + +
+ +```sh + +./ +β”‚ +β”‚ πŸ‘‡ GITHUB ACTIONS WORKFLOW +β”‚ +β”œβ”€β”€ .github/ +β”‚Β Β  └── workflows/ +β”‚Β Β  └── render-specs.yml +β”‚ +β”‚ +β”‚ +β”‚ πŸ‘‡ CLIENT-SIDE (BROWSER) JAVASCRIPT AND CSS FILES +β”‚ +β”œβ”€β”€ assets/ +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ πŸ‘‡ COMPILED VIA GULP (FROM THE CSS AND JS FILES BELOW) +β”‚Β Β  β”‚ +β”‚Β Β  β”œβ”€β”€ compiled/ +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ body.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ head.css +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ head.js +β”‚Β Β  β”‚Β Β  └── refs.json +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ Β Β πŸ‘‡ SOURCE FILES (TO BE COMPILED VIA GULP) +β”‚Β Β  β”‚ +β”‚Β Β  β”œβ”€β”€ css/ +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ backToTop.css +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ … etc +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ … etc +β”‚Β Β  β”‚Β Β  └── … etc +β”‚Β Β  β”‚ +β”‚Β Β  β”œβ”€β”€ js/ +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ add-href-to-snapshot-link.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ … etc +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ … etc +β”‚Β Β  β”‚Β Β  └── … etc +β”‚Β Β  β”‚ +β”‚Β Β  └── icons.svg +β”‚ +β”‚ +β”‚ +β”‚ πŸ‘‡ FONTS +β”‚ +β”œβ”€β”€ fonts/ +β”‚Β Β  β”œβ”€β”€ KaTeX_AMS-Regular.ttf +β”‚Β Β  β”œβ”€β”€ … etc +β”‚Β Β  β”œβ”€β”€ … etc +β”‚Β Β  └── … etc +β”‚ +β”‚ +β”‚ +β”‚ πŸ‘‡ NODE JAVASCRIPT FILES +β”‚ +β”œβ”€β”€ src/ +β”‚Β Β  β”œβ”€β”€ collectExternalReferences/ +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ checkRateLimit.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ fetchTermsFromGitHubRepository.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ matchTerm.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ processXTrefsData.js +β”‚Β Β  β”‚Β Β  └── setupFetchHeaders.js +β”‚Β Β  β”‚ +β”‚Β Β  β”œβ”€β”€ config/ +β”‚Β Β  β”‚Β Β  └── paths.js +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ πŸ‘‡ CREATES NEW SPEC-UP-T β€œINSTALLATION” +β”‚Β Β  β”‚ +β”‚Β Β  β”œβ”€β”€ install-from-boilerplate/ +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚ πŸ‘‡ SPEC-UP-T BOILERPLATE: A FULL β€œINSTALLATION” +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ boilerplate/ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ .github/ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── workflows/ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ fetch-and-push-xrefs.yml +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── render-specs.yml +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ assets/ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ test.json +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── test.text +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ spec/ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ terms-definitions/ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ term-1.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ term-2.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ term-3.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── term-4.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ example-markup-in-markdown.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ spec-body.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ spec-head.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── terms-and-definitions-intro.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ static/ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ favicon.ico +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── logo.svg +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ .env.example +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ README.md +β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ gitignore +β”‚Β Β  β”‚Β Β  β”‚Β Β  └── specs.json +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”‚ πŸ‘‡ FILES THAT COPY AND INITIALIZE THE BOILERPLATE DIRECTORY +β”‚Β Β  β”‚Β Β  β”‚ +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ add-gitignore-entries.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ add-scripts-keys.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ config-gitignore-entries.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ config-scripts-keys.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ config-system-files.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ copy-boilerplate.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ copy-system-files.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ custom-update.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ help.txt +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ install.js +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ menu.sh +β”‚Β Β  β”‚Β Β  └── postinstall-message.js +β”‚Β Β  β”‚ +β”‚Β Β  β”‚ +β”‚ β”‚ +β”‚ β”‚ πŸ‘‡ GENERAL NODE FILES +β”‚ β”‚ +β”‚Β Β  β”œβ”€β”€ utils/ +β”‚Β Β  β”‚Β Β  β”œβ”€β”€ doesUrlExist.js +β”‚Β Β  β”‚Β Β  └── isLineWithDefinition.js +β”‚Β Β  β”‚ +β”‚Β Β  β”œβ”€β”€ add-remove-xref-source.js +β”‚Β Β  β”œβ”€β”€ asset-map.json +β”‚Β Β  β”œβ”€β”€ collect-external-references.js +β”‚Β Β  β”œβ”€β”€ configure.js +β”‚Β Β  β”œβ”€β”€ create-pdf.js +β”‚Β Β  β”œβ”€β”€ create-term-index.js +β”‚Β Β  β”œβ”€β”€ create-term-relations.js +β”‚Β Β  β”œβ”€β”€ create-versions-index.js +β”‚Β Β  β”œβ”€β”€ fix-markdown-files.js +β”‚Β Β  β”œβ”€β”€ freeze.js +β”‚Β Β  β”œβ”€β”€ init.js +β”‚Β Β  β”œβ”€β”€ insert-term-index.js +β”‚Β Β  β”œβ”€β”€ json-key-validator.js +β”‚Β Β  β”œβ”€β”€ markdown-it-extensions.js +β”‚Β Β  β”œβ”€β”€ prepare-tref.js +β”‚Β Β  └── references.js +β”‚ +β”‚ +β”‚ +β”‚ πŸ‘‡ ASSETS LIKE LOGO'S +β”‚ +β”œβ”€β”€ static/ +β”‚Β Β  └── specup_logo.png +β”‚ +β”‚ +β”‚ +β”‚ πŸ‘‡ THE TEMPLATE FOR INDEX.HTML WHERE EVERYTHING IS INJECTED INTO +β”‚ +β”œβ”€β”€ templates/ +β”‚Β Β  └── template.html +β”‚ +β”‚ +β”‚ +β”‚ πŸ‘‡ COMPILES CLIENT-SIDE FILES INTO ONE INDEX.HTML +β”‚ +β”œβ”€β”€ gulpfile.js +β”‚ +β”‚ +β”‚ +β”‚ πŸ‘‡ ENTRY POINT FOR NODE SCRIPTS +β”‚ +└── index.js + +``` + +## Tip + +Zoom in and out to get a better picture. + +:::tip + +- Zoom in: Ctrl / Command + Plus sign (+) +- Zoom out: Ctrl / Command + Minus sign (-) +- Reset: Ctrl / Command + 0 + +::: + +