https://github.com/ralitsavoronevska/fcc-technical-documentation-page
FCC: Build a Technical Documentation Page
https://github.com/ralitsavoronevska/fcc-technical-documentation-page
bootstrap5 bootstrap5-icons codepen-io css3 css3-flexbox css3-transitions freecodecamp gh-pages html5 javascript lighthouse-audits pagespeed-insights purgecss sass scss-files tech-doc-page technical-documentation-page vanilla-js w3c-validator
Last synced: about 2 months ago
JSON representation
FCC: Build a Technical Documentation Page
- Host: GitHub
- URL: https://github.com/ralitsavoronevska/fcc-technical-documentation-page
- Owner: ralitsavoronevska
- License: mit
- Created: 2025-05-19T15:14:05.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-12-14T10:03:40.000Z (6 months ago)
- Last Synced: 2026-03-18T03:48:40.348Z (3 months ago)
- Topics: bootstrap5, bootstrap5-icons, codepen-io, css3, css3-flexbox, css3-transitions, freecodecamp, gh-pages, html5, javascript, lighthouse-audits, pagespeed-insights, purgecss, sass, scss-files, tech-doc-page, technical-documentation-page, vanilla-js, w3c-validator
- Language: SCSS
- Homepage: https://ralitsavoronevska.github.io/fcc-technical-documentation-page/
- Size: 18.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 FCC: Build a Technical Documentation Page
📝 [CodePen](https://codepen.io/ralitsavoronevska/pen/zgvWKQ/)
🔗 [Live GitHub Preview](https://ralitsavoronevska.github.io/fcc-technical-documentation-page/)
🎯 FreeCodeCamp Requirements
Responsive Web Design Projects - Build a Technical Documentation Page
Objective: Build an app that is functionally similar to https://codepen.io/freeCodeCamp/full/NdrKKL. Do not copy this demo project.
Fulfill the below user stories and get all of the tests to pass. Give it your own personal style.
> You can use HTML, JavaScript, and CSS to complete this project. Plain CSS is recommended because that is what the lessons have covered so far and you should get some practice with plain CSS. You can use Bootstrap or SASS if you choose. Additional technologies (just for example jQuery, React, Angular, or Vue) are not recommended for this project, and using them is at your own risk. Other projects will give you a chance to work with different technology stacks like React. We will accept and try to fix all issue reports that use the suggested technology stack for this project. Happy coding!
✅ User Story #1: I can see a main element with a corresponding id="main-doc", which contains the page's main content (technical documentation).
5️⃣ User Story #2: Within the #main-doc element, I can see several section elements, each with a class of main-section. There should be a minimum of 5.
ℹ️ User Story #3: The first element within each .main-section should be a header element which contains text that describes the topic of that section.
🆔 User Story #4: Each section element with the class of main-section should also have an id that corresponds with the text of each header contained within it. Any spaces should be replaced with underscores (e.g. The section that contains the header "JavaScript and Java" should have a corresponding id="JavaScript_and_Java").
🔟 User Story #5: The .main-section elements should contain at least 10 p elements total (not each).
5️⃣ User Story #6: The .main-section elements should contain at least 5 code elements total (not each).
5️⃣ User Story #7: The .main-section elements should contain at least 5 li items total (not each).
📝 User Story #8: I can see a nav element with a corresponding id="navbar".
🧭 User Story #9: The navbar element should contain one header element which contains text that describes the topic of the technical documentation.
🔗 User Story #10: Additionally, the navbar should contain link (a) elements with the class of nav-link. There should be one for every element with the class main-section.
📌 User Story #11: The header element in the navbar must come before any link (a) elements in the navbar.
🔃 User Story #12: Each element with the class of nav-link should contain text that corresponds to the header text within each section (e.g. if you have a "Hello world" section/header, your navbar should have an element which contains the text "Hello world").
🏃♂️ User Story #13: When I click on a navbar element, the page should navigate to the corresponding section of the main-doc element (e.g. If I click on a nav-link element that contains the text "Hello world", the page navigates to a section element that has that id and contains the corresponding header).
💻 User Story #14: On regular sized devices (laptops, desktops), the element with id="navbar" should be shown on the left side of the screen and should always be visible to the user.
📱 User Story #15: My Technical Documentation page should use at least one media query.
You can build your project by forking this [CodePen pen](https://codepen.io/freeCodeCamp/pen/MJjpwO/).
Or you can use this CDN link to run the tests in any environment you like:
https://cdn.freecodecamp.org/testable-projects-fcc/v1/bundle.js.
Once you're done, submit the URL to your working project with all its tests passing.
Remember to use the [Read-Search-Ask](https://www.freecodecamp.org/forum/t/how-to-get-help-when-you-are-stuck/19514/) method if you get stuck.
📸 Screenshots
## 🖥️ Desktop preview:
📱 Tablet preview:
📱 Mobile Preview:
# 🏅 W3C HTML Validator
# 🏅 W3C CSS Validator
# 🌈 Chrome LightHouse Audit
Desktop:
Mobile:
# ⚡ PageSpeed Insights Results
Desktop:
Mobile:
# 🛠️ Built with:
  
 
🔨 SCSS Files [Fully Responsive, Mobile First Approach, Transitions & Flex Layout]
⛏️ [Google Font: Varela Round](https://fonts.google.com/specimen/Varela+Round/)
🪓 [Bootstrap v5.3](https://getbootstrap.com/docs/5.3/getting-started/introduction/)
🪛 [Bootstrap v5.3 Icons](https://icons.getbootstrap.com/)
# ✨ Features:
✅ Modern JavaScript Technical Documentation Page
✅ Fixed sidebar navigation with smooth scroll
✅ toggle-theme button with hover effect
✅ copy-to-clipboard implementation
✅ Elegant scroll-to-top button
✅ manifest.json
# 🧰 Online resources and tools:
 
🖼️ [Photopea [Online Photo Editor]](https://www.photopea.com/)
🪄 [svg minification](https://www.svgviewer.dev/)
🌃 [favicon converter](https://favicon.io/favicon-converter/)
# 🌐 Browser Support:
(Last updated and tested: 14/12/2025)
🌟 Chrome 143.0.7499.110 (64-bit)
🦊 Firefox 146.0 (64-bit)
🏴☠️ Opera 125.0.5729.21 (64-bit)
🪟 Edge 143.0.3650.80 (64-bit)
# 🧪 Online Validators:
✔️ [W3C HTML Validator](https://validator.w3.org/)
✔️ [W3C CSS Validator](https://jigsaw.w3.org/css-validator/)
💡 [LightHouse Audit](https://developers.google.com/web/tools/lighthouse/)
⚡ [PageSpeed Insights Audit](https://pagespeed.web.dev/)
⭐ [WebPageTest](https://www.webpagetest.org/)
# 🌟 Inspiration & Credits:
💜 https://trigger.dev
📝 https://codepen.io
:octocat: https://github.com
:octocat: https://github.com/twbs/bootstrap/issues/36432
💘 https://web.dev/patterns/theming/theme-switch/#toggle-theme-js
✅ https://hollandsweb.com/javascript-tutorial-1-copy-the-text-to-clipboard-using-javascript
🙌 https://stackoverflow.com/questions/65862446/bootstrap-5-update-tooltip-title-with-javascript/65863062#65863062
⭐ https://getbootstrap.com/docs/5.3/getting-started/introduction
🎞️ [Fadein and Fadeout Back To Top Button on Page Scroll using CSS and Vanilla JS [YouTube]](https://youtu.be/Pd71ZZeIhaI/)
🎞️ [11 New CSS Features Every Browser Supports in 2025 [YouTube]](https://www.youtube.com/watch?v=55uUK-iJeNM)
---
🙌 Thank you for checking out my project! More is coming 🔜.
Stay tuned 🚀 and please don't forget to give the project a star! ⭐
Made with lots of 💗, ☕, and a sprinkle of ✨ by Ralitsa Voronevska!