https://github.com/ginabeki/technical-documentation

Technical Documentation Following FreecodeCamp Guideline
https://github.com/ginabeki/technical-documentation

Last synced: 19 days ago
JSON representation

Technical Documentation Following FreecodeCamp Guideline

• Host: GitHub
• URL: https://github.com/ginabeki/technical-documentation
• Owner: ginabeki
• License: mit
• Created: 2022-02-13T10:38:24.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-30T12:39:57.000Z (almost 3 years ago)
• Last Synced: 2023-03-05T06:24:22.162Z (almost 2 years ago)
• Language: HTML
• Homepage: https://technical-documentation-g.netlify.app/
• Size: 69.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [Technical-Documentation](https://github.com/ginabeki/Technical-Documentation)

Required to build a product landing page following freecodecamp guidelines [here](https://www.freecodecamp.org/learn/responsive-web-design/responsive-web-design-projects/build-a-technical-documentation-page).

## Prerequisites

This repo contains all the important files for the project.

- The `index.html` file contains the elements of the page.

- The `style.css` file contains the styling code for the page.

- The `sass` folder contain several files that helps enables the use of different things like variables, nested rules, inline imports and more. Also, helps   to keep things organised.

- The `main.scss` file handles all the imports into CSS.

## This repo requires the following to run

- `nodejs v16.13.0`

 npm(Normally comes with node js)

## How to run the project

Clone the repo by running

- `https://github.com/ginabeki/Technical-Documentation.git` on the terminal for https.

- `[email protected]:ginabeki/Technical-Documentation.git` on the terminal for ssh.

- Run `npm install` to install all the project dependencies.

- Run `npm run compile:sass` to use sass on the project.

- You can now open `index.html` on your preferred browser using either live server or clicking on it and opening in the browser.

## Contributing

To contribute to this project, clone this repo locally and commit your code on a separate branch.