Skip to content

Instantly share code, notes, and snippets.

@loicpw

loicpw/index.html

Created January 20, 2019 23:55
Show Gist options
  • Save loicpw/3c6a08ad3280e19863b0342e4b945b7e to your computer and use it in GitHub Desktop.
Save loicpw/3c6a08ad3280e19863b0342e4b945b7e to your computer and use it in GitHub Desktop.
Download ZIP
Responsive Web Design Projects - Build a Technical Documentation Page
Raw
index.html
<script src="https://cdn.freecodecamp.org/testable-projects-fcc/v1/bundle.js"></script>
<!--
Hello Camper!
For now, the test suite only works in Chrome! Please read the README below in the JS Editor before beginning. Feel free to delete this message once you have read it. Good luck and Happy Coding!
- The freeCodeCamp Team
-->
<head>
<title>Responsive Web Design Projects - Build a Technical Documentation Page</title>
</head>
<body>
<nav id="navbar">
<header>
<h1>JS Documentation</h1>
</header>
<ol id="nav-list">
<a href="#Introduction" class="nav-link"><li>Introduction</li></a>
<a href="#What_you_should_already_know" class="nav-link"><li>What you should already know</li></a>
<a href="#JavaScript_and_Java" class="nav-link"><li>JavaScript and Java</li></a>
<a href="#Hello_world" class="nav-link"><li>Hello world</li></a>
<a href="#Variables" class="nav-link"><li>Variables</li></a>
<a href="#Declaring_variables" class="nav-link"><li>Declaring variables</li></a>
<a href="#Variable_scope" class="nav-link"><li>Variable scope</li></a>
<a href="#Global_variables" class="nav-link"><li>Global variables</li></a>
<a href="#Constants" class="nav-link"><li>Constants</li></a>
<a href="#Data_types" class="nav-link"><li>Data types</li></a>
<a href="#if...else_statement" class="nav-link"><li>if...else statement</li></a>
<a href="#while_statement" class="nav-link"><li>while statement</li></a>
<a href="#Function_declarations" class="nav-link"><li>Function declarations</li></a>
<a href="#Reference" class="nav-link"><li>Reference</li></a>
</ol>
</nav>
<main id="main-doc">
<section id="Introduction" class="main-section">
<header>
<h2>Introduction</h2>
</header>
<article>
<p>
JavaScript is a cross-platform, object-oriented scripting language. It is a small and lightweight language. Inside a host environment (for example, a web browser), JavaScript can be connected to the objects of its environment to provide programmatic control over them.
</p>
<p>
JavaScript contains a standard library of objects, such as Array, Date, and Math, and a core set of language elements such as operators, control structures, and statements. Core JavaScript can be extended for a variety of purposes by supplementing it with additional objects; for example:
<ol>
<li>Client-side JavaScript extends the core language by supplying objects to control a browser and its Document Object Model (DOM). For example, client-side extensions allow an application to place elements on an HTML form and respond to user events such as mouse clicks, form input, and page navigation.</li>
<li>Server-side JavaScript extends the core language by supplying objects relevant to running JavaScript on a server. For example, server-side extensions allow an application to communicate with a database, provide continuity of information from one invocation to another of the application, or perform file manipulations on a server.</li>
</ol>
</p>
</article>
</section>
<section id="What_you_should_already_know" class="main-section">
<header>
<h2>What you should already know</h2>
</header>
<article>
<p>This guide assumes you have the following basic background:</p>
<p>
<ol>
<li>A general understanding of the Internet and the World Wide Web (WWW).</li>
<li>Good working knowledge of HyperText Markup Language (HTML).</li>
<li>Some programming experience. If you are new to programming, try one of the tutorials linked on the main page about JavaScript.</li>
</ol>
</p>
</article>
</section>
<section id="JavaScript_and_Java" class="main-section">
<header>
<h2>JavaScript and Java</h2>
</header>
<article>
<p>JavaScript and Java are similar in some ways but fundamentally different in some others. The JavaScript language resembles Java but does not have Java's static typing and strong type checking. JavaScript follows most Java expression syntax, naming conventions and basic control-flow constructs which was the reason why it was renamed from LiveScript to JavaScript.</p>
<p>In contrast to Java's compile-time system of classes built by declarations, JavaScript supports a runtime system based on a small number of data types representing numeric, Boolean, and string values. JavaScript has a prototype-based object model instead of the more common class-based object model. The prototype-based model provides dynamic inheritance; that is, what is inherited can vary for individual objects. JavaScript also supports functions without any special declarative requirements. Functions can be properties of objects, executing as loosely typed methods.</p>
<p>JavaScript is a very free-form language compared to Java. You do not have to declare all variables, classes, and methods. You do not have to be concerned with whether methods are public, private, or protected, and you do not have to implement interfaces. Variables, parameters, and function return types are not explicitly typed.</p>
</article>
</section>
<section id="Hello_world" class="main-section">
<header>
<h2>Hello world</h2>
</header>
<article>
<p>To get started with writing JavaScript, open the Scratchpad and write your first "Hello world" JavaScript code:</p>
<code>function greetMe(yourName) {
alert("Hello " + yourName);
}
greetMe("World");</code>
<p>Select the code in the pad and hit Ctrl+R to watch it unfold in your browser!</p>
</article>
</section>
<section id="Variables" class="main-section">
<header>
<h2>Variables</h2>
</header>
<article>
<p>You use variables as symbolic names for values in your application. The names of variables, called identifiers, conform to certain rules.</p>
<p>A JavaScript identifier must start with a letter, underscore (_), or dollar sign ($); subsequent characters can also be digits (0-9). Because JavaScript is case sensitive, letters include the characters "A" through "Z" (uppercase) and the characters "a" through "z" (lowercase).</p>
<p>You can use ISO 8859-1 or Unicode letters such as å and ü in identifiers. You can also use the Unicode escape sequences as characters in identifiers. Some examples of legal names are Number_hits, temp99, and _name.</p>
</article>
</section>
<section id="Declaring_variables" class="main-section">
<header>
<h2>Declaring variables</h2>
</header>
<article>
<p>You can declare a variable in three ways:</p>
<p>With the keyword var. For example,</p>
<code>var x = 42.</code>
<p>This syntax can be used to declare both local and global variables.</p>
<p>By simply assigning it a value. For example,
<code>x = 42.</code>
</p>
<p>This always declares a global variable. It generates a strict JavaScript warning. You shouldn't use this variant.</p>
<p>With the keyword let. For example,
<code>let y = 13.</code>
</p>
<p>This syntax can be used to declare a block scope local variable. See Variable scope below.</p>
</article>
</section>
<section id="Variable_scope" class="main-section">
<header>
<h2>Variable scope</h2>
</header>
<article>
<p>When you declare a variable outside of any function, it is called a global variable, because it is available to any other code in the current document. When you declare a variable within a function, it is called a local variable, because it is available only within that function.</p>
<p>JavaScript before ECMAScript 2015 does not have block statement scope; rather, a variable declared within a block is local to the function (or global scope) that the block resides within. For example the following code will log 5, because the scope of x is the function (or global context) within which x is declared, not the block, which in this case is an if statement.</p>
<p>
<code>if (true) {
var x = 5;
}
console.log(x); // 5</code>
</p>
<p>This behavior changes, when using the let declaration introduced in ECMAScript 2015.</p>
<p>
<code>if (true) {
let y = 5;
}
console.log(y);
// ReferenceError: y is not defined</code>
</p>
</article>
</section>
<section id="Global_variables" class="main-section">
<header>
<h2>Global variables</h2>
</header>
<article>
<p>Global variables are in fact properties of the global object. In web pages the global object is window, so you can set and access global variables using the window.variable syntax.</p>
<p>Consequently, you can access global variables declared in one window or frame from another window or frame by specifying the window or frame name. For example, if a variable called phoneNumber is declared in a document, you can refer to this variable from an iframe as parent.phoneNumber.</p>
</article>
</section>
<section id="Constants" class="main-section">
<header>
<h2>Constants</h2>
</header>
<article>
<p>You can create a read-only, named constant with the const keyword. The syntax of a constant identifier is the same as for a variable identifier: it must start with a letter, underscore or dollar sign and can contain alphabetic, numeric, or underscore characters.</p>
<code>const PI = 3.14;</code>
</p>
<p>A constant cannot change value through assignment or be re-declared while the script is running. It has to be initialized to a value.</p>
<p>The scope rules for constants are the same as those for let block scope variables. If the const keyword is omitted, the identifier is assumed to represent a variable.</p>
<p>You cannot declare a constant with the same name as a function or variable in the same scope. For example:
<code>// THIS WILL CAUSE AN ERROR
function f() {};
const f = 5;
// THIS WILL CAUSE AN ERROR ALSO
function f() {
const g = 5;
var g;
//statements
}</code>
</p>
<p>However, object attributes are not protected, so the following statement is executed without problems.
<code>const MY_OBJECT = {"key": "value"};
MY_OBJECT.key = "otherValue";</code>
</p>
</article>
</section>
<section id="Data_types" class="main-section">
<header>
<h2>Data types</h2>
</header>
<article>
<p>The latest ECMAScript standard defines seven data types:
<ol>
<li>Six data types that are primitives:</li>
<ol>
<li>Boolean. true and false.</li>
<li>null. A special keyword denoting a null value. Because JavaScript is case-sensitive, null is not the same as Null, NULL, or any other variant.</li>
<li>undefined. A top-level property whose value is undefined.</li>
<li>Number. 42 or 3.14159.</li>
<li>String. "Howdy"</li>
<li>Symbol (new in ECMAScript 2015). A data type whose instances are unique and immutable.</li>
</ol>
<li>and Object</li>
</ol>
</p>
<p>Although these data types are a relatively small amount, they enable you to perform useful functions with your applications. Objects and functions are the other fundamental elements in the language. You can think of objects as named containers for values, and functions as procedures that your application can perform.</p>
</article>
</section>
<section id="if...else_statement" class="main-section">
<header>
<h2>if...else statement</h2>
</header>
<article>
<p>Use the if statement to execute a statement if a logical condition is true. Use the optional else clause to execute a statement if the condition is false. An if statement looks as follows:<code>if (condition) {
statement_1;
} else {
statement_2;
}</code>
</p>
<p>condition can be any expression that evaluates to true or false. See Boolean for an explanation of what evaluates to true and false. If condition evaluates to true, statement_1 is executed; otherwise, statement_2 is executed. statement_1 and statement_2 can be any statement, including further nested if statements.</p>
<p>You may also compound the statements using else if to have multiple conditions tested in sequence, as follows:<code>if (condition_1) {
statement_1;
} else if (condition_2) {
statement_2;
} else if (condition_n) {
statement_n;
} else {
statement_last;
}</code>
</p>
<p>In the case of multiple conditions only the first logical condition which evaluates to true will be executed. To execute multiple statements, group them within a block statement ({ ... }) . In general, it's good practice to always use block statements, especially when nesting if statements:<code>if (condition) {
statement_1_runs_if_condition_is_true;
statement_2_runs_if_condition_is_true;
} else {
statement_3_runs_if_condition_is_false;
statement_4_runs_if_condition_is_false;
}</code>
</p>
<p>It is advisable to not use simple assignments in a conditional expression, because the assignment can be confused with equality when glancing over the code. For example, do not use the following code:<code>if (x = y) {
/* statements here */
}</code>
</p>
<p>If you need to use an assignment in a conditional expression, a common practice is to put additional parentheses around the assignment. For example:<code>if ((x = y)) {
/* statements here */
}</code>
</p>
</article>
</section>
<section id="while_statement" class="main-section">
<header>
<h2>while statement</h2>
</header>
<article>
<p>A while statement executes its statements as long as a specified condition evaluates to true. A while statement looks as follows:<code>while (condition)
statement</code>
</p>
<p>If the condition becomes false, statement within the loop stops executing and control passes to the statement following the loop.</p>
<p>The condition test occurs before statement in the loop is executed. If the condition returns true, statement is executed and the condition is tested again. If the condition returns false, execution stops and control is passed to the statement following while.</p>
<p>To execute multiple statements, use a block statement ({ ... }) to group those statements.</p>
<p>Example:</p>
<p>The following while loop iterates as long as n is less than three:<code>var n = 0;
var x = 0;
while (n &lt 3) {
n++;
x += n;
}</code>
</p>
<p>With each iteration, the loop increments n and adds that value to x. Therefore, x and n take on the following values:
<ol>
<li>After the first pass: n = 1 and x = 1</li>
<li>After the second pass: n = 2 and x = 3</li>
<li>After the third pass: n = 3 and x = 6</li>
</ol>
</p>
<p>After completing the third pass, the condition n &lt 3 is no longer true, so the loop terminates.</p>
</article>
</section>
<section id="Function_declarations" class="main-section">
<header>
<h2>Function declarations</h2>
</header>
<article>
<p>A function definition (also called a function declaration, or function statement) consists of the function keyword, followed by:
<ol>
<li>The name of the function.</li>
<li>A list of arguments to the function, enclosed in parentheses and separated by commas.</li>
<li>The JavaScript statements that define the function, enclosed in curly brackets, { }.</li>
</ol>
</p>
<p>For example, the following code defines a simple function named square:<code>function square(number) {
return number * number;
}</code>
</p>
<p>The function square takes one argument, called number. The function consists of one statement that says to return the argument of the function (that is, number) multiplied by itself. The return statement specifies the value returned by the function.<code>return number * number;</code>
</p>
<p>Primitive parameters (such as a number) are passed to functions by value; the value is passed to the function, but if the function changes the value of the parameter, this change is not reflected globally or in the calling function.</p>
</article>
</section>
<section id="Reference" class="main-section">
<header>
<h2>Reference</h2>
</header>
<article>
<p>All the documentation in this page is taken from <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide">MDN</a></p>
</article>
</section>
</main>
<footer></footer>
</body>
Raw
responsive-web-design-projects-build-a-technical-documentation-page.markdown

Responsive Web Design Projects - Build a Technical Documentation Page

Responsive Web Design Projects - Build a Technical Documentation Page - freecodecamp

A Pen by Loïc Peron on CodePen.

License.

Raw
script.babel
// !! IMPORTANT README:
// You may add additional external JS and CSS as needed to complete the project, however the current external resource MUST remain in place for the tests to work. BABEL must also be left in place.
/***********
INSTRUCTIONS:
- Select the project you would
like to complete from the dropdown
menu.
- Click the "RUN TESTS" button to
run the tests against the blank
pen.
- Click the "TESTS" button to see
the individual test cases.
(should all be failing at first)
- Start coding! As you fulfill each
test case, you will see them go
from red to green.
- As you start to build out your
project, when tests are failing,
you should get helpful errors
along the way!
************/
// PLEASE NOTE: Adding global style rules using the * selector, or by adding rules to body {..} or html {..}, or to all elements within body or html, i.e. h1 {..}, has the potential to pollute the test suite's CSS. Try adding: * { color: red }, for a quick example!
// Once you have read the above messages, you can delete all comments.
Raw
style.css
body {
font-family: 'Open Sans',Arial,sans-serif;
line-height: 1.5;
color: hsl(0, 0%, 20%);
}
h1, h2 {
color: #000000;
}
#navbar {
position: fixed;
top: -1px;
left: 0px;
width: 30vw;
height: 100%;
border-style: solid;
border-width: 1px;
}
#navbar header {
text-align: center;
}
#nav-list {
list-style: none;
padding-left: 0px;
overflow-y:auto;
}
#nav-list li {
border-style: solid;
border-width: 1px;
border-color: hsl(0, 0%, 90%);
text-align: center;
}
#nav-list li:hover {
animation-name: nav-list-item-color;
animation-duration: 90ms;
animation-fill-mode: forwards;
}
@keyframes nav-list-item-color {
100% {
background-color: hsl(200, 70%, 90%);
border-width: 2px;
border-color: hsl(200, 70%, 30%);
}
}
.nav-link {
text-decoration: inherit;
color: inherit;
}
main {
margin-left: 31vw;
margin-right: 1vw;
}
main ol {
list-style: disc;
}
main li {
margin-top: 5px;
}
.main-section {
text-align: justify;
}
code{
background-color: hsl(50, 90%, 96%);
display:block;
line-height: 2;
white-space: pre;
word-wrap: normal;
border-radius:5px;
padding: 5px;
padding-left: 10px;
}
@media(max-width: 810px) {
#navbar {
position: relative;
width: 100%;
border-style: none;
height: auto;
}
#nav-list {
max-height: 35vh;
width: 100%;
}
main {
margin: auto;
margin-left: 1vw;
margin-right: 1vw;
}
}
@media(max-width: 500px) {
body {
font-size: 90%;
}
}
@media(max-width: 400px) {
body {
font-size: 80%;
}
}
@iSalah-YT
Copy link

thank u so much it was really helpful so it only need in the head tag so thank u

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment