FCC: Technical Documentation Page Project

fcc-technical-documentation-page-project.markdown

FCC: Technical Documentation Page Project

A Pen by Erik Vasquez on CodePen.

License.

index.html

<nav id="navbar">
  <div class="main-body"></div>
  <header>JS Documentation</header>
  <h2><a href="#Introduction" class="nav-link">Introduction</a><br>
  <a href="#JavaScript" class="nav-link">JavaScript</a><br>
  <a href="#Variables" class="nav-link">Variables</a><br>
  <a href="#Scope" class="nav-link">Scope</a><br>
    <a href="#Functions" class="nav-link">Functions</Functions></a><br></h2>
</nav>
<main id="main-doc">
<section class="main-section" id="Introduction">
<header>Introduction</header>
  <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:</p>
  <ul>
    <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>
  </ul>
  </section>
<section class="main-section"id="JavaScript">
  <header>JavaScript</header>
  <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>
<header>JavaScript</header>
  <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>
  </section>
<section class="main-section" id="Variables">
  <header>Variables</header>
  <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,</p>
  <code>x = 42.</code>
  <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,</p>
  <code>let y = 13.</code>
<header>Variables</header>
  <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>
  <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,</p>
  <code>x = 42.</code>
  <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,</p>
  <code>let y = 13.</code>
  </section>
<section class="main-section" id="Scope">
<header>Scope</header>
  <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>
  <code>if (true) {
  var x = 5;
}
console.log(x);  // 5</code>
  <p>This behavior changes, when using the let declaration introduced in ECMAScript 2015.</p>
  <code>if (true) {
  let y = 5;
}
console.log(y);  
// ReferenceError: y is not defined</code>
  <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>
  </section>
<section class="main-section" id="Functions">
<header>Functions</header>
  <p>A function definition (also called a function declaration, or function statement) consists of the function keyword, followed by:</p>
  <ul>
    <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, { }.
    <p>For example, the following code defines a simple function named square:</p>
      <code>function square(number) {
  return number * number;
}</code>
      <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.</p>
      <code>return number * number;</code>
    </li>
  </ul>
  </section>
</main>
</div>

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. 

style.css

html,body{
  min-width:290px;
  color: #4d4e53;
  background-color: ffffff;
  font-family: Lucida Grande, sans-serif;
  line-height: 1.5;
}

#navbar{
  position:fixed;
  color:#2F4F4F;
  min-width:290px;
  top: 0px;
  left: 0px;
  width: 300px;
  height: 100%;
  border-right: solid;
  border-color: rgba(0,22,22,0.4)
}

header{
  color: black;
  font-size: 30px;
  margin: 10px;
  text-align: center;
  font-size: 2em;
  font-weight: thin;
}

#main-doc header{
 text-align: left;
 margin: 0px;
}

#navbar ul{
  height: 88%;
  overflow-y: auto;
  overflow-x: hidden;
}

#navbar li{
  color: #4d4e53;
  border: 1px solid;
  border-bottom-width: 0px;
  padding: 8px;
  padding-left: 45px;
  list-style: none;
  position: relative;
  left: -50px;
  width: 100%;
}

#navbar a{
color: #4d4e53;
  text-decoration: underline;
  cursor: pointer;
 }

#main-doc{
  position: absolute;
  margin-left: 310px;
  padding: 20px;
  margin-bottom: 110px;
}

section article{
  color: #4d4e53;
  margin: 15px;
  font-size: 0.96em;
}

section li{
  margin: 15px 0px 0px 20px;
}
code{
  display: block;
  color: #ffffff;
  text-align: center;
  white-space: pre;
  position: relative;
  word-break: normal;
  word-wrap: normal;
  line-height: 2;
  background-color: #000000;
  padding: 15px;
  margin: 10px;
  border-radius: 5px;
}

@media only screen and (max-width:815px) {
  /* For mobile phones: */
  #navbar ul{
    border: 1px solid;
    height: 207px;
  }
  #navbar{
   background color: #white;
   position: absolute;
   top: 0;
   padding: 0;
   margin: 0;
   width: 100%
   max-height: 275px;
   border: none;
   z-index: 1;  
   border-bottom: 2px solid; 
  } 
  
  #main-doc{
    position: relative;
    margin-left: 0px;
    margin-top: 270px;
  }
  
  #main-doc section{
/*    padding-top: 240px;    */
  }
  
  @media only screen and (max width: 400px;) {
    #main-doc{
      margin-left: -10px;
    }
    code{
      margin-left: -20px;
      width: 100%;
      padding: 15px;
      padding-left: 10px;
      padding-right: 45px;
      min-width: 233px;
    }
  }
}

styles

<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.1.2/css/bootstrap.min.css" rel="stylesheet" />