Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iturres/js-tecnical_documentation_page
Functional Doc page for javaScript Documentation
https://github.com/iturres/js-tecnical_documentation_page
Last synced: 1 day ago
JSON representation
Functional Doc page for javaScript Documentation
- Host: GitHub
- URL: https://github.com/iturres/js-tecnical_documentation_page
- Owner: ITurres
- Created: 2022-07-10T01:15:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-10T01:35:37.000Z (over 2 years ago)
- Last Synced: 2024-12-06T07:53:53.698Z (28 days ago)
- Language: HTML
- Homepage: https://iturres.github.io/JS-Tecnical_Documentation_Page/
- Size: 5.86 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JS-Tecnical_Documentation_Page
Functional Doc page for javaScript DocumentationCoded on VScode for FCC.
User Stories:
1) You can see a main element with a corresponding id="main-doc", which contains the page's main content(technical documentation).
2) Within the #main-doc element, you can see several section elements, each with a class of main-section. There should be a minimum of five.
3) The first element within each .main-section should be a header element, which contains text that describes the topic of that section.
4) Each section element with the class of main-section have an id that corresponds with the text of each header contained within it. Any spaces is replace with underscores (e.g. The section that contains the header "JavaScript and Java" have a corresponding id="JavaScript_and_Java").
5) The .main-section elements contain thirteen p elements total (not each).
6) The .main-section elements contain five code elements total (not each).
7) The .main-section elements contain five li items total (not each).
8) You can see a nav element with a corresponding id="navbar".
9) The navbar element contains one header element which contains text that describes the topic of the technical documentation.
10) Additionally, the navbar contains link (a) elements with the class of nav-link. one for every element with the class main-section.
11) The header element in the #navbar comes before any link (a) elements in the navbar.
12) Each element with the class of nav-link contains text that corresponds to the header text within each section.
13) When you click on a navbar element, the page navigates to the corresponding section of the #main-doc element (e.g. If you click on a .nav-link element that contains the text "Hello world", the page navigates to a section element with that id, and contains the corresponding header).
14) On regular sized devices (laptops, desktops), the element with id="navbar" shows on the left side of the screen and should always be visible to the user.