diff --git a/docs/adapter.html b/docs/adapter.html index 6fe6e3efb..3f765a68c 100644 --- a/docs/adapter.html +++ b/docs/adapter.html @@ -140,4 +140,4 @@ Object.assig arrayMax([1, 2, 3]); // 3
intermediate

unary

Creates a function that accepts up to one argument, ignoring any additional arguments.

Call the provided function, fn, with just the first argument given.

const unary = fn => val => fn(val);
 
['6', '8', '10'].map(unary(parseInt)); // [6, 8, 10]
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/archive.html b/docs/archive.html index 8c3c6c7b7..a12072190 100644 --- a/docs/archive.html +++ b/docs/archive.html @@ -256,4 +256,4 @@ window.speechSynthesis.speak(msg); }; 
speechSynthesis('Hello, World'); // // plays the message
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/browser.html b/docs/browser.html index c5039e174..1e14397dd 100644 --- a/docs/browser.html +++ b/docs/browser.html @@ -358,4 +358,4 @@ recorder.sta (c ^ (crypto.getRandomValues(new Uint8Array(1))[0] & (15 >> (c / 4)))).toString(16) ); 
UUIDGeneratorBrowser(); // '7982fcfe-5721-4632-bede-6000885be57d'
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/contributing.html b/docs/contributing.html index 0bacda03e..a3b47913b 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -66,7 +66,7 @@ license.
Logos made by Angelos Chalaris and ribbon made by Tim Holman are licensed under the MIT license.
Sponsored by DigitalOcean

+ width="20px" height="20px">DigitalOcean.


About    Contributing    Archive    Glossary

diff --git a/docs/date.html b/docs/date.html index dcf32f1f8..0c6fd899b 100644 --- a/docs/date.html +++ b/docs/date.html @@ -116,4 +116,4 @@ }; 
tomorrow(); // 2017-12-27 (if current date is 2017-12-26)
 tomorrow(true); // 2017-12-27T00:00:00 (if current date is 2017-12-26)
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/function.html b/docs/function.html index afc947c6c..4a479fc68 100644 --- a/docs/function.html +++ b/docs/function.html @@ -289,4 +289,4 @@ console.log< 
const doubleEvenNumbers = when(x => x % 2 === 0, x => x * 2);
 doubleEvenNumbers(2); // 4
 doubleEvenNumbers(1); // 1
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/glossary.html b/docs/glossary.html new file mode 100644 index 000000000..7ff357814 --- /dev/null +++ b/docs/glossary.html @@ -0,0 +1,76 @@ +Glossary - 30 seconds of code

logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.



Glossary

Developers use a lot of terminology daily. Every once in a while, you might find a term you do not know. We know how frustrating that can get, so we provide you with a handy glossary of frequently used web development terms.


AJAX

Asynchronous JavaScript and XML (known as AJAX) is a term that describes a new approach to using multiple technologies together in order to enable web applications to make quick updates to the user interface without reloading the entire browser page.

API

API stands for Application Programming Interface and is a set of features and rules provided by a provided by a software to enable third-party software to interact with it. The code features of a web API usually include methods, properties, events or URLs.

Argument

An argument is a value passed as an input to a function and can be either a primitive or an object. In JavaScript, functions can also be passed as arguments to other functions.

Array

Arrays are used to store multiple values in a single variable. Arrays are ordered and each item in an array has a numeric index associated with it. JavaScript arrays are zero-indexed, meaning the first element's index is 0.

Asynchronous programming

Asynchronous programming is a way to allow multiple events to trigger code without waiting for each other. The main benefits of asynchronous programming are improved application performance and responsiveness.

Automatic semicolon insertion

Automatic semicolon insertion (ASI) is a JavaScript feature that allows developers to omit semicolons in their code.

Boolean

Booleans are one of the primitive data types in JavaScript. They represent logical data values and can only be true or false.

Callback

A callback function, also known as a high-order function, is a function that is passed into another function as an argument, which is then executed inside the outer function. Callbacks can be synchronous or asynchronous.

Character encoding

A character encoding defines a mapping between bytes and text, specifying how the sequenece of bytes should be interpreted. Two commonly used character encodings are ASCII and UTF-8.

Class

In object-oriented programming, a class is a template definition of an object's properties and methods.

Closure

A closure is the combination of a function and the lexical environment within which that function was declared. The closure allows a function to access the contents of that environment.

CoffeeScript

CoffeeScript is a programming language inspired by Ruby, Python and Haskell that transpiles to JavaScript.

Constant

A constant is a value, associated with an identifier. The value of a constant can be accessed using the identifier and cannot be altered during execution.

Constructor

In class-based object-oriented programming, a constructor is a special type of function called to instantiate an object. Constructors often accept arguments that are commonly used to set member properties.

Continuous Deployment

Continuous Deployment follows the testing that happens during Continuous Integration and pushes changes to a staging or production system. Continuous Deployment ensures that a version of the codebase is accessible at all times.

Continuous Integration

Continuous Integration (CI) is the practice of testing each change done to a codebase automatically and as early as possible. Two popular CI systems that integrate with GitHub are Travis CI and Circle CI.

CORS

Cross-Origin Resource Sharing (known as CORS) is a mechanism that uses extra HTTP headers to tell a browser to let a web application running at one domain have permission to access resources from a server at a different domain.

Cross-site scripting (XSS)

XSS refers to client-side code injection where the attacker injects malicious scripts into a legitimate website or web application. This is often achieved when the application does not validate user input and freely injects dynamic HTML content.

CSS

CSS stands for Cascading Style Sheets and is a language used to style web pages. CSS documents are plaintext documents structured with rules, which consist of element selectors and property-value pairs that apply the styles to the specified selectors.

CSV

CSV stands for Comma-Separated Values and is a storage format for tabular data. CSV documents are plaintext documents where each line represents a table row, with table columns separated by commas or some other delimiter (e.g. semicolons). The first line of a CSV document sometimes consists of the table column headings for the data to follow.

Currying

Currying is a way of constructing functions that allows partial application of a function's arguments. Practically, this means that a function is broken down into a series of functions, each one accepting part of the arguments.

Deserialization

Deserialization is the process of converting a format that has been transferred over a network and/or used for storage to an object or data structure. A common type of deserialization in JavaScript is the conversion of JSON string into an object.

DNS

A DNS (Domain Name System) translates domain names to the IP addresses needed to find a particular computer service on a network.

DOM

The DOM (Document Object Model) is a cross-platform API that treats HTML and XML documents as a tree structure consisting of nodes. These nodes (such as elements and text nodes) are objects that can be programmatically manipulated and any visible changes made to them are reflected live in the document. In a browser, this API is available to JavaScript where DOM nodes can be manipulated to change their styles, contents, placement in the document, or interacted with through event listeners.

Domain name registrar

A domain name registrar is a company that manages the reservation of internet domain names. A domain name registrar must be approved by a general top-level domain (gTLD) registry or a country code top-level domain (ccTLD) registry.

Domain name

A domain name is a website's address on the Internet, used primarily in URLs to identify the server for each webpage. A domain name consists of a hierarchical sequence of names, separated by dots and ending with an extension.

Element

A JavaScript representation of a DOM element commonly returned by document.querySelector() and document.createElement(). They are used when creating content with JavaScript for display in the DOM that needs to be programatically generated.

ES6

ES6 stands for ECMAScript 6 (also known as ECMAScript 2015), a version of the ECMAScript specification that standardizes JavaScript. ES6 adds a wide variety of new features to the specification, such as classes, promises, generators and arrow functions.

Event-driven programming

Event-driven programming is a programming paradigm in which the flow of the program is determined by events (e.g. user actions, thread messages, sensor outputs). In event-driven applications, there is usually a main loop that listens for events and trigger callback functions accordingly when one of these events is detected.

Event loop

The event loop handles all asynchronous callbacks. Callbacks are queued in a loop, while other code runs, and will run one by one when the response for each one has been received. The event loop allows JavaScript to perform non-blocking I/O operations, despite the fact that JavaScript is single-threaded.

Express

Express is a backend framework, that provides a layer of fundamental web application features for Node.js. Some of its key features are routing, middleware, template engines and error handling.

Factory functions

In JavaScript, a factory function is any function, which is not a class or constructor, that returns a new object. Factory functions don't require the use of the new keyword.

First-class function

A programming language is said to have first-class functions if it treats them as first-class citizens, meaning they can be passed as arguments, be returned as values from other functions, be assigned to variables and stored in data structures.

Flexbox

Flexbox is a one-dimensional layout model used to style websites as a property that could advance space distribution between items and provide powerful alignment capabilities.

Function

Functions are self-contained blocks of code with their own scope, that can be called by other code and are usually associated with a unique identifier. Functions accept input in the form of arguments and can optionally return an output (if no return statement is present, the default value of undefined will be returned instead). JavaScript functions are also objects.

Functional programming

Functional programming is a paradigm in which programs are built in a declarative manner using pure functions that avoid shared state and mutable data. Functions that always return the same value for the same input and don't produce side effects are the pillar of functional programming.

Functor

A Functor is a data type common in functional programming that implements a map method. The map method takes a function and applies it to the data in the Functor, returning a new instance of the Functor with the result. JavaScript Arrays are an example of the Functor data type.

Garbage collection

Garbage collection is a form of automatic memory management. It attempts to reclaim memory occupied by objects that are no longer used by the program.

Git

Git is an open-source version control system, used for source code management. Git allows users to copy (clone) and edit code on their local machines, before merging it into the main code base (master repository).

Higher-order function

Higher-order functions are functions that either take other functions as arguments, return a function as a result, or both.

Hoisting

Hoisting is JavaScript's default behavior of adding declarations to memory during the compile phase. Hoisting allows for JavaScript variables to be used before the line they were declared on.

HTML

HTML stands for HyperText Markup Language and is a language used to structure web pages. HTML documents are plaintext documents structured with elements, which are surrounded by <> tags and optionally extended with attributes.

HTTP and HTTPS

The HyperText Transfer Protocol (HTTP) is the underlying network protocol that enables transfer of hypermedia documents on the Web, usually between a client and a server. The HyperText Transfer Protocol Secure (HTTPS) is an encrypted version of the HTTP protocol, that uses SSL to encrypt all data transfered between a client and a server.

Integer

Integers are one of the primitive data types in Javascript. They represent a numerical value that has no fractional component.

Integration testing

Integration testing is a type of software testing, used to test groups of units/components of a software. The purpose of integration tests are to validate that the units/components interact with each other as expected.

IP

An IP address is a number assigned to a device connected to a network that uses the Internet protocol. Two IP versions are currently in use - IPv4, the older version of the communication protocol (e.g. 192.168.1.100) and IPv6, the newest version of the communication protocol which allows for many different IP addresses (e.g. 0:0:0:0:ffff:c0a8:164).

jQuery

jQuery is a frontend JavaScript library, that simplifies DOM manipulation, AJAX calls and Event handling. jQuery uses its globally defined function, $(), to select and manipulate DOM elements.

JSON

JSON (JavaScript Object Notation) is a format for storing and exchanging data. It closely resembles the JavaScript object syntax, however some data types, such as dates and functions, cannot be natively represented and need to be serialized first.

ajax api argument array asynchronous-programming automatic-semicolon-insertion boolean callback character-encoding class closure coffeescript constant constructor continuous-deployment continuous-integration cors cross-site-scripting-xss css csv currying deserialization dns dom domain-name-registrar domain-name element es6 event-driven-programming event-loop express factory-functions first-class-function flexbox function functional-programming functor garbage-collection git higher-order-function hoisting html http-and-https integer integration-testing ip jquery json keyword_database mdn module mongodb mutabe-value mvc node-js nosql npm object-oriented-programming object prepared-statements promise prototype-based-programming pseudo-class pseudo-element pwa react readme recursion regular-expressions repository responsive-web-design scope selector seo serialization sql-injection sql ssl stream strict-mode string svg template-literals typescript unit-testing uri url utf-8 value-vs-reference variable viewport vue webassembly webgl webrtc websockets xhtml xml yarn

MDN

MDN Web Docs, formerly known as Mozilla Developer Network, is the official Mozilla website for development documentation of web standards and Mozilla projects.

Module

Modules are independent, self-contained pieces of code that can be incorporated into other pieces of code. Modules improve maintainability and reusability of the code.

MongoDB

MongoDB is a NoSQL database model that stores data in flexible, JSON-like documents, meaning fields can vary from document to document and data structure can be changed over time

Mutable value

Mutable value is a type of variable that can be changed once created. Objects are mutable as their state can be modified after they are created. Primitive values are not mutable as we perform reassignment once we change them.

MVC

MVC stands for Model-View-Controller and is a software design pattern, emphasizing separation of concerns (logic and display). The Model part of the MVC pattern refers to the data and business logic, the View handles the layout and display, while the Controller routes commands to the model and view parts.

Node.js

Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js can execute JavaScript code outside of the browser and can be used to develop web backends or standalone applications.

NoSQL

NoSQL databases provide a mechanism to create, update, retrieve and calculate data that is stored in models that are non-tabular.

Npm

Npm is a package manager for the JavaScript programming language and the default package manager for Node.js. It consists of a command-line client and the npm registry, an online database of packages.

Object-oriented programming

Object-oriented programming (OOP) is a programming paradigm based on the concept of objects, which may contain both data and procedures which can be use to operate on them. JavaScript supports Object-oriented programming both via prototypes and classes.

Object

Objects are data structures that contain data and instructions for working with the data. Objects consist of key-value pairs, where the keys are alphanumeric identifiers and the values can either be primitives or objects. JavaScript functions are also objects.

Prepared statements

In databases management systems, prepared statements are templates that can be used to execute queries with the provided values substituting the template's parameters. Prepared statements offer many benefits, such as reusability, maintainability and higher security.

Promise

The Promise object represents the eventual completion (or failure) of an asynchronous operation, and its resulting value. A Promise can be in one of these states: pending(initial state, neither fulfilled nor rejected), fulfilled(operation completed successfully), rejected(operation failed).

Prototype-based programming

Prototype-based programming is a style of object-oriented programming, where inheritance is based on object delegation, reusing objects that serve as prototypes. Prototype-based programming allows the creation of objects before defining their classes.

Pseudo-class

In CSS, a pseudo-class is used to define a special state of an element and can be used as a selector in combination with an id, element or class selector.

Pseudo-element

In CSS, a pseudo-element is used to style specific parts of an element and can be used as a selector in combination with an id, element or class selector.

PWA

Progressive Web App (known as PWA) is a term used to describe web applications that load like regular websites but can offer the user functionality such as working offline, push notifications, and device hardware access that were traditionally available only to native mobile applications.

React

React is a frontend framework, that allows developers to create dynamic, component-based user interfaces. React separates view and state, utilizing a virtual DOM to update the user interface.

Recursion

Recursion is the repeated application of a process. In JavaScript, recursion involves functions that call themselves repeatedly until they reach a base condition. The base condition breaks out of the recursion loop because otherwise the function would call itself indefinitely. Recursion is very useful when working with nested data, especially when the nesting depth is dynamically defined or unkown.

Regular expressions

Regular expressions (known as regex or regexp) are patterns used to match character combinations in strings. JavaScript provides a regular expression implementation through the RegExp object.

Repository

In a version control system, a repository (or repo for short) is a data structure that stores metadata for a set of files (i.e. a project).

Responsive web design

Responsive web design is a web development concept aiming to provide optimal behavior and performance of websites on all web-enabled devices. Responsive web design is usually coupled with a mobile-first approach.

Scope

Each function has its own scope, and any variable declared within that function is only accessible from that function and any nested functions.

Selector

A CSS selector is a pattern that is used to select and/or style one or more elements in a document, based on certain rules. The order in which CSS selectors apply styles to elements is based on the rules of CSS specificity.

SEO

SEO stands for Search Engine Optimization and refers to the process of improving a website's search rankings and visibility.

Serialization

Serialization is the process of converting an object or data structure into a format suitable for transfer over a network and/or storage. A common type of serialization in JavaScript is the conversion of an object into a JSON string.

SQL injection

SQL injection is a code injection technique, used to attack data-driven applications. SQL injections get their name from the SQL language and mainly target data stored in relational databases.

SQL

SQL stands for Structured Query Language and is a language used to create, update, retrieve and calculate data in table-based databases. SQL databases use a relational database model and are particularly useful in handlind structured data with relations between different entities.

SSL

Secure Sockets Layer, commonly known as SSL or TLS, is a set of protocols and standards for transferring private data across the Internet. SSL uses a cryptographic system that uses two keys to encrypt data.

Stream

A stream is a sequence of data made available over time, often due to network transmission or storage access times.

Strict mode

JavaScript's strict mode is a JavaScript feature that allows developers to use a more restrictive variant of JavaScript and it can be enabled by adding 'use strict'; at the very top of their code. Strict mode elimiated some silent errors, might improve performance and changes the behavior of eval and arguments among other things.

String

Strings are one of the primitive data types in JavaScript. They are sequences of characters and are used to represent text.

SVG

SVG stands for Scalable Vector Graphics and is a 2D vector image format based on an XML syntax. SVG images can scale infinitely and can utilize clipping, masking, filters, animations etc.

Template literals

Template literals are strings that allow embedded expressions. They support multi-line strings, expression interpolation and nesting.

TypeScript

TypeScript is a superset of JavaScript, adding optional static typing to the language. TypeScript compiles to plain JavaScript.

Unit testing

Unit testing is a type of software testing, used to test individual units/components of a software. The purpose of unit tests are to validate that each individual unit/component performs as designed.

URI

URI stands for Uniform Resource Identifier and is a text string referring to a resource. A common type of URI is a URL, which is used for the identification of resources on the Web.

URL

URL stands for Uniform Resource Locator and is a text string specifying where a resource can be found on the Internet. In the HTTP protocol, URLs are the same as web addresses and hyperlinks.

UTF-8

UTF-8 stands for UCS Transformation Format 8 and is a commonly used character encoding. UTF-8 is backwards compatible with ASCII and can represent any standard Unicode character.

Value vs reference

When passing a variable by value, a copy of the variable is made, meaning that any changes made to the contents of the variable will not be reflected in the original variable. When passing a variable by reference, the memory address of the actual variable is passed to the function or variable, meaning that modifying the variable's contents will be reflected in the original variable. In JavaScript primitive data types are passed by value while objects are passed by reference.

Variable

A variable is a storage location, associated with an identifier and containing a value. The value of a variable can be referred using the identifier and can be altered during execution.

Viewport

A viewport is a polygonal (usually rectangular) area in computer graphics that is currently being viewed. In web development and design, it refers to the visible part of the document that is being viewed by the user in the browser window.

Vue

Vue.js is a progressive frontend framework for building user interfaces. Vue.js separates view and state, utilizing a virtual DOM to update the user interface.

WebAssembly

WebAssembly (WA) is a web standard that defines an assembly-like text format and corresponding binary format for executalbe code in web pages. WebAssembly is meant to complement JavaScript and improve its performance to match native code performance.

WebGL

WebGL stands for Web Graphics Library and is a JavaScript API that can be used for drawing interactive 2D and 3D graphics. WebGL is based on OpenGL and can be invoked within HTML <canvas> elements, which provide a rendering surface.

WebRTC

WebRTC stands for Web Real-Time Communication and is an API that can be used for video-chat, voice-calling and P2P-file-sharing web apps.

WebSockets

WebSockets is a protocol that allows for a persistent client-server TCP connection. The WebSocket protocol uses lower overheads, facilitating real-time data transfer between client and server.

XHTML

XHTML stands for EXtensible HyperText Markup Language and is a language used to structure web pages. XHTML is a reformulation of the HTML document structure as an application of XML.

XML

XML stands for eXtensible Markup Language and is a generic markup language specified by the W3C. XML documents are plaintext documents structured with user-defined tags, surrounded by <> and optionally extended with attributes.

Yarn

Yarn is a package manager made by Facebook. It can be used as an alternative to the npm package manager and is compatible with the public NPM registry.

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index f30551c68..093437826 100644 --- a/docs/index.html +++ b/docs/index.html @@ -612,4 +612,4 @@ managers; // [100, 200], (a, b, c) => (a != null ? a : 'a') + (b != null ? b : 'b') + (c != null ? c : 'c') ); // [111, 222, '3bc'] - \ No newline at end of file + \ No newline at end of file diff --git a/docs/math.html b/docs/math.html index da5d2d201..edb086d33 100644 --- a/docs/math.html +++ b/docs/math.html @@ -270,4 +270,4 @@ own individual rating by supplying it as the third argument. Math.round(Math.max(Math.min(num, Number.MAX_SAFE_INTEGER), Number.MIN_SAFE_INTEGER)); 
toSafeInteger('3.2'); // 3
 toSafeInteger(Infinity); // 9007199254740991
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/node.html b/docs/node.html index 0ac511de5..6075611c5 100644 --- a/docs/node.html +++ b/docs/node.html @@ -148,4 +148,4 @@ console.log< (c ^ (crypto.randomBytes(1)[0] & (15 >> (c / 4)))).toString(16) ); 
UUIDGeneratorNode(); // '79c7c136-60ee-40a2-beb2-856f1feabefc'
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/object.html b/docs/object.html index 1afa8e390..d5fa46d48 100644 --- a/docs/object.html +++ b/docs/object.html @@ -365,4 +365,4 @@ Foo.prototypereturn acc; }, {}); 
unflattenObject({ 'a.b.c': 1, d: 1 }); // { a: { b: { c: 1 } }, d: 1 }
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/string.html b/docs/string.html index a6dd3277a..fd7ca049d 100644 --- a/docs/string.html +++ b/docs/string.html @@ -275,4 +275,4 @@
intermediate

words

Converts a given string into an array of words.

Use String.split() with a supplied pattern (defaults to non-alpha as a regexp) to convert to an array of strings. Use Array.filter() to remove any empty strings. Omit the second argument to use the default regexp.

const words = (str, pattern = /[^a-zA-Z-]+/) => str.split(pattern).filter(Boolean);
 
words('I love javaScript!!'); // ["I", "love", "javaScript"]
 words('python, javaScript & coffee'); // ["python", "javaScript", "coffee"]
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/type.html b/docs/type.html index 9beb91aa6..e7228d0b2 100644 --- a/docs/type.html +++ b/docs/type.html @@ -169,4 +169,4 @@ 
isValidJSON('{"name":"Adam","age":20}'); // true
 isValidJSON('{"name":"Adam",age:"20"}'); // false
 isValidJSON(null); // true
-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/utility.html b/docs/utility.html index 4468b05fa..899e31e99 100644 --- a/docs/utility.html +++ b/docs/utility.html @@ -266,4 +266,4 @@ Logs: { yesNo('yes'); // true yesNo('No'); // false yesNo('Foo', true); // true - \ No newline at end of file + \ No newline at end of file diff --git a/scripts/web.js b/scripts/web.js index ca1267695..67bac1f57 100644 --- a/scripts/web.js +++ b/scripts/web.js @@ -56,6 +56,7 @@ sass.render( // Set variables for paths const snippetsPath = './snippets', archivedSnippetsPath = './snippets_archive', + glossarySnippetsPath = './glossary', staticPartsPath = './static-parts', docsPath = './docs'; // Set variables for script @@ -97,6 +98,9 @@ let snippets = {}, archivedStartPart = '', archivedEndPart = '', archivedOutput = '', + glossaryStartPart = '', + glossaryEndPart = '', + glossaryOutput = '', indexStaticFile = '', pagesOutput = [], tagDbData = {}; @@ -105,6 +109,7 @@ console.time('Webber'); // Synchronously read all snippets and sort them as necessary (case-insensitive) snippets = util.readSnippets(snippetsPath); archivedSnippets = util.readSnippets(archivedSnippetsPath); +glossarySnippets = util.readSnippets(glossarySnippetsPath); // Load static parts for all pages try { @@ -122,6 +127,12 @@ try { 'utf8' ); archivedEndPart = fs.readFileSync(path.join(staticPartsPath, 'archived-page-end.html'), 'utf8'); + + glossaryStartPart = fs.readFileSync( + path.join(staticPartsPath, 'glossary-page-start.html'), + 'utf8' + ); + glossaryEndPart = fs.readFileSync(path.join(staticPartsPath, 'glossary-page-end.html'), 'utf8'); } catch (err) { // Handle errors (hopefully not!) console.log(`${chalk.red('ERROR!')} During static part loading: ${err}`); @@ -435,6 +446,65 @@ try { console.log(`${chalk.red('ERROR!')} During archive.html generation: ${err}`); process.exit(1); } + +// Create the output for the glossary.html file +try { + // Add the static part + glossaryOutput += `${glossaryStartPart + '\n'}`; + + // Filter README.md from folder + const excludeFiles = ['README.md']; + + const filteredGlossarySnippets = Object.keys(glossarySnippets) + .filter(key => !excludeFiles.includes(key)) + .reduce((obj, key) => { + obj[key] = glossarySnippets[key]; + return obj; + }, {}); + + // Generate glossary snippets from md files + for (let snippet of Object.entries(filteredGlossarySnippets)) + glossaryOutput += + '
' + + md + .render(`\n${filteredGlossarySnippets[snippet[0]]}`) + .replace( + /

/g, + '

' + ) + + '
'; + + glossaryOutput += `${glossaryEndPart}`; + + // Generate and minify 'glossary.html' file + const minifiedGlossaryOutput = minify(glossaryOutput, { + collapseBooleanAttributes: true, + collapseWhitespace: true, + decodeEntities: false, + minifyCSS: true, + minifyJS: true, + keepClosingSlash: true, + processConditionalComments: true, + removeAttributeQuotes: false, + removeComments: true, + removeEmptyAttributes: false, + removeOptionalTags: false, + removeScriptTypeAttributes: false, + removeStyleLinkTypeAttributes: false, + trimCustomFragments: true + }); + + fs.writeFileSync(path.join(docsPath, 'glossary.html'), minifiedGlossaryOutput); + console.log(`${chalk.green('SUCCESS!')} glossary.html file generated!`); +} catch (err) { + console.log(`${chalk.red('ERROR!')} During glossary.html generation: ${err}`); + process.exit(1); +} + // Copy about.html try { fs.copyFileSync(path.join(staticPartsPath, 'about.html'), path.join(docsPath, 'about.html')); diff --git a/static-parts/archived-page-end.html b/static-parts/archived-page-end.html index f1b211093..ee6ad478b 100644 --- a/static-parts/archived-page-end.html +++ b/static-parts/archived-page-end.html @@ -5,7 +5,7 @@ license.
Logos made by Angelos Chalaris and ribbon made by Tim Holman are licensed under the MIT license.
Sponsored by DigitalOcean

+ width="20px" height="20px">DigitalOcean.


About    Contributing    Archive    Glossary

diff --git a/static-parts/contributing.html b/static-parts/contributing.html index 0bacda03e..a3b47913b 100644 --- a/static-parts/contributing.html +++ b/static-parts/contributing.html @@ -66,7 +66,7 @@ license.
Logos made by Angelos Chalaris and ribbon made by Tim Holman are licensed under the MIT license.
Sponsored by DigitalOcean

+ width="20px" height="20px">DigitalOcean.


About    Contributing    Archive    Glossary

diff --git a/static-parts/glossary-page-end.html b/static-parts/glossary-page-end.html new file mode 100644 index 000000000..ee6ad478b --- /dev/null +++ b/static-parts/glossary-page-end.html @@ -0,0 +1,18 @@ + + + + + + + \ No newline at end of file diff --git a/static-parts/glossary-page-start.html b/static-parts/glossary-page-start.html new file mode 100644 index 000000000..c4f792a2c --- /dev/null +++ b/static-parts/glossary-page-start.html @@ -0,0 +1,114 @@ + + + + + + + + Glossary - 30 seconds of code + + + + + + + + + + + + + + +
+

logo 30 seconds of code + Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less. +

+
+
+
+

+

Glossary

+

Developers use a lot of terminology daily. Every once in a while, you might find a term you do not know. We know how frustrating that can get, so we provide you with a handy glossary of frequently used web development terms.


diff --git a/static-parts/page-end.html b/static-parts/page-end.html index f7baaaae2..a3e5d1750 100644 --- a/static-parts/page-end.html +++ b/static-parts/page-end.html @@ -2,7 +2,7 @@